Breadcrumbs

The props declared for Breadcrumbs, generated from the types @proyecto-viviana/ui ships.

Import

import { Breadcrumbs } from "@proyecto-viviana/ui";

Props

Props for Breadcrumbs in @proyecto-viviana/ui
Prop	Type	Default	Description
`children`	number \| boolean \| RenderedElement \| ArrayElement \| (string & {}) \| Node \| JSX.ArrayElement \| ((item: T) => JSX.Element)	—	The children of the Breadcrumbs.
`size`	'M' \| 'L' \| 'sm' \| 'md' \| 'lg'	`'M'`	The size of the Breadcrumbs.
`styles`	StyleString \| (() => StyleString \| undefined)	—	Spectrum-defined generated classes.
`UNSAFE_className`	string	—	Additional CSS class name. Use only as a last resort.
`UNSAFE_style`	JSX.CSSProperties	—	Additional inline styles. Use only as a last resort.
`class`	string	—	Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
`variant`	'default' \| 'subtle'	—	Legacy visual variant alias. Kept for source compatibility; S2 Breadcrumbs has no variant.
`showSeparator`	false \| true	—	Legacy separator toggle. Kept for source compatibility.
`ref`	HTMLElement \| ((el: HTMLElement) => void) \| { current?: HTMLElement \| null \| undefined; }	—	Ref for the navigation element.
`slot`	string \| false	—	A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components
`aria-describedby`	string	—	Identifies the element (or elements) that describes the breadcrumbs. solidaria
`aria-details`	string	—	Identifies the element (or elements) that provide a detailed description. solidaria
`aria-label`	string	—	Provides a label for the breadcrumbs navigation. solidaria
`aria-labelledby`	string	—	Identifies the element (or elements) that labels the breadcrumbs. solidaria
`isDisabled`	false \| true	—	Whether the breadcrumbs are disabled. solidaria-components
`items`	T[]	—	The items to render in the breadcrumbs. solidaria-components
`onAction`	(key: string \| number) => void	—	Handler called when a breadcrumb item is activated. solidaria-components
`getKey`	(item: T) => string \| number	—	Function to get the key from an item. solidaria-components

Declared in packages/viviana-ui/src/breadcrumbs/index.tsx.

Breadcrumb props

Props for Breadcrumb in @proyecto-viviana/ui
Prop	Type	Default	Description
`children`	number \| boolean \| RenderedElement \| ArrayElement \| (string & {}) \| Node \| JSX.ArrayElement \| ((renderProps: BreadcrumbItemRenderProps) => JSX.Element)	—	The children of the breadcrumb item.
`styles`	StyleString \| (() => StyleString \| undefined)	—	Spectrum-defined generated classes.
`UNSAFE_className`	string	—	Additional CSS class name. Use only as a last resort.
`UNSAFE_style`	JSX.CSSProperties	—	Additional inline styles. Use only as a last resort.
`class`	string	—	Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
`ref`	HTMLElement \| ((el: HTMLElement) => void) \| { current?: HTMLElement \| null \| undefined; }	—	Ref for the breadcrumb item element.
`slot`	string \| false	—	A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components
`id`	string	—	The DOM id for the breadcrumb item. solidaria
`onBlur`	(e: FocusEvent) => void	—	Handler that is called when the element loses focus. solidaria
`onClick`	(e: MouseEvent) => void	—	Handler that is called when the element is clicked. solidaria
`onFocus`	(e: FocusEvent) => void	—	Handler that is called when the element receives focus. solidaria
`onKeyDown`	(e: KeyboardEvent) => void	—	Handler that is called when a key is pressed. solidaria
`onKeyUp`	(e: KeyboardEvent) => void	—	Handler that is called when a key is released. solidaria
`aria-current`	false \| true \| 'page' \| 'step' \| 'location' \| 'date' \| 'time'	`'page'`	The type of current location for aria-current. solidaria
`aria-describedby`	string	—	Identifies the element (or elements) that describes the object. solidaria
`aria-details`	string	—	Identifies the element (or elements) that provide a detailed description. solidaria
`aria-label`	string	—	Defines a string value that labels the current element. solidaria
`aria-labelledby`	string	—	Identifies the element (or elements) that labels the current element. solidaria
`isDisabled`	false \| true	—	Whether this item is disabled. solidaria-components
`elementType`	string	`'a'`	The HTML element type. solidaria
`href`	string	—	The URL to link to. solidaria
`target`	string	—	The target window for the link. solidaria
`rel`	string	—	The relationship between the linked resource and the current page. solidaria
`onPress`	(e: PressEvent) => void	—	Handler that is called when the press is released over the target. solidaria
`onPressStart`	(e: PressEvent) => void	—	Handler that is called when a press interaction starts. solidaria
`onPressEnd`	(e: PressEvent) => void	—	Handler that is called when a press interaction ends. solidaria
`onPressUp`	(e: PressEvent) => void	—	Handler that is called when a press is released over the target. solidaria
`onPressChange`	(isPressed: boolean) => void	—	Handler that is called when the press state changes. solidaria
`autoFocus`	false \| true	—	Whether to autofocus the element. solidaria
`routerOptions`	Record<string, unknown>	—	Additional options forwarded to client-side router navigation handlers. solidaria
`hrefLang`	string	—	Hints the language of the linked resource. solidaria
`download`	string \| boolean	—	Instructs the browser to download the URL instead of navigating to it. solidaria
`ping`	string	—	Space-separated list of URLs to ping when following the link. solidaria
`referrerPolicy`	'' \| 'no-referrer' \| 'no-referrer-when-downgrade' \| 'origin' \| 'origin-when-cross-origin' \| 'same-origin' \| 'strict-origin' \| 'strict-origin-when-cross-origin' \| 'unsafe-url'	—	Referrer policy for fetches initiated by this link. solidaria
`onFocusChange`	(isFocused: boolean) => void	—	Handler that is called when the element's focus status changes. solidaria
`isCurrent`	false \| true	—	Whether this is the current/last item in the breadcrumb trail. solidaria

