You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,12 @@ dynamicPlugins:
29
29
* An SVG icon, such as: `icon: <svg width="20px" height="20px" viewBox="0 0 512 512" xmlns="http://www.w3.org/2000/svg" fill="#ffffff">...</svg>`
30
30
* An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`
31
31
<4> `title`: (Optional) Enter the menu item title. Omit it when the title is already specified in the `dynamicRoutes` configuration under `menuItem.text`. To hide the title from the sidebar, set the title as an (`" "`) empty string.
32
-
// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
32
+
// Update <4> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
33
33
<5> `priority`: (Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section.
34
34
<6> `parent`: (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section.
35
35
36
-
. To add a main menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item.
37
-
+
36
+
. To modify a main menu item or add a custom menu item, add a section to the `default.main-menu-items` > `menuItems` section in your `{my-app-config-file}` file. Use the `default.` prefix to identify the key as a main menu item.
37
+
+
38
38
[source,yaml]
39
39
----
40
40
dynamicPlugins:
@@ -46,14 +46,16 @@ dynamicPlugins:
46
46
priority: 10 # <3>
47
47
default._<menu_group_parent_item_name>_: # <4>
48
48
icon: # home | group | category | extension | school | _<your_icon>_ # <5>
49
-
title: _<my_menu_group_title>_ # <6>
50
-
priority: 100 # <7>
49
+
title: _<my_menu_title>_ # <6>
50
+
to: _<path_to_the_target_page>_ # <7>
51
+
priority: 100 # <8>
51
52
----
52
-
<1> `default._<menu_item_name>_`: Enter the menu item name. Add the `default.` prefix to identify a main menu item.
53
-
<2> `parent`: (Optional) Enter the parent menu item for this item.
53
+
<1> `default._<menu_item_name>_`: Enter the menu item name for which you want to override the default value. Add the `default.` prefix to identify a main menu item.
54
+
<2> `parent`: (Optional) Enter the parent menu item for this item. Required if <menu_item_name> is specified as the child of any menu items.
54
55
<3> `priority`: (Optional) Enter the order of this menu item within its menu level.
55
56
<4> `default._<menu_group_parent_item_name>_`: Enter the menu group parent item name to configure static main menu items.
56
57
<5> `icon`: Enter the menu group icon. Required for parent menu items.
57
58
<6> `title`: Enter the menu group title. Required for parent menu items. To hide the title from the sidebar, set the title as an (`" "`) empty string.
58
-
// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
59
-
<7> `priority`: (Optional) Enter the order of the parent menu item in the sidebar.
59
+
// Update <6> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
60
+
<7> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page.
61
+
<8> `priority`: (Optional) Enter the order of the parent menu item in the sidebar.
0 commit comments