[release-1.6] RHIDP-6569-1 - Document the configurable features of navigation (sidebar) in RHDH (#1153)

Co-authored-by: Judith Magak <[email protected]>
Co-authored-by: Gerry-Forde <[email protected]>

Author: 3 people

modules/customizing-the-appearance/proc-configuring-dynamic-plugin-menuitem.adoc

@@ -18,6 +18,7 @@ dynamicPlugins:
           title: _<plugin_page_title>_ # <4>
           priority: 10 # <5>
           parent: favorites # <6>
+          enabled: true # <7>
 ----
 <1> `_<plugin_name>_`: Enter the plugin name. This name is the same as the `scalprum.name` key in the `package.json` file.
 <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`.
@@ -30,6 +31,7 @@ dynamicPlugins:
 // Update <4> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
 <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.
 <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.
+<7> `enabled`: (Optional) If this field is used to hide the menu item from the sidebar, set the value to `false`. To display the menu item in the sidebar, set the value to `true`.
 
 +
 .Example `menuItems` configuration

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

@@ -19,28 +19,34 @@ dynamicPlugins:
             title: Home
             icon: home
             priority: 100
+            enabled: true
           default.my-group:
             title: My Group
             icon: group
             priority: 90
+            enabled: true
           default.catalog:
             title: Catalog
             icon: category
             to: catalog
             priority: 80
+            enabled: true
           default.apis:
             title: APIs
             icon: extension
             to: api-docs
             priority: 70
+            enabled: true
           default.learning-path:
             title: Learning Paths
             icon: school,
             to: learning-paths
             priority: 60
+            enabled: true
           default.create:
             title: Self-service
             icon: add
             to: create
             priority: 50
+            enabled: true
 ----

modules/customizing-the-appearance/proc-modifying-or-adding-rhdh-custom-menuitem.adoc

@@ -22,6 +22,7 @@ dynamicPlugins:
           title: _<my_menu_title>_ # <8>
           to: _<path_to_the_menu_target_page>_ # <9>
           priority: 100 # <10>
+          enabled: true # <11>
 ----
 <1> `default._<menu_group_parent_item_name>_`: (Optional) Enter the menu group parent item name to configure static main menu items. If no `default._<menu_item_name>_` has a `parent` value set, this field is not needed.
 <2> `icon`: Enter the menu icon. Required for parent menu items.
@@ -34,6 +35,7 @@ dynamicPlugins:
 // Update <8> for release 1.6 as this option (currently a  workaround) would be added as a functionality. RHIDP-6333.
 <9> `to`: (Optional) Enter the path that the menu item navigates to. If it is not set, it defaults to the home page.
 <10> `priority`: (Optional) Enter the order of this menu item within its menu level.
+<11> `enabled`: (Optional) If this field is used to display the menu item in the sidebar, set the value to `true`. To hide the menu item from the sidebar, set the value to `false`.
 
 +
 .Example `mainItems` configuration
@@ -56,11 +58,13 @@ default.main-menu-items:
           title: References # <5>
           icon: school # <6>
           to: /references # <7>
+          enabled: true # <8>
 ----
 <1> `icon`: Specifies if you want to change the icon default menu item for the catalog.
 <2> `title`: Specifies an empty string `" "` to hide the learning path from the default sidebar.
 <3> `default.parentlist`: Introduces the parent menu item.
 <4> `parent`: Nests home menu under the `default.parentlist` parent menu item.
 <5> `title`: Specifies a name for `default.references`
 <6> `icon`: Displays the `school` icon.
-<7> `to`: Redirects `default.references` to the `/references` page.
+<7> `to`: Redirects `default.references` to the `/references` page.
+<8> `enabled`: (Optional) If this field is used to display the menu item in the sidebar, set the value to `true`. To hide the menu item from the sidebar, set the value to `false`.