Backstage
    Preparing search index...

    Interface HeaderProps

    Props for the Header component.

    interface HeaderProps {
        activeTabId?: string | null;
        breadcrumbs?: HeaderBreadcrumb[];
        className?: string;
        customActions?: ReactNode;
        description?: string;
        metadata?: HeaderMetadataItem[];
        sticky?: boolean;
        tabs?: HeaderNavTabItem[];
        tags?: HeaderTag[];
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeTabId? breadcrumbs? className? customActions? description? metadata? sticky? tabs? tags? title?

    Properties

    activeTabId?: string | null
    breadcrumbs?: HeaderBreadcrumb[]

    The breadcrumbs prop will be removed in a future release.

    className?: string
    customActions?: ReactNode
    description?: string

    Markdown string rendered below the title. Only inline links are supported. Bold, italic, and block-level markdown are not rendered.

    metadata?: HeaderMetadataItem[]
    sticky?: boolean

    Makes the title-and-actions row stick to the top of its nearest scroll container while the rest of the header content scrolls away.

    tabs?: HeaderNavTabItem[]
    tags?: HeaderTag[]
    title?: string

    Settings

    Member Visibility

    On This Page

    Properties