@red-hat-developer-hub/backstage-plugin-global-header 1.20.2 → 1.21.0

package/dist/alpha.d.ts

@@ -0,0 +1,1255 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import { ComponentType, ReactNode, ComponentProps } from 'react';
+export { b as GlobalHeaderIconButton, H as HeaderIconButtonProps, a as globalHeaderTranslationRef, g as globalHeaderTranslations } from './types/index.d-CdKdPbQ2.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import Button from '@mui/material/Button';
+
+/**
+ * Data produced by a `GlobalHeaderComponentBlueprint` extension.
+ * Represents a single toolbar-level item in the global header.
+ *
+ * @alpha
+ */
+interface GlobalHeaderComponentData {
+    component: ComponentType<any>;
+    priority?: number;
+    /** MUI `sx`-compatible layout overrides applied by the header wrapper. */
+    layout?: Record<string, unknown>;
+}
+/**
+ * Data produced by a `GlobalHeaderMenuItemBlueprint` extension.
+ * Represents a single menu item inside a header dropdown.
+ *
+ * When `type` is `'component'`, the item is a self-contained component that
+ * controls its own layout and `MenuItem` wrapping (e.g. `SoftwareTemplatesSection`,
+ * `LogoutButton`).
+ *
+ * When `type` is `'data'` (the default), the item is data-driven: it is
+ * grouped by `sectionLabel` and rendered through `MenuSection`
+ * which provides `<MenuItem>` wrapping, `<Link>` navigation, section headers
+ * and dividers.
+ *
+ * @alpha
+ */
+interface GlobalHeaderMenuItemData {
+    target: string;
+    /**
+     * React component used for rendering. Required when `type` is `'component'`.
+     * For `type: 'data'` items, defaults to the built-in `MenuItemLink`.
+     */
+    component?: ComponentType<any>;
+    priority?: number;
+    /**
+     * Controls how the item is rendered.
+     *
+     * - `'data'` (default) -- grouped by `sectionLabel` and rendered through
+     *   `MenuSection` with standard `MenuItem` wrapping.
+     * - `'component'` -- rendered directly; the component controls its own
+     *   layout and `MenuItem` wrapping.
+     */
+    type?: 'component' | 'data';
+    /** Display title for the item. */
+    title?: string;
+    /** Translation key for the title. */
+    titleKey?: string;
+    /** Icon identifier passed to `HeaderIcon`. */
+    icon?: string;
+    /** Secondary title rendered below the main title. */
+    subTitle?: string;
+    /** Translation key for the secondary title. */
+    subTitleKey?: string;
+    /** Navigation URL. External links show a launch indicator. */
+    link?: string;
+    /** Click handler invoked when the item is selected (in addition to closing the menu). */
+    onClick?: () => void;
+    /**
+     * Section label used both as the grouping key and the displayed header.
+     * Items sharing the same string are grouped together and rendered as a
+     * single `MenuSection`. Auto-translated when the value contains
+     * dots (e.g. `'applicationLauncher.sections.documentation'`).
+     */
+    sectionLabel?: string;
+    /** Optional URL rendered as a clickable link in the section header row. */
+    sectionLink?: string;
+    /** Display text for the section header link. */
+    sectionLinkLabel?: string;
+}
+
+/**
+ * Plugin providing the default global header toolbar items and
+ * dropdown menu items.
+ *
+ * @alpha
+ */
+declare const globalHeaderPlugin: _backstage_frontend_plugin_api.OverridableFrontendPlugin<{}, {}, {
+    "gh-component:global-header/app-launcher-dropdown": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "app-launcher-dropdown";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/company-logo": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "company-logo";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/divider": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "divider";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/help-dropdown": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "help-dropdown";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/notification-button": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "notification-button";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/profile-dropdown": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "profile-dropdown";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/search": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "search";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/self-service-button": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "self-service-button";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/spacer": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "spacer";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-component:global-header/starred-dropdown": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-component";
+        name: "starred-dropdown";
+        config: {
+            priority: number | undefined;
+        };
+        configInput: {
+            priority?: number | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+        inputs: {};
+        params: ToolbarComponentParams;
+    }>;
+    "gh-menu-item:global-header/app-launcher-devhub": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "app-launcher-devhub";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+    "gh-menu-item:global-header/app-launcher-rhdh-local": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "app-launcher-rhdh-local";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+    "gh-menu-item:global-header/logout": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "logout";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+    "gh-menu-item:global-header/my-profile": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "my-profile";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+    "gh-menu-item:global-header/settings": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "settings";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+    "gh-menu-item:global-header/support-button": _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+        kind: "gh-menu-item";
+        name: "support-button";
+        config: {
+            priority: number | undefined;
+            title: string | undefined;
+            titleKey: string | undefined;
+            icon: string | undefined;
+            link: string | undefined;
+            sectionLabel: string | undefined;
+            sectionLink: string | undefined;
+            sectionLinkLabel: string | undefined;
+        };
+        configInput: {
+            link?: string | undefined;
+            title?: string | undefined;
+            icon?: string | undefined;
+            titleKey?: string | undefined;
+            priority?: number | undefined;
+            sectionLabel?: string | undefined;
+            sectionLink?: string | undefined;
+            sectionLinkLabel?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+        inputs: {};
+        params: MenuItemParams;
+    }>;
+}>;
+
+/**
+ * Frontend module that provides the global header system.
+ * Registers a wrapper extension with input slots for toolbar components
+ * and dropdown menu items.
+ *
+ * Uses `pluginId: 'app'` because the `wrappers` input on `app/root` is
+ * marked `internal: true`, restricting attachments to extensions from the
+ * `app` plugin.
+ *
+ * @alpha
+ */
+declare const globalHeaderModule: _backstage_frontend_plugin_api.FrontendModule;
+
+/**
+ * Params accepted by {@link GlobalHeaderComponentBlueprint}.
+ *
+ * Supply `component` for full control (tier 2/3), or provide data fields
+ * (`icon`, `title`, `link`/`onClick`) and let the framework render a
+ * consistent `HeaderIconButton` automatically (tier 1).
+ *
+ * @alpha
+ */
+interface ToolbarComponentParams {
+    icon?: string;
+    title?: string;
+    titleKey?: string;
+    tooltip?: string;
+    link?: string;
+    onClick?: () => void;
+    component?: ComponentType<any>;
+    priority?: number;
+    /** MUI `sx`-compatible layout overrides applied by the header wrapper. */
+    layout?: Record<string, unknown>;
+}
+/**
+ * Params accepted by {@link GlobalHeaderMenuItemBlueprint}.
+ *
+ * Supply `component` for full control, or provide data fields
+ * (`title`, `icon`, `link`) and let the framework render a
+ * consistent `MenuItemLink` automatically.
+ *
+ * Items with a `component` but **no** data fields (`title`, `link`, etc.)
+ * are rendered directly by the dropdown — the component controls its own
+ * layout and `MenuItem` wrapping (e.g. `SoftwareTemplatesSection`,
+ * `LogoutButton`).
+ *
+ * Items with data fields (with or without a custom component) are grouped
+ * by `sectionLabel` and rendered inside `MenuSection`.
+ *
+ * @alpha
+ */
+interface MenuItemParams {
+    target: string;
+    title?: string;
+    titleKey?: string;
+    subTitle?: string;
+    subTitleKey?: string;
+    icon?: string;
+    link?: string;
+    onClick?: () => void;
+    component?: ComponentType<any>;
+    priority?: number;
+    /** Section label used as the grouping key and the displayed section header. */
+    sectionLabel?: string;
+    /** URL rendered as a clickable link in the section header row. */
+    sectionLink?: string;
+    /** Display text for the section header link. */
+    sectionLinkLabel?: string;
+}
+/**
+ * Blueprint for contributing toolbar-level items to the global header.
+ *
+ * Supports three tiers:
+ *
+ * 1. **Data-driven** -- provide `icon`, `title`, `link` (or `onClick`) and the
+ *    framework renders a consistent `HeaderIconButton` automatically.
+ * 2. **Building blocks** -- provide a `component` that uses the exported
+ *    `GlobalHeaderIconButton` / `GlobalHeaderDropdown` for consistent styling.
+ * 3. **Fully custom** -- provide any arbitrary React component.
+ *
+ * The `priority` can be overridden by deployers via `app-config.yaml`:
+ *
+ * ```yaml
+ * app:
+ *   extensions:
+ *     - gh-component:global-header/search:
+ *         config:
+ *           priority: 200
+ * ```
+ *
+ * @alpha
+ */
+declare const GlobalHeaderComponentBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
+    kind: "gh-component";
+    params: ToolbarComponentParams;
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    dataRefs: {
+        componentData: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    };
+}>;
+/**
+ * Blueprint for contributing menu items to a header dropdown.
+ *
+ * The `target` field routes the item to the correct dropdown (e.g. `'create'`,
+ * `'profile'`, `'help'`, `'app-launcher'`, or any custom target).
+ *
+ * **Custom components** (only `component`, no data fields) are rendered
+ * directly by the dropdown — they control their own layout and wrapping.
+ *
+ * **Data-driven items** (at least `title`/`link`/`icon`) are grouped by
+ * `sectionLabel` and rendered through `MenuSection` for consistent styling.
+ *
+ * Deployers can override any data field via `app-config.yaml`:
+ *
+ * ```yaml
+ * app:
+ *   extensions:
+ *     - gh-menu-item:global-header/app-launcher-devhub:
+ *         config:
+ *           title: "Custom Title"
+ *           sectionLabel: mySection
+ * ```
+ *
+ * @alpha
+ */
+declare const GlobalHeaderMenuItemBlueprint: _backstage_frontend_plugin_api.ExtensionBlueprint<{
+    kind: "gh-menu-item";
+    params: MenuItemParams;
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    dataRefs: {
+        menuItemData: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    };
+}>;
+
+/**
+ * Extension data ref carrying toolbar component data from a plugin to the
+ * global header wrapper.
+ *
+ * @alpha
+ */
+declare const globalHeaderComponentDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+/**
+ * Extension data ref carrying menu item data from a plugin to the
+ * global header wrapper.
+ *
+ * @alpha
+ */
+declare const globalHeaderMenuItemDataRef: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+
+/**
+ * Returns all toolbar-level header components, sorted by priority (highest first).
+ *
+ * @alpha
+ */
+declare function useGlobalHeaderComponents(): GlobalHeaderComponentData[];
+/**
+ * Returns menu items for a specific dropdown target, sorted by priority (highest first).
+ *
+ * @alpha
+ */
+declare function useGlobalHeaderMenuItems(target: string): GlobalHeaderMenuItemData[];
+
+/**
+ * Props for {@link GlobalHeaderMenuItem}.
+ *
+ * @alpha
+ */
+interface GlobalHeaderMenuItemProps {
+    /** Navigation URL. When absent the item renders as a plain action button. */
+    to?: string;
+    /** Display title. */
+    title?: string;
+    /** Translation key for the title. */
+    titleKey?: string;
+    /** Secondary text rendered below the title. */
+    subTitle?: string;
+    /** Translation key for the secondary text. */
+    subTitleKey?: string;
+    /** Icon identifier passed to `HeaderIcon`. */
+    icon?: string;
+    /** Tooltip shown on hover. */
+    tooltip?: string;
+    /** Called when the item is clicked (typically the dropdown's `handleClose`). */
+    onClick?: () => void;
+}
+/**
+ * A complete, self-contained menu item for use inside header dropdowns.
+ *
+ * Renders a MUI `MenuItem` with optional `Link` navigation and the
+ * standard `MenuItemLink` content (icon, title, subtitle, external
+ * link indicator). Consumers only need this one component — no manual
+ * `MenuItem` or `Link` wrapping required.
+ *
+ * @example
+ * ```tsx
+ * const MyHelpItem = ({ handleClose }) => (
+ *   <GlobalHeaderMenuItem
+ *     to="https://docs.example.com"
+ *     title="Documentation"
+ *     icon="menu_book"
+ *     onClick={handleClose}
+ *   />
+ * );
+ * ```
+ *
+ * @alpha
+ */
+declare const GlobalHeaderMenuItem: ({ to, title, titleKey, subTitle, subTitleKey, icon, tooltip, onClick, }: GlobalHeaderMenuItemProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * Props for {@link GlobalHeaderDropdown}.
+ *
+ * @alpha
+ */
+interface GlobalHeaderDropdownProps {
+    /** Extension target name that items are collected from (e.g. `'help'`, `'create'`). */
+    target: string;
+    /** Content rendered inside the trigger button. */
+    buttonContent: ReactNode;
+    /** MUI Button props forwarded to the trigger. */
+    buttonProps?: ComponentProps<typeof Button>;
+    /** Render an `IconButton` instead of a regular `Button`. */
+    isIconButton?: boolean;
+    /** Tooltip shown on hover of the trigger button. */
+    tooltip?: string;
+    /** Rendered when no menu items are contributed (or all render empty when `trackValidity` is on). */
+    emptyState?: ReactNode;
+    /**
+     * When `true`, the dropdown checks the rendered MenuList for visible
+     * `[role="menuitem"]` elements after each render. If none are found,
+     * the `emptyState` is shown instead.
+     */
+    trackValidity?: boolean;
+}
+/**
+ * High-level dropdown building block for the global header.
+ *
+ * Collects menu items from a named extension `target`, groups them
+ * by section, sorts by priority, and renders them inside a
+ * `HeaderDropdownComponent`.
+ *
+ * @alpha
+ */
+declare const GlobalHeaderDropdown: ({ target, buttonContent, buttonProps, isIconButton, tooltip, emptyState, trackValidity, }: GlobalHeaderDropdownProps) => react_jsx_runtime.JSX.Element | null;
+
+/** @alpha */
+declare const companyLogoExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "company-logo";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const searchExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "search";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const spacerExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "spacer";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const selfServiceButtonExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "self-service-button";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const starredDropdownExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "starred-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const applicationLauncherDropdownExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "app-launcher-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const helpDropdownExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "help-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const notificationButtonExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "notification-button";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const dividerExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "divider";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+/** @alpha */
+declare const profileDropdownExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "profile-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>;
+
+/** @alpha */
+declare const settingsMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "settings";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+/** @alpha */
+declare const myProfileMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "my-profile";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+/** @alpha */
+declare const logoutMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "logout";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+/** @alpha */
+declare const supportButtonMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "support-button";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+/** @alpha */
+declare const appLauncherDevHubMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "app-launcher-devhub";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+/** @alpha */
+declare const appLauncherRhdhLocalMenuItemExtension: _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "app-launcher-rhdh-local";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>;
+
+/**
+ * All default toolbar component extensions.
+ * @alpha
+ */
+declare const defaultToolbarExtensions: (_backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "company-logo";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "search";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "spacer";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "self-service-button";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "starred-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "app-launcher-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "help-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "notification-button";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "divider";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-component";
+    name: "profile-dropdown";
+    config: {
+        priority: number | undefined;
+    };
+    configInput: {
+        priority?: number | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderComponentData, "global-header.component", {}>;
+    inputs: {};
+    params: ToolbarComponentParams;
+}>)[];
+/**
+ * All default menu item extensions.
+ * @alpha
+ */
+declare const defaultMenuItemExtensions: (_backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "settings";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "my-profile";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "logout";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "support-button";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "app-launcher-devhub";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}> | _backstage_frontend_plugin_api.OverridableExtensionDefinition<{
+    kind: "gh-menu-item";
+    name: "app-launcher-rhdh-local";
+    config: {
+        priority: number | undefined;
+        title: string | undefined;
+        titleKey: string | undefined;
+        icon: string | undefined;
+        link: string | undefined;
+        sectionLabel: string | undefined;
+        sectionLink: string | undefined;
+        sectionLinkLabel: string | undefined;
+    };
+    configInput: {
+        link?: string | undefined;
+        title?: string | undefined;
+        icon?: string | undefined;
+        titleKey?: string | undefined;
+        priority?: number | undefined;
+        sectionLabel?: string | undefined;
+        sectionLink?: string | undefined;
+        sectionLinkLabel?: string | undefined;
+    };
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<GlobalHeaderMenuItemData, "global-header.menu-item", {}>;
+    inputs: {};
+    params: MenuItemParams;
+}>)[];
+
+/**
+ * App module that registers global header translations.
+ * @alpha
+ */
+declare const globalHeaderTranslationsModule: _backstage_frontend_plugin_api.FrontendModule;
+
+export { GlobalHeaderComponentBlueprint, type GlobalHeaderComponentData, GlobalHeaderDropdown, type GlobalHeaderDropdownProps, GlobalHeaderMenuItem, GlobalHeaderMenuItemBlueprint, type GlobalHeaderMenuItemData, type GlobalHeaderMenuItemProps, type MenuItemParams, type ToolbarComponentParams, appLauncherDevHubMenuItemExtension, appLauncherRhdhLocalMenuItemExtension, applicationLauncherDropdownExtension, companyLogoExtension, globalHeaderPlugin as default, defaultMenuItemExtensions, defaultToolbarExtensions, dividerExtension, globalHeaderComponentDataRef, globalHeaderMenuItemDataRef, globalHeaderModule, globalHeaderTranslationsModule, helpDropdownExtension, logoutMenuItemExtension, myProfileMenuItemExtension, notificationButtonExtension, profileDropdownExtension, searchExtension, selfServiceButtonExtension, settingsMenuItemExtension, spacerExtension, starredDropdownExtension, supportButtonMenuItemExtension, useGlobalHeaderComponents, useGlobalHeaderMenuItems };