UNPKG

@octopusdeploy/design-system-components

Version:
38 lines (37 loc) 1.48 kB
import type { ReactElement } from "react"; import type { BreadcrumbItem } from "../Breadcrumbs"; import type { SimpleMenuItem } from "../MenuItems"; import type { PageTitleBadge } from "../Page"; import type { PageAction, PrimaryPageAction } from "../PageActions"; export interface Level1PageHeaderProps { /** * The breadcrumbs showing at the top of primary header. * * The breadcrumbs is only visible when this property is defined. */ breadcrumbs?: BreadcrumbItem[]; /** The title of the Level1PageHeader. */ title: string; /** * 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[]; /** * The badge to show on the right side of the title. */ titleBadge?: PageTitleBadge; /** * An element which can be used to display in addition to the title. This is * displayed to the right of the title, but before any badges. */ titleAccessory?: ReactElement; /** * An optional list of overflow items that forms an overflow menu on the right side of the header */ overflowActions?: SimpleMenuItem[]; } export declare function Level1PageHeader({ breadcrumbs, title, titleBadge, titleAccessory, primaryAction, actions, overflowActions }: Level1PageHeaderProps): import("react/jsx-runtime").JSX.Element;