Module Modern Template EN

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search

ModernTemplate — Modernized Interface for Dolibarr

Version: 1.9.2 · License: GPL v3 · Author: KSI 30

DEMO/ https://dolibarr.ksi30.fr


Overview

ModernTemplate provides a full-screen shell for Dolibarr: compact toolbar, reorderable tile column, left sidebar with submenus, and smart search.

The module integrates via hooks (menuTop, menuLeft, toprightmenu, login, global) and a trigger (USER_LOGIN) for optional post-login redirection.


Highlights

  • Centralized navigation using tiles + synchronized submenus
  • Drag & Drop tiles, with global or per-user saving
  • Multi-object search (exact refs + third parties/contacts + fallback to global search)
  • Quick customization: colors, start page, help URL, tab visibility
  • Built-in ModernTemplate pages

Translations

Available in:

ar_SA, de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, pt_PT, ru_RU, tr_TR, zh_CN


Requirements

  • Dolibarr 22.x (recommended)
  • PHP 7.4+
  • Write access to database and /custom/moderntemplate directory

Installation

  1. Copy the moderntemplate/ folder to htdocs/custom/
  2. In Dolibarr: go to Setup → Modules/Applications and enable ModernTemplate
  3. Visit /custom/moderntemplate/admin/setup.php and click Install/Repair if prompted
  4. Tip: a “ModernTemplate” menu will appear at the top and opens the shell at /custom/moderntemplate/shell.php

Configuration

Tools Tab
  • Start page (MODERNTEMPLATE_START_PAGE): default URL to open (e.g. /custom/moderntemplate/home.php?fs=1)
  • Post-login redirection (MODERNTEMPLATE_AUTO_REDIRECT, MODERNTEMPLATE_REDIRECT_SCOPE): always or only when no urlfrom is set
  • Auto full screen (MODERNTEMPLATE_AUTO_FULLSCREEN) and permission mask (MODERNTEMPLATE_HIDE_FS_OVERLAY)
  • Help and bugreport URLs (MODERNTEMPLATE_HELP_URL, MODERNTEMPLATE_BUGREPORT_URL)
  • External tiles (MODERNTEMPLATE_INCLUDE_EXT_TILES): include non-Dolibarr links
Colors Tab
  • Banner: MODERNTEMPLATE_COLOR_BANNER_BG, …FG
  • Primary/accent UI: MODERNTEMPLATE_COLOR_UI_PRIMARY, …ACCENT
  • Tiles: MODERNTEMPLATE_COLOR_TILE_BG, …TEXT
Tiles Tab
  • Reorder via drag & drop, add sections/links, auto-suggestions from menus
  • SQL backup/restore (tiles-backup.sql), import/export
  • Per-user mode (MODERNTEMPLATE_TILES_PERUSER), ACLs for tiles and sections
ACL Tab
  • User-based matrix: tile and section visibility, saved in the database
Languages Tab
  • i18n keys scanned from menus; add/edit manually
  • Force language option (MODERNTEMPLATE_FORCE_LANG)
Access Tab
  • Control access to configuration tabs by profile (admins vs users)

Usage

  • Click the ModernTemplate menu to open the shell
  • Open a tile: content displays in the center; the Submenus button toggles the contextual left panel
  • Drag tiles to reorder them (changes are persistent)
  • Use the search (magnifying glass icon): type an exact reference (fac-xxx, cmd-xxx, prop-xxx, prod-xxx, etc.) or a third party/contact name or number
  • Click Help to open the configured help URL
  • Click Exit Shell (/custom/moderntemplate/shell/exit.php) to restore the native Dolibarr menus

Administration & Maintenance

  • Tables: llx_moderntemplate_pref, llx_moderntemplate_tiles (automatic migration from modernui_*)
  • Endpoints:
    • router/tiles_order.php (tile order)
    • router/left_order.php
    • router/search.php
  • Key files:
    • shell.php, shell/layout.php, js/shell.js
    • core/triggers/interface_99_moderntemplate_redirect.class.php
    • core/modules/modModernTemplate.class.php
  • Backup: via Tiles tab → export SQL; restore from .sql file

Security & Permissions

  • Main permission: Use ModernTemplate (rights_class = moderntemplate, permission use)
  • Fully respects Dolibarr rights for tile visibility and link access
  • CSRF protection on all write routes

Uninstallation

  1. Disable the module in Setup → Modules/Applications
  2. (Optional) Use the Uninstall tab to purge ModernTemplate constants/data
  3. Delete the /custom/moderntemplate folder ⚠️ If post-login redirection was enabled, make sure to disable it before removing the module

FAQ

After login, I'm redirected to the shell — is this normal?

Yes, if MODERNTEMPLATE_AUTO_REDIRECT is enabled. Disable it in the Tools tab or adjust MODERNTEMPLATE_REDIRECT_SCOPE.

I'm missing Dolibarr submenus

In the shell view, native menus are hidden by design. Use the left panel or click Exit Shell to return to standard navigation.

Are third-party modules supported?

Tiles/links are based on active module menus and URLs. For custom URLs, add manual tiles.