The add-on provides support of multiple main menus in Jmix applications. Menus are stored in the database and can be created and edited at runtime using the administration screens.
Main functions:
- allow to change menu structure and menu items properties (caption, shortcut, icon, etc) using the administration screens at runtime.
- allow to use multiple main menus with different structure for different use groups
Use cases:
- administrators need to change the main menu at runtime without development and deployment of a new application version.
- different user groups need main menus with different structure, these menus must be configurable.
Note: the add-on doesn't change user permissions so visibility of menu items depends on the roles and permissions assigned to the user.
Install the add-on using the following coordinates 'io.github.it-syn:jmix-menu-editor-starter:<add-on version>'
according the platform documentation.
The add-on versions:
| Jmix Version | Add-on Version |
|---|---|
| 1.4.x | 0.8.5 |
| 1.5.x | 0.8.6 |
| 2.1.x | 0.9.0 |
Let's consider that we want to change the main menu for the administrators of our application (users with the 'Full access' role).
- Start the application and login as administrator.
- Open the 'Main menus' screen.
- Create a new menu (click the 'Create' button).
- Specify the menu properties: Name - "admin menu", Role code - "Full Access".
- Use the "Reset" action in the right section of the screen to load default menu items from
menu.xml. - Make some changes to the menu structure. For example:
- move or reorder some items using Drag & Drop function;
- change item captions (click the "Edit" button and change the "Caption key" property);
- remove some items;
- Save the changes and close the menu editor.
- Click the "Apply" button to apply the changes.
You will see that the main menu has reloaded and contains the changes made earlier.
Menus can be created and edited in the "Main menus" screen in the Administration menu. Menu attributes (name, description, etc) and items can be changed in the "Menu editor" screen. Items can be reordered using Drag & Drop function.
The Reset action in the "Menu editor" screen restores menu items from the default menu menu.xml.
The menu can be assigned to a user role using the "Role code" attribute. After that it is applied for all users that have this role. If multiple menus are applied via different roles to the user the menu with the highest Priority attribute is used.