@buun_group/brutalist-ui
Version:
A brutalist-styled component library
44 lines (43 loc) • 2.3 kB
TypeScript
/**
* @module Breadcrumb
* @description A navigation component that shows the current page location within a hierarchical structure. Helps users understand their location and navigate back.
*/
import React, { HTMLAttributes, AnchorHTMLAttributes, CSSProperties } from 'react';
export interface BreadcrumbProps extends HTMLAttributes<HTMLElement> {
/** Separator between breadcrumb items */
separator?: React.ReactNode;
/** Additional CSS classes */
className?: string;
/** Custom CSS styles (supports utility classes) */
style?: CSSProperties;
}
export interface BreadcrumbItemProps extends HTMLAttributes<HTMLLIElement> {
/** Whether this item is the current page */
isCurrentPage?: boolean;
/** Additional CSS classes */
className?: string;
/** Custom CSS styles (supports utility classes) */
style?: CSSProperties;
}
export interface BreadcrumbLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
/** Additional CSS classes */
className?: string;
/** Custom CSS styles (supports utility classes) */
style?: CSSProperties;
}
export declare const Breadcrumb: React.ForwardRefExoticComponent<BreadcrumbProps & React.RefAttributes<HTMLElement>>;
export declare const BreadcrumbItem: React.ForwardRefExoticComponent<BreadcrumbItemProps & React.RefAttributes<HTMLLIElement>>;
export declare const BreadcrumbLink: React.ForwardRefExoticComponent<BreadcrumbLinkProps & React.RefAttributes<HTMLAnchorElement>>;
export interface BreadcrumbPageProps extends HTMLAttributes<HTMLSpanElement> {
/** Additional CSS classes */
className?: string;
/** Custom CSS styles (supports utility classes) */
style?: CSSProperties;
}
export declare const BreadcrumbPage: React.ForwardRefExoticComponent<BreadcrumbPageProps & React.RefAttributes<HTMLSpanElement>>;
declare const BreadcrumbNamespace: React.ForwardRefExoticComponent<BreadcrumbProps & React.RefAttributes<HTMLElement>> & {
Item: React.ForwardRefExoticComponent<BreadcrumbItemProps & React.RefAttributes<HTMLLIElement>>;
Link: React.ForwardRefExoticComponent<BreadcrumbLinkProps & React.RefAttributes<HTMLAnchorElement>>;
Page: React.ForwardRefExoticComponent<BreadcrumbPageProps & React.RefAttributes<HTMLSpanElement>>;
};
export default BreadcrumbNamespace;