IBreadCrumbProps
@spartanfx/react / IBreadCrumbProps
Interface: IBreadCrumbProps
Props for the BreadCrumb component.
Properties
| Property | Type | Description |
|---|---|---|
appearance? | AppearanceMode | Appearance mode for light or dark theme. Default AppearanceMode.light |
ariaLabel? | string | ARIA label for the breadcrumb navigation. Default 'Breadcrumb' |
classes? | IBreadCrumbClassNames | CSS class name overrides for component elements. |
className? | string | CSS class name for the root container. |
items | IBreadCrumbItem[] | Array of breadcrumb items to display. |
itemsAfterCollapse? | number | Number of items to always show at the end when collapsed. Default 1 |
itemsBeforeCollapse? | number | Number of items to always show at the start when collapsed. Default 1 |
maxItems? | number | Maximum number of items to display before overflow. When exceeded, items are collapsed into a dropdown. Default Infinity (no overflow) |
onItemClick? | (item, event) => void | Callback fired when a breadcrumb item is clicked. |
overflowLabel? | string | Label for overflow menu button. Default '...' |
overflowStrategy? | OverflowStrategy | Strategy for handling overflow when maxItems is exceeded. Default 'collapse' |
renderItem? | (args) => ReactNode | Custom render function for breadcrumb items. Provides full control over item rendering. |
renderSeparator? | (index) => ReactNode | Custom render function for the separator. |
separator? | ReactNode | Custom separator element between breadcrumb items. Default '/' |
style? | CSSProperties | Inline styles for the root container. |
tokens? | IBreadCrumbTokens | Design tokens for theming. |