dgz-ui
Version:
Custom ui library using React.js, Shadcn/ui, TailwindCSS, Typescript
60 lines • 2.73 kB
TypeScript
import { ReactNode } from 'react';
import * as React from 'react';
/**
* Represents a single breadcrumb item used to build breadcrumb trails.
*
* @property {string} path - The URL or path to navigate to.
* @property {ReactNode} name - Display label for the breadcrumb item.
* @property {boolean} [isActive] - Marks the current page item.
*/
export interface BreadcrumbInterface {
path: string;
name: ReactNode;
isActive?: boolean;
}
/**
* Root breadcrumb navigation component. Provides aria-label and forwards ref to a <nav> element.
* @returns {JSX.Element} The rendered Breadcrumb component.
* @component
*/
declare const Breadcrumb: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & {
separator?: React.ReactNode;
} & React.RefAttributes<HTMLElement>>;
/**
* Ordered list that lays out breadcrumb items.
* @returns {JSX.Element} The rendered BreadcrumbList component.
* @component
*/
declare const BreadcrumbList: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.OlHTMLAttributes<HTMLOListElement>, HTMLOListElement>, "ref"> & React.RefAttributes<HTMLOListElement>>;
/**
* Single breadcrumb list item container.
* @returns {JSX.Element} The rendered BreadcrumbItem component.
* @component
*/
declare const BreadcrumbItem: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & React.RefAttributes<HTMLLIElement>>;
/**
* Non-clickable breadcrumb page indicator for the current route.
* Renders a span with aria-current="page".
* @returns {JSX.Element} The rendered BreadcrumbPage component.
* @component
*/
declare const BreadcrumbPage: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & React.RefAttributes<HTMLSpanElement>>;
/**
* Separator element displayed between breadcrumb items.
* Defaults to a right arrow icon when no children are provided.
* @returns {JSX.Element} The rendered BreadcrumbSeparator component.
*/
declare const BreadcrumbSeparator: {
({ children, className, ...props }: React.ComponentProps<"li">): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
/**
* Ellipsis component to indicate collapsed breadcrumb items.
* @returns {JSX.Element} The rendered BreadcrumbEllipsis component.
*/
declare const BreadcrumbEllipsis: {
({ className, ...props }: React.ComponentProps<"span">): import("react/jsx-runtime").JSX.Element;
displayName: string;
};
export { Breadcrumb, BreadcrumbEllipsis, BreadcrumbItem, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, };
//# sourceMappingURL=breadcrumb.d.ts.map