beta-parity-react/ui/Breadcrumb/index.d.ts

Beta Parity React Components

import React from 'react';
import './index.css';
import './variables.css';
import { InlineLinkProps } from '../InlineLink';
import { MenuProps } from '../Menu';
/**
 * Props for the Breadcrumb component.
 *
 * Extends properties from the `ul` element.
 */
export interface BreadcrumbProps extends React.HTMLAttributes<HTMLUListElement> {
    /**
     * Specifies the separator style to use between breadcrumb items.
     * - `'chevron'`: Uses a chevron (e.g., `>`).
     * - `'dash'`: Uses a dash (e.g., `-`).
     * - `'slash'`: Uses a slash (e.g., `/`).
     *
     * @default 'chevron'
     * @memberof Breadcrumb
     *
     */
    separator?: 'chevron' | 'dash' | 'slash';
    /**
     * An array of breadcrumb items to render in the breadcrumb trail.
     * Each item should conform to the `BreadcrumbItemProps` interface.
     *
     * If the breadcrumbList is not empty, the component will be prioritized over other components.
     *
     * @memberof Breadcrumb
     */
    breadcrumbList?: BreadcrumbItemProps[];
    /**
     * Limits the number of visible breadcrumb items. If the number of items exceeds this value,
     * a truncation mechanism will be applied (e.g., showing a menu for overflowed items).
     *
     * @default 'undefined' -> infinite
     * @memberof Breadcrumb
     */
    limit?: number;
    /**
     * Additional properties for the overflow menu when the breadcrumb items exceed the limit.
     * This excludes the `children` property, which is managed internally.
     *
     * @memberof Breadcrumb
     */
    menuProps?: Omit<MenuProps, 'children'>;
}
/**
 * **Parity Breadcrumb**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/breadcrumb Parity Breadcrumb}
 */
export declare const Breadcrumb: React.ForwardRefExoticComponent<BreadcrumbProps & Pick<InlineLinkProps, "color" | "disabled" | "size" | "underline" | "iconOnly"> & React.RefAttributes<HTMLUListElement>>;
/**
 * Props for the BreadcrumbItem component.
 *
 * Extends properties from the `a` element.
 */
export interface BreadcrumbItemProps extends InlineLinkProps {
    isMenuItem?: boolean;
}
/**
 * **Parity BreadcrumbItem**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/breadcrumb Parity BreadcrumbItem}
 */
export declare const BreadcrumbItem: React.ForwardRefExoticComponent<BreadcrumbItemProps & React.RefAttributes<HTMLAnchorElement>>;
/**
 * Props for the BreadcrumbMenu component.
 *
 * Extends properties from the `button` element.
 */
export interface BreadcrumbMenuProps extends React.HTMLAttributes<HTMLButtonElement> {
    items: BreadcrumbItemProps[];
    menuProps?: Omit<MenuProps, 'children'>;
}
/**
 * **Parity BreadcrumbMenu**.
 *
 *  @see {@link https://beta-parity-react.vercel.app/breadcrumb Parity BreadcrumbMenu}
 */
export declare const BreadcrumbMenu: React.ForwardRefExoticComponent<BreadcrumbMenuProps & React.RefAttributes<HTMLButtonElement>>;
export interface BreadcrumbActiveProps extends React.HTMLAttributes<HTMLLIElement> {
    item: BreadcrumbItemProps;
}
export declare const BreadcrumbActive: React.ForwardRefExoticComponent<BreadcrumbActiveProps & React.RefAttributes<HTMLLIElement>>;
//# sourceMappingURL=index.d.ts.map