@octopusdeploy/design-system-components
Version:
The design systems component library.
55 lines (54 loc) • 2.13 kB
TypeScript
import type { ReactElement } from "react";
import type { SimpleMenuItem } from "../MenuItems";
import type { PageTitleBadge } from "../Page";
import type { PageAction, PrimaryPageAction } from "../PageActions";
interface HeaderSecondaryMainWithActionsProps {
/**
* 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
*/
pageActions?: PageAction[];
/**
* The items to show as part of the overflow menu on the right side of the header
*/
overflowActions?: SimpleMenuItem[];
}
export type HeaderSecondaryMainContentProps = HeaderSecondaryMainWithActionsProps & PageHeaderTitleProps;
export declare function HeaderSecondaryMainContent({ titleStatusIcon, title, titleChip, titleBadge, titleSecondaryBadge, titleAccessory, titleComplementaryText, ...actionProps }: HeaderSecondaryMainContentProps): import("react/jsx-runtime").JSX.Element;
interface PageHeaderTitleProps {
/** The title of the HeaderSecondary. */
title: string | undefined;
/**
* Additional text to show immediately after the `title` with less emphasis.
*/
titleComplementaryText?: string;
/**
* The status icon to show on the left side of the title.
*
* The status icon is only visible when this property is defined.
*/
titleStatusIcon?: ReactElement;
/**
* The badge that shows on the right side of the title.
*/
titleBadge?: PageTitleBadge;
/**
* A second badge to show on the right side of the title, after titleBadge.
*/
titleSecondaryBadge?: PageTitleBadge;
/**
* @deprecated Use titleBadge props instead.
*
* The chip to show on the right side of the title, the status icon is only visible when this property is defined.
*/
titleChip?: ReactElement;
/**
* 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 chips.
*/
titleAccessory?: ReactElement;
}
export {};