ZnetDK 4 Mobile module: Home Menu (z4m_homemenu)

The z4m_homemenu displays a dynamic 2 levels menu on the home view according to the rights granted to the logged in user.

LICENCE

This module is published under the version 3 of GPL General Public Licence.

FEATURES

This module contains the view z4m_homemenu to declare within the menu.php of the application.
If user authentication is disabled, all the menu items are displayed by the z4m_homemenu view.
This view can also be included within an existing home view.

REQUIREMENTS

• ZnetDK 4 Mobile version 2.0 or higher,
• PHP version 7.4 or higher.

INSTALLATION

1. Add a new subdirectory named z4m_homemenu within the ./engine/modules/ subdirectory of your ZnetDK 4 Mobile starter App,
2. Copy module's code in the new ./engine/modules/z4m_homemenu/ subdirectory, or from your IDE, pull the code from this module's GitHub repository,
3. Edit the App's menu.php located in the ./applications/default/app/ subfolder and add a new menu item definition for the view z4m_homemenu as first menu item. For example:

\MenuManager::addMenuItem(NULL, 'z4m_homemenu', 'Home', 'fa-home');

CUSTOMIZATION

The home menu can be customized by settings the following PHP constants in the config.php script of the application:

• MOD_Z4M_HOMEMENU_MAX_PANELS_PER_ROW: the maximum number of panels displayed per row (value 4 by default).
• MOD_Z4M_HOMEMENU_PANEL_ICON_WIDTH: the width of the menu item icons displayed in each menu panel (value '100px').
• MOD_Z4M_HOMEMENU_EXCLUDED_VIEW: name of the view to exclude from the home menu (value 'z4m_homemenu' by default).
• MOD_Z4M_HOMEMENU_COLOR_SCHEME: color scheme of the home menu. The color CSS classes applied by default are: 'w3-theme-d2' for 'banner', 'w3-theme-light' for 'content', 'w3-theme-action' for 'btn_action' and 'w3-hover-theme' for 'btn_hover'.

CHANGE LOG

See CHANGELOG.md file.

CONTRIBUTING

Your contribution to the ZnetDK 4 Mobile project is welcome. Please refer to the CONTRIBUTING.md file.