Skip to content

Commit 57b48b5

Browse files
committed
Incorporated Jai's comments
1 parent 8563e0d commit 57b48b5

File tree

1 file changed

+22
-30
lines changed

1 file changed

+22
-30
lines changed

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

Lines changed: 22 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ dynamicPlugins:
2424
----
2525
<1> `_<plugin_name>_`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file.
2626
<2> `_<menu_item_name>_`: Enter a unique name in the main sidebar navigation for either a standalone menu item or a parent menu item. If this field specifies a plugin menu item, the name of the menu item must match the name using in the corresponding path in `dynamicRoutes`. For example, if `dynamicRoutes` defines `path: /my-plugin`, then `menu_item_name` must be defined as `my-plugin`.
27-
<3> `icon`: (Optional) Enter the icon name. You can use the following icons:
27+
<3> `icon`: (Optional) Enter the icon name if you do not want to use the default icon. You can use the following icons:
2828
* Default icons, such as `home`, `group`, `category`, `extension`, and `school`
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`
@@ -90,10 +90,10 @@ dynamicPlugins:
9090
<4> `priority`: (Optional) Enter the order of this menu item within its menu level.
9191
<5> `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.
9292
<6> `parent`: (Optional) Enter the parent menu item for this item. Required if <menu_item_name> is specified as the child of any menu items.
93-
<7> `icon`: (Optional) Enter the menu icon.
93+
<7> `icon`: (Optional) Enter the menu icon if you do not want to use the default icon.
9494
<8> `title`: Enter the menu group title. To hide the title from the sidebar, set the title as an (`" "`) empty string.
9595
// Update <8> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
96-
<9> `to`: (Optional) Enter the path that the menu item navigates to. If not set, it defaults to the home page.
96+
<9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page.
9797
<10> `priority`: (Optional) Enter the order of this menu item within its menu level.
9898

9999
+
@@ -104,33 +104,25 @@ dynamicPlugins:
104104
default.main-menu-items:
105105
menuItems:
106106
default.catalog:
107-
icon: school
108-
title: Catalog124
107+
icon: category # <1>
108+
title: My Catalog
109109
priority: 5
110-
default.learning-path:
111-
title: ''
112-
default.list:
113-
title: Home
110+
default.learning-path:
111+
title: '' # <2> to hide the learning path from default sidebar
112+
default.parentlist: # <3>
113+
title: Overview
114114
icon: bookmarks
115-
default.home2:
116-
parent: default.list
117-
title: home2
118-
icon: bookmarks
119-
priority: 105
120-
default.home1:
121-
parent: default.list
122-
title: home1
123-
icon: bookmarks
124-
priority: 205
125-
default.home: # <1>
126-
parent: default.home2 # <2>
127-
default.list2:
128-
title: References # <3>
129-
icon: bookmarks # <4>
130-
to: /create # <5>
115+
default.home:
116+
parent: default.parentlist # <4>
117+
default.references:
118+
title: References # <5>
119+
icon: school # <6>
120+
to: /references # <7>
131121
----
132-
<1> `default.home`: Specifies the main item name.
133-
<2> `parent`: Nests this plugin under the `favorites` parent menu item.
134-
<3> `title`: Specifies the name of `default.list2`
135-
<4> `icon`: Displays the `bookmarks` icon.
136-
<5> `to`: Redirects `default.list2` to the `/create` page.
122+
<1> `icon`: Specify if you want to change the icon default menu item for the catalog.
123+
<2> `title`: Specify an empty string `" "` to hide the learning path from the default sidebar.
124+
<3> `default.parentlist`: Introduces the parent menu item.
125+
<4> `parent`: Nests home menu under the `default.parentlist` parent menu item.
126+
<5> `title`: Specifies a name for `default.references`
127+
<6> `icon`: Displays the `school` icon.
128+
<7> `to`: Redirects `default.references` to the `/references` page.

0 commit comments

Comments
 (0)