@octopusdeploy/design-system-components
Version:
The design systems component library.
20 lines (19 loc) • 1.08 kB
TypeScript
import type { BreadcrumbItem } from "../Breadcrumbs";
import type { HeaderSecondaryMainContentProps } from "./HeaderSecondaryMainContent";
export type HeaderSecondaryProps = HeaderSecondaryMainContentProps & {
/**
* A list of BreadcrumbItem that forms the breadcrumbs at the top of HeaderSecondary.
*
* The breadcrumbs is only visible when this property is not empty list.
*/
breadcrumbsItems?: BreadcrumbItem[];
/**
* indicates if this HeaderSecondary component should be in a sticky state because of scrolling.
*
* Sticky state has different visual effect compared to normal state.
*/
isStickied?: boolean;
/** If true and when the breadcrumbsItems' length is one, the breadcrumb in secondary header will show with back icon */
showBreadcrumbBackIcon?: boolean;
};
export declare function HeaderSecondary({ breadcrumbsItems, showBreadcrumbBackIcon, isStickied, titleStatusIcon, titleChip, titleBadge, title, titleAccessory, ...mainContentProps }: HeaderSecondaryProps): import("react/jsx-runtime").JSX.Element;