Stepper

Horizontal or vertical progress steps for setup and checkout flows.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Stepper } from "@tavojs/ui/stepper";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/stepper.

When to use

Use it when

Use `Stepper` for multi-step flows

Choose something else when

Avoid Stepper when using data components as decorative layout containers.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Stepper example

TSXCreate: src/components/examples/StepperExample1.tsx

tsximport { Stepper } from "@tavojs/ui/stepper";

export function StepperExample1() {
  return (
    <>
      <Stepper steps={[{ id: "profile", title: "Profile", status: "current" }]} />
      <Stepper steps={[{ label: "Billing", status: "upcoming" }]} />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`steps`	`{ id?: string; title?: Child; label?: Child; description?: Child; status?: "complete" \| "current" \| "upcoming" \| "error" }[]`	Required	Configures steps for this component.
`orientation`	`"horizontal" \| "vertical"`	—	Configures orientation for this component.

Complete TypeScript API

Import from @tavojs/ui/stepper. Published exports: StepItem, StepStatus, Stepper, StepperProps.

`StepperProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Stepper.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Stepper.
`id`	`string`	No	Inherited id attribute accepted by Stepper.
`role`	`string`	No	Inherited role attribute accepted by Stepper.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Stepper.
`title`	`string`	No	Inherited title attribute accepted by Stepper.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Stepper.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Stepper.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Stepper.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Stepper.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Stepper.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Stepper.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Stepper.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Stepper.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Stepper.
`steps`	`StepItem[]`	Yes	Configures steps for this component.
`orientation`	`"horizontal" \| "vertical"`	No	Configures orientation for this component.

State ownership and DOM target

Concern	Contract
State	Props describe the displayed state. Update them from application data; the component does not fetch or advance that state itself.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Stepper when using data components as decorative layout containers.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Current step receives `aria-current="step"`.

Current step receives `aria-current="step"`.

Component status

Contract	Current value
Maturity	stable
Category	data
Component import	`@tavojs/ui/stepper`
Explicit CSS import	`@tavojs/ui/css/stepper`
Preview	Interactive preview available on this page