Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-6184

Improve sidebar configuration to hide default elements

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Normal Normal
    • 1.6.0
    • None
    • UI
    • None
    • Improve sidebar configuration to hide default elements
    • S
    • False
    • Hide

      None

      Show
      None
    • False
    • RHDHPLAN-633Make main navigation (sidebar) more configurable
    • Done
    • RHDHPLAN-633 - Make main navigation (sidebar) more configurable
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      = New sidebar item visibility configuration

      {product} now supports a clean and flexible way to hide sidebar items using a new enabled key in the sidebar menu configuration. If set to false, the specified sidebar item will no longer appear in the UI, while maintaining full backward compatibility with existing configurations.

      Example configuration:
      [source,yaml]
      ----
      dynamicPlugins:
        frontend:
          default.main-menu-items:
            menuItems:
              default.home:
                title: Home
                icon: home
                enabled: false
              default.list:
                title: References
                icon: bookmarks
              default.my-group:
                parent: default.list
              default.learning-path:
                parent: default.list
                title: ''
              default.homepage:
                title: HomePage 123
                icon: home
                enabled: false
              default.create:
                title: Create
                icon: add
                parent: default.homepage
      ----

      You can now also toggle visibility of core sidebar elements like the logo, search, settings, and administration as shown:

      [source,yaml]
      ----
      app:
        sidebar:
          search: false # hides sidebar search
          logo: false # hides sidebar logo
          settings: false # hides settings item
          administration: false # hides administration item
      ----
      Show
      = New sidebar item visibility configuration {product} now supports a clean and flexible way to hide sidebar items using a new enabled key in the sidebar menu configuration. If set to false, the specified sidebar item will no longer appear in the UI, while maintaining full backward compatibility with existing configurations. Example configuration: [source,yaml] ---- dynamicPlugins:   frontend:     default.main-menu-items:       menuItems:         default.home:           title: Home           icon: home           enabled: false         default.list:           title: References           icon: bookmarks         default.my-group:           parent: default.list         default.learning-path:           parent: default.list           title: ''         default.homepage:           title: HomePage 123           icon: home           enabled: false         default.create:           title: Create           icon: add           parent: default.homepage ---- You can now also toggle visibility of core sidebar elements like the logo, search, settings, and administration as shown: [source,yaml] ---- app:   sidebar:     search: false # hides sidebar search     logo: false # hides sidebar logo     settings: false # hides settings item     administration: false # hides administration item ----
    • Enhancement
    • Done

      EPIC Goal

      The goal is an official way how to remove sidebar items from the sidebar instead of setting the title to an empty string. Like enabled: false or disabled: true.

      Background/Feature Origin

      The current customization options of the sidebar allows customers to change titles of sidebar items and add additional sidebar items.

      Currently the sidebar items can only be removed by setting the sidebar item title to an empty string.

      The sidebar logo, search, settings and admin sections can be removed since 1.5 but this part wasn't documented yet.

      Why is this important?

      Clean APIs and documentations are important for our customers and are good to reduce support work by lookup "workarounds" in our code.

      User Scenarios

      1. Admins want to disable the logo, search, some default navigation links, the settings or admin section from the sidebar

      Dependencies (internal and external)

      None

      Acceptance Criteria

      1. Sidebar items can be removed with a nicer way then setting the title to an empty string.
      2. Customers can remove the search via configuration (that's already possible since 1.5), we need to document this!

              divgupta Divyanshi Gupta
              cjerolim Christoph Jerolimov
              RHDH Frontend Plugins & UI
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: