@stanfordspezi/spezi-web-design-system
Version:
Stanford Biodesign Digital Health Spezi Web Design System
30 lines (29 loc) • 1.52 kB
TypeScript
import { ComponentProps, ReactNode } from 'react';
export declare const Breadcrumb: ({ ...props }: ComponentProps<"nav">) => import("react").JSX.Element;
export declare const BreadcrumbList: ({ className, ...props }: ComponentProps<"ol">) => import("react").JSX.Element;
export declare const BreadcrumbItem: ({ className, ...props }: ComponentProps<"li">) => import("react").JSX.Element;
type BreadcrumbLinkProps = ComponentProps<"a"> & {
asChild?: boolean;
};
export declare const BreadcrumbLink: ({ asChild, className, ...props }: BreadcrumbLinkProps) => import("react").JSX.Element;
export declare const BreadcrumbPage: ({ className, ...props }: ComponentProps<"span">) => import("react").JSX.Element;
export declare const BreadcrumbSeparator: ({ children, className, ...props }: ComponentProps<"li">) => import("react").JSX.Element;
export declare const BreadcrumbEllipsis: ({ className, ...props }: ComponentProps<"span">) => import("react").JSX.Element;
interface BreadcrumbsProps {
breadcrumbs: Array<{
href: string;
label: ReactNode;
}>;
/**
* Represents the maximum number of breadcrumb elements to display.
* Any breadcrumbs beyond this number will be hidden behind a dropdown.
* @range [2, Infinity]
* @default 3
* */
maxToDisplay?: number;
}
/**
* Complete, ready to use Breadcrumbs component with truncation support
* */
export declare const Breadcrumbs: ({ breadcrumbs, maxToDisplay, }: BreadcrumbsProps) => import("react").JSX.Element;
export {};