Site Administrators can customise the contents of the main menu bar via the user interface in order to add, edit or remove navigation menu items. The visibility of navigation items can also be restricted to members of an Audience.
(The video above was taken from the Dashboards and basic theming course in Totara Academy).
Configuring the main menu
Go to Quick-access menu > Navigation > Main menu to display the configuration page listing existing navigation menu items and their hierarchies.
The capability totara/core:editmainmenu controls access to the configuration pages where allowed users can:
- Select the corresponding edit icon ( ) to update navigation item settings
- Re-order page items using the up/down arrows
- Show/hide page items from the navigation bar (eye icon)
- Delete custom navigation items
The default headings and options displayed in the main menu are shown in the table below. The menu options available will depend on the products you have installed, as well as the settings you have enabled/disabled. For example, if Totara Engage workspaces have been disabled then Collaborate, Your workspaces and Find workspace will be removed from the menu.
|Learn, Engage and Perform||Learn only||Engage only||Perform only||Learn and Engage||Learn and Perform||Engage and Perform|
Remember that the table above only displays the default menu options. On your site the menu will display differently for your users depending on user permissions, as well as how you have customised the menu.
Creating menu items
Create custom navigation menu items by clicking the Add new menu item button.
|Type||Choose whether the menu item will be a Parent (container) for menu items or its own URL (link).||-|
|Parent item||Select either Top to create a top-level navigation menu item, or another menu item to create a second-or third-level navigation item.||-|
|Item title||This is the string that appears as the navigation item name.||If the multi-language filter is enabled, these can be multi-lingual strings.|
|Controls whether users can see a navigation item.|
Selecting Use custom access rules will enable the custom Access tab.
|Open link in new window||If checked, the link will open in a separate window.||-|
To add a custom access rule to a navigation item:
- Select Quick-access menu > Navigation > Main menu.
- Select the Edit icon ( ) against the corresponding menu item
- Select Use custom access rules under Visibility and Save changes.
- Select the Access tab to define the access rule.
- Select whether all or any of the Restrict access criteria need to be met to view the navigation item.
- Fill in the criteria for the role, audience, and/or preset rule.
- Select Save changes.
An administrator cannot delete the default 'hard-coded' menu options but, from a user’s point of view, hiding them has the same effect.
Resetting the main menu
To revert to the standard Totara Main Menu, Site Administrators can use the Reset menu to default configuration button. If any custom menu items have been previously added, a prompt will be displayed to specify whether to permanently delete these items or move them to the Unused section so they are hidden but available in the menu for later reuse or reference.
When defining custom navigation item URLs, you can include the following placeholders:
- ##userid## - Current user ID
- ##username## - Current username
- ##useremail## - Current user email
- ##courseid## - Current course ID
They will be dynamically substituted for the appropriate value at the time when the page is viewed.
The Totara Academy has a whole course dedicated to using Dashboards and basic theming in Totara. Here you can learn more on how to customise your site's appearance, see best practice, and give it a go yourself.