@engie-group/fluid-design-system-react
Version:
Fluid Design System React
48 lines (47 loc) • 1.2 kB
TypeScript
import React from 'react';
export declare const NJBreadcrumbItem: React.ForwardRefExoticComponent<IBreadcrumbItemProps & React.RefAttributes<HTMLLIElement>>;
export interface IBreadcrumbItemProps {
/**
* Whether item is active
**/
isActive?: boolean;
/**
* Breadcrumb link href
**/
href?: string;
/**
* Breadcrumb link target
**/
target?: string;
/**
* Breadcrumb link rel
*/
rel?: string;
/**
* Breadcrumb item text
**/
children?: React.ReactNode;
/**
* Breadcrumb link icon (material icon name https://material.io/resources/icons/?style=baseline)
**/
icon?: string;
/**
* Accessible text alternative when the item has an icon and no children.
*
* @example
* <NJBreadcrumbItem href="/" icon="home" label="Home page" />
*/
label?: string;
/**
* Breadcrumb link icon position
**/
iconPosition?: 'after' | 'before';
/**
* Function called when the link is clicked
*/
onClick?: React.MouseEventHandler<HTMLButtonElement | HTMLAnchorElement>;
/**
* Optional additional className
**/
className?: string;
}