Forms

Stepper

Multi-step wizard progress with optional clickable steps.

Import

tsx

import { Stepper, StepperList, StepperItem, StepperIndicator, StepperSeparator, StepperTitle, StepperDescription } from "@cooud-ui/ui";

bash

npx cooud-ui add stepper

Examples

Wizard

A three-step flow with clickable steps. The indicator checks off completed steps; Back / Next drive the active value.

tsx

const STEPPER_STEPS = [
  { title: "Account", description: "Your details" },
  { title: "Shipping", description: "Where to send it" },
  { title: "Payment", description: "Confirm & pay" },
];

function StepperDemo() {
  const [step, setStep] = useState(1);
  const lastStep = STEPPER_STEPS.length - 1;

  return (
    <div className="flex w-full max-w-xl flex-col gap-6">
      <Stepper value={step} onValueChange={setStep}>
        <StepperList>
          {STEPPER_STEPS.map((item, index) => (
            <StepperItem key={item.title} step={index}>
              <StepperTrigger>
                <StepperIndicator />
                <span className="flex flex-col">
                  <StepperTitle>{item.title}</StepperTitle>
                  <StepperDescription>{item.description}</StepperDescription>
                </span>
              </StepperTrigger>
              {index < lastStep ? <StepperSeparator /> : null}
            </StepperItem>
          ))}
        </StepperList>
      </Stepper>
      <div className="flex justify-between">
        <Button
          variant="outline"
          disabled={step === 0}
          onClick={() => setStep((value) => Math.max(0, value - 1))}
        >
          Back
        </Button>
        <Button
          disabled={step === lastStep}
          onClick={() => setStep((value) => Math.min(lastStep, value + 1))}
        >
          Next
        </Button>
      </div>
    </div>
  );
}

API Reference

Generated from the component's exported types.

StepperProps

Extends Omit<HTMLAttributes<HTMLDivElement>, "onChange">

Prop	Type	Default	Description
`value`	`number`	—	Controlled active step index. When provided the stepper is fully controlled.
`defaultValue`	`number`	`0`	Initial active step index for the uncontrolled case. Defaults to `0`.
`onValueChange`	`(value: number) => void`	—	Called whenever a step should become active (controlled or not).
`orientation`	`StepperOrientation`	`"horizontal"`	Layout axis. Defaults to `"horizontal"`.

StepperItemProps

Extends HTMLAttributes<HTMLLIElement>

Prop	Type	Default	Description
`step`*	`number`	—	This step's zero-based index. Required so the item can derive its state (completed / active / upcoming) from the stepper's active value.
`completed`	`boolean`	—	Mark the step done explicitly. Overrides the index-derived "completed".
`disabled`	`boolean`	`false`	Disable interaction + dim the step.

StepperIndicatorProps

Extends HTMLAttributes<HTMLSpanElement>, Omit<VariantProps<typeof stepperIndicatorVariants>, "state">

Prop	Type	Default	Description
`children`	`HTMLAttributes<HTMLSpanElement>["children"]`	—	Override the auto-rendered content (step number / check).

StepperTriggerProps

Extends ButtonHTMLAttributes<HTMLButtonElement>

No own props — see the extended type above for available props.