Declared in packages/viviana-ui/src/breadcrumbs/index.tsx.

BreadcrumbItem props

Props for BreadcrumbItem in @proyecto-viviana/ui
Prop	Type	Default	Description
`children`	number \| boolean \| RenderedElement \| ArrayElement \| (string & {}) \| Node \| JSX.ArrayElement \| ((renderProps: BreadcrumbItemRenderProps) => JSX.Element)	—	The children of the breadcrumb item.
`styles`	StyleString \| (() => StyleString \| undefined)	—	Spectrum-defined generated classes.
`UNSAFE_className`	string	—	Additional CSS class name. Use only as a last resort.
`UNSAFE_style`	JSX.CSSProperties	—	Additional inline styles. Use only as a last resort.
`class`	string	—	Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
`ref`	HTMLElement \| ((el: HTMLElement) => void) \| { current?: HTMLElement \| null \| undefined; }	—	Ref for the breadcrumb item element.
`slot`	string \| false	—	A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components
`id`	string	—	The DOM id for the breadcrumb item. solidaria
`onBlur`	(e: FocusEvent) => void	—	Handler that is called when the element loses focus. solidaria
`onClick`	(e: MouseEvent) => void	—	Handler that is called when the element is clicked. solidaria
`onFocus`	(e: FocusEvent) => void	—	Handler that is called when the element receives focus. solidaria
`onKeyDown`	(e: KeyboardEvent) => void	—	Handler that is called when a key is pressed. solidaria
`onKeyUp`	(e: KeyboardEvent) => void	—	Handler that is called when a key is released. solidaria
`aria-current`	false \| true \| 'page' \| 'step' \| 'location' \| 'date' \| 'time'	`'page'`	The type of current location for aria-current. solidaria
`aria-describedby`	string	—	Identifies the element (or elements) that describes the object. solidaria
`aria-details`	string	—	Identifies the element (or elements) that provide a detailed description. solidaria
`aria-label`	string	—	Defines a string value that labels the current element. solidaria
`aria-labelledby`	string	—	Identifies the element (or elements) that labels the current element. solidaria
`isDisabled`	false \| true	—	Whether this item is disabled. solidaria-components
`elementType`	string	`'a'`	The HTML element type. solidaria
`href`	string	—	The URL to link to. solidaria
`target`	string	—	The target window for the link. solidaria
`rel`	string	—	The relationship between the linked resource and the current page. solidaria
`onPress`	(e: PressEvent) => void	—	Handler that is called when the press is released over the target. solidaria
`onPressStart`	(e: PressEvent) => void	—	Handler that is called when a press interaction starts. solidaria
`onPressEnd`	(e: PressEvent) => void	—	Handler that is called when a press interaction ends. solidaria
`onPressUp`	(e: PressEvent) => void	—	Handler that is called when a press is released over the target. solidaria
`onPressChange`	(isPressed: boolean) => void	—	Handler that is called when the press state changes. solidaria
`autoFocus`	false \| true	—	Whether to autofocus the element. solidaria
`routerOptions`	Record<string, unknown>	—	Additional options forwarded to client-side router navigation handlers. solidaria
`hrefLang`	string	—	Hints the language of the linked resource. solidaria
`download`	string \| boolean	—	Instructs the browser to download the URL instead of navigating to it. solidaria
`ping`	string	—	Space-separated list of URLs to ping when following the link. solidaria
`referrerPolicy`	'' \| 'no-referrer' \| 'no-referrer-when-downgrade' \| 'origin' \| 'origin-when-cross-origin' \| 'same-origin' \| 'strict-origin' \| 'strict-origin-when-cross-origin' \| 'unsafe-url'	—	Referrer policy for fetches initiated by this link. solidaria
`onFocusChange`	(isFocused: boolean) => void	—	Handler that is called when the element's focus status changes. solidaria
`isCurrent`	false \| true	—	Whether this is the current/last item in the breadcrumb trail. solidaria

Declared in packages/viviana-ui/src/breadcrumbs/index.tsx.

Props marked solidaria or solidaria-components come from the headless layer underneath and behave the same in both registers. Components that wrap a DOM element also accept that element's standard attributes, which are left out here on purpose — listing them would bury the props that are actually ours.