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

[UI] Create an extendable global header plugin with extendable default components

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • 1.5.0
    • None
    • UI
    • None
    • [UI] Create extendable global header plugin with default components
    • M
    • False
    • Hide

      None

      Show
      None
    • False
    • RHDHPLAN-713Ability to add a global header
    • In Progress
    • RHDHPLAN-713 - Ability to add a global header
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      = Configurable global header plugin

      This release introduces a new global header plugin, providing a configurable and extendable header in RHDH. Customers can use the default header with key RHDH components or fully customize it by enabling, disabling, or extending its functionality through the dynamic plugin system.

      Key features & enhancements
      Global header as a dynamic plugin

      Enabled by default with a provided wrapper
      Can be disabled by turning off the dynamic plugin
      Supports customization by adding, reordering, or removing components
      Extendable default header components

      Search input field
      "Create" button linking to Software Templates
      Support for internal/external links (e.g., support and notification icons)
      Profile and Create dropdown menus
      Plugin extension capabilities

      Other plugins can add custom components or links
      Extend the "CreateDropdown" or ProfileDropdown menus

      New mount points in the dynamic plugin system allow greater flexibility in positioning, styling, and extending the header, providing a fully customizable experience in RHDH.
      For more information about global header, see <doc links>
      Show
      = Configurable global header plugin This release introduces a new global header plugin, providing a configurable and extendable header in RHDH. Customers can use the default header with key RHDH components or fully customize it by enabling, disabling, or extending its functionality through the dynamic plugin system. Key features & enhancements Global header as a dynamic plugin Enabled by default with a provided wrapper Can be disabled by turning off the dynamic plugin Supports customization by adding, reordering, or removing components Extendable default header components Search input field "Create" button linking to Software Templates Support for internal/external links (e.g., support and notification icons) Profile and Create dropdown menus Plugin extension capabilities Other plugins can add custom components or links Extend the "CreateDropdown" or ProfileDropdown menus New mount points in the dynamic plugin system allow greater flexibility in positioning, styling, and extending the header, providing a fully customizable experience in RHDH. For more information about global header, see <doc links>
    • Feature
    • Done

      EPIC Goal

      Customers should be able to use a global header with some default RHDH components. The header might be enabled by default in the future (when it's ready), but customers should be able to configure or disable (hide) it.

      To archive this in 1.5, we're planning to use the dynamic plugin feature (instead of the new backstage frontend extensions). This will allow us and customers to customize and extend the header by:

      1. Disable the header plugin to hide the header completely
      2. Add (or reorder or remove) additional components in the header by overriding the plugin default.
      3. Other plugins can extend the header by providing components or create actions that are then rendered automatically in the header.

      Background/Feature Origin

      Why is this important?

      Customers asked for global headers because it matches their other tools.

      It also matches other Red Hat products.

      User Scenarios

      Users want to navigate between different pages with a global header bar.

      Dependencies (internal and external)

      1. RHIDP-5126 Dynamic plugin support for global headers (the dynamic plugin might solve this more generically)

      Acceptance Criteria

      1. Global header is delivered as plugin and is shown by default (wrapper is provided)
      2. It can be disabled by disabling the dynamic plugin
      3. Plugins can extend the header by providing a component for the header on the top level
      4. The plugin provides useful defaults to render
        1. The customized customer icon
        2. A search input field
        3. A 'Create' dropdown button
        4. Links (internal or external), this could be used for the "Support" icon and "Notification" icon in the designs
        5. An external applications button
        6. A Profile dropdown
      5. Plugins can extend the header by providing one or more components or links for one of these items:
        1. for the 'Create' component
        2. for the 'Application' component - STRETCH for 1.5
        3. for the 'Profile' component
      6. For automated and manual tests: We should provide additional test plugins as part of the new workspace for that plugin.
        1. An alternative header plugin
        2. A demo plugin that adds additional test components
          1. to the root navigation (icon or link or both)
          2. to the 'Create' dropdown
          3. to the 'Applications' dropdown
          4. to the 'Profile' dropdown

      Release Enablement/Demo - Provide necessary release enablement details
      and documents

      DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Upstream documentation merged: <link to meaningful PR or GitHub
      Issue>

      DEV - Downstream build attached to advisory: <link to errata>

      QE - Test plans in Playwright: <link or reference to playwright>

      QE - Automated tests merged: <link or reference to automated tests>

      DOC - Downstream documentation merged: <link to meaningful PR>

              yicai@redhat.com Yi Cai
              cjerolim Christoph Jerolimov
              RHDH Frontend Plugins & UI
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: