@engie-group/fluid-design-system-react/lib/components/breadcrumb/NJBreadcrumb.d.ts

Fluid Design System React

import React, { ComponentPropsWithoutRef } from 'react';
export declare const NJBreadcrumb: React.ForwardRefExoticComponent<IBreadcrumbProps & React.RefAttributes<HTMLElement>>;
export interface IBreadcrumbProps extends ComponentPropsWithoutRef<'nav'> {
    /**
     * By default, `NjBreadcrumb` displays up to 4 children and minifies the view when 5 or more
     * are provided. Set `isMinified` to false in order to programmatically display all the items.
     **/
    isMinified?: boolean;
    /**
     * Set the maximum number of breadcrumb elements to be displayed before the breadcrumb is collapsed.
     * By default, `NjBreadcrumb` displays up to 4 children and minifies the view
     * when 5 or more are provided.
     * @default = 4
     **/
    maximumItemsBeforeMinification?: number;
    /**
     * Describes the navigation to screen reader users (who navigate the page using landmarks)
     *
     * @default "Breadcrumbs"
     */
    ariaLabel?: string;
    /**
     * Accessible text alternative for the "show more" button when the breadcrumb is minified.
     *
     * @default "Show hidden items"
     */
    showMoreLabel?: string;
    /**
     * NJBreadcrumb items
     **/
    children?: React.ReactNode;
    /**
     *  Optional additional className
     **/
    className?: string;
}