@octopusdeploy/design-system-components
Version:
The design systems component library.
33 lines (32 loc) • 1.25 kB
TypeScript
import type React from "react";
import type { DesignSystemLinkHref, ShowLinkAsActive } from "../../routing";
import { Divider } from "../Divider";
export interface AreaNavListProps {
listItems: ReadonlyArray<AreaNavListItem>;
onLinkClicked?: (item: AreaNavListLinkItem) => void;
hasTitle?: boolean;
}
export interface AreaNavListGroup {
heading: string | undefined;
items: ReadonlyArray<AreaNavListGroupItem>;
hasTrailingDivider?: boolean;
}
export type AreaNavListGroupItem = AreaNavListLinkItem | AreaNavListLinkPlaceholder;
export type AreaNavListItem = Spacer | Divider | AreaNavListLinkItem | AreaNavListLinkPlaceholder | AreaNavListGroup;
export type FeatureBadgeLabel = "Alpha" | "Preview" | "New";
type Spacer = "spacer";
type Divider = "divider";
export interface AreaNavListLinkItem {
href: DesignSystemLinkHref;
showLinkAsActive?: ShowLinkAsActive;
label: string;
accessibleName?: string;
icon?: React.ReactNode;
featureBadgeLabel?: FeatureBadgeLabel;
isVisible?: boolean;
}
interface AreaNavListLinkPlaceholder {
placeholderLabel: string;
}
export declare function AreaNavList({ listItems, onLinkClicked }: AreaNavListProps): import("react/jsx-runtime").JSX.Element;
export {};