StepList

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

Import

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

Props

Props for StepList in @proyecto-viviana/ui
Prop	Type	Default	Description
`size`	'sm' \| 'md' \| 'lg'	—	The size of the step list.
`class`	string	—	Additional CSS class name.
`children`	(item: T, state: StepListItemRenderProps) => JSX.Element	—	Render function for step content, or omit to use default rendering.
`ref`	() => HTMLElement \| null	—	Ref accessor for the step list container element. solidaria
`onSelectionChange`	(key: Key) => void	—	Called when the selected step changes. solidaria-components
`aria-label`	string	—	Accessible label for the step list. solidaria
`aria-labelledby`	string	—	ID of element that labels the step list. solidaria
`isDisabled`	false \| true	—	Whether all steps are disabled. solidaria-components
`orientation`	'horizontal' \| 'vertical'	`"vertical"`	Primary orientation of the step list items. solidaria
`items`*	T[]	—	The step items. solidaria-components
`disallowTypeAhead`	false \| true	`false`	Whether typeahead navigation is disabled. solidaria
`disabledKeys`	Iterable<Key>	—	Keys of individually disabled steps. solidaria-components
`isReadOnly`	false \| true	—	Whether all steps are read-only. solidaria-components
`selectedKey`	Key	—	The currently selected step key (controlled). solidaria-components
`defaultSelectedKey`	Key	—	The default selected step key (uncontrolled). solidaria-components
`lastCompletedStep`	Key	—	The last completed step key (controlled). solidaria-components
`defaultLastCompletedStep`	Key	—	The default last completed step key (uncontrolled). solidaria-components
`onLastCompletedStepChange`	(key: Key \| null) => void	—	Called when last completed step changes. solidaria-components

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

Step props

Props for Step in @proyecto-viviana/ui
Prop	Type	Default	Description
`class`	string	—	Additional CSS class name.
`children`	number \| boolean \| RenderedElement \| ArrayElement \| (string & {}) \| Node \| JSX.ArrayElement	—	The children to render inside the step. solidaria-components
`item`*	{ key: Key; label: string; }	—	The step item. solidaria-components
`stepNumber`*	number	—	The 1-based step number. solidaria-components

Declared in packages/viviana-ui/src/steplist/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.