@octopusdeploy/design-system-components/dist/src/components/HeaderPrimary/HeaderPrimary.d.ts

The design systems component library.

import type { ReactElement } from "react";
import type React from "react";
import type { DesignSystemLinkHref } from "../../routing";
import type { BreadcrumbItem } from "../Breadcrumbs";
import type { SimpleMenuItem } from "../MenuItems";
import type { PageTitleBadge, PageTitleStatusBadge } from "../Page";
import type { PageAction, PrimaryPageAction } from "../PageActions";
export interface HeaderPrimaryProps {
    /**
     * The breadcrumbs showing at the top of primary header.
     *
     * The breadcrumbs is only visible when this property is defined.
     */
    breadcrumbs?: BreadcrumbItem[];
    /**
     * The logo to show to the left of the header title.
     *
     * The logo is only visible when this property is defined.
     */
    logo?: HeaderPrimaryLogo;
    /** The title of the HeaderPrimary. */
    title: string;
    /** clicking the logo will take you to this URL */
    logoLinkURL?: DesignSystemLinkHref;
    /**
     * The icon to show next to the header title.
     *
     * The icon next to the title is only visible when this property is defined.
     */
    titleIcon?: ReactElement;
    /** A list of Badges or StatusBadges that showing next to the header title with a divider at the beginning */
    titleBadges?: (PageTitleBadge | PageTitleStatusBadge)[];
    /**
     * An optional primary action to display on the right side of the header
     */
    primaryAction?: PrimaryPageAction;
    /**
     * An optional list of actions to display on the right side of the header
     */
    actions?: PageAction[];
    /**
     * An optional list of overflow items that forms an overflow menu on the right side of the header
     */
    overflowActions?: SimpleMenuItem[];
    statusSection?: React.ReactNode;
}
export interface HeaderPrimaryLogo {
    /** The url of the logo */
    href: string;
    /** The accessible name of the logo */
    accessibleName: string;
}
export declare function HeaderPrimary({ breadcrumbs, statusSection, logo, logoLinkURL, title, titleIcon, titleBadges, primaryAction, actions, overflowActions }: HeaderPrimaryProps): import("react/jsx-runtime").JSX.Element;