@postenbring/hedwig-react
Version:
React components for [Hedwig Design System](https://github.com/bring/hedwig-design-system).
33 lines • 988 B
TypeScript
import { type HTMLAttributes, type ReactElement, type ReactNode } from "react";
export interface BreadcrumbsProps extends HTMLAttributes<HTMLOListElement> {
children: ReactNode | ReactElement<HTMLLIElement> | ReactElement<HTMLLIElement>[];
/**
* Props passed to the `ol` html element
*/
olProps?: HTMLAttributes<HTMLElement>;
}
/**
* A breadcrumbs navigation menu
*
* @example
*
* ```tsx
* <Breadcrumbs data-testid="breadcrumbs">
* <li><Link href="../">Previous page</Link></li>
* <li aria-current="page">Current page</li>
* </Breadcrumbs>
* ```
*
* Outputs this html structure
*
* ```html
* <nav data-testid="breadcrumbs">
* <ol>
* <li><a href="../">Previous page</a></li>
* <li aria-current="page">Current page</li>
* </ol>
* </nav>
* ```
*/
export declare const Breadcrumbs: import("react").ForwardRefExoticComponent<BreadcrumbsProps & import("react").RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=breadcrumbs.d.ts.map