Skip to content

Commit 00a8874

Browse files
committed
Yi Cai's comments
1 parent dbbd73c commit 00a8874

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ dynamicPlugins:
2929
* 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>`
3030
* An HTML image, such as: `icon: https://img.icons8.com/ios-glyphs/20/FFFFFF/shop.png`
3131
<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.
3333
<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.
3434
<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.
3535

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+
+
3838
[source,yaml]
3939
----
4040
dynamicPlugins:
@@ -46,14 +46,16 @@ dynamicPlugins:
4646
priority: 10 # <3>
4747
default._<menu_group_parent_item_name>_: # <4>
4848
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>
5152
----
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.
5455
<3> `priority`: (Optional) Enter the order of this menu item within its menu level.
5556
<4> `default._<menu_group_parent_item_name>_`: Enter the menu group parent item name to configure static main menu items.
5657
<5> `icon`: Enter the menu group icon. Required for parent menu items.
5758
<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

Comments
 (0)