IBreadCrumbProps

@spartanfx/react v1.2.2

---

@spartanfx/react / index / IBreadCrumbProps

Interface: IBreadCrumbProps

Props for the BreadCrumb component.

Properties

Required

Property	Type	Default	Description
items	IBreadCrumbItem[]	-	Array of breadcrumb items to display.

Options

Property	Type	Default	Description
ariaLabel?	string	'Breadcrumb'	ARIA label for the breadcrumb navigation.
itemsAfterCollapse?	number	1	Number of items to always show at the end when collapsed.
itemsBeforeCollapse?	number	1	Number of items to always show at the start when collapsed.
maxItems?	number	Infinity (no overflow)	Maximum number of items to display before overflow. When exceeded, items are collapsed into a dropdown.
overflowLabel?	string	'...'	Label for overflow menu button.
overflowStrategy?	OverflowStrategy	'collapse'	Strategy for handling overflow when maxItems is exceeded.
separator?	ReactNode	'/'	Custom separator element between breadcrumb items.

Events & callbacks

Property	Type	Default	Description
onItemClick?	(item, event) => void	-	Callback fired when a breadcrumb item is clicked.
renderItem?	(args) => ReactNode	-	Custom render function for breadcrumb items. Provides full control over item rendering.
renderSeparator?	(index) => ReactNode	-	Custom render function for the separator.

Appearance & theming

Property	Type	Default	Description
appearance?	AppearanceMode	AppearanceMode.light	Appearance mode for light or dark theme.
classes?	IBreadCrumbClassNames	-	CSS class name overrides for component elements.
className?	string	-	CSS class name for the root container.
style?	CSSProperties	-	Inline styles for the root container.
tokens?	IBreadCrumbTokens	-	Design tokens for theming.