Stepper

Usage

import { Stepper } from "@devvy-ui/react";

<Stepper label="Setup" current={1} steps={[{id:'profile',label:'Profile'},{id:'team',label:'Team'}]} />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
steps	{id,label,description?,href?,disabled?}[]	required	Ordered steps.
current	number	required	Current zero-based index.
onStepChange	(index: number) => void	—	Optional local navigation.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add stepper

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

Stepper.tsxREACT / TSX

import { forwardRef, type HTMLAttributes } from 'react';
import { safeURL } from '../lib/widgets';
export interface StepperProps extends HTMLAttributes<HTMLElement> {
  label: string;
  steps: readonly {
    id: string;
    label: string;
    description?: string;
    href?: string;
    disabled?: boolean;
  }[];
  current: number;
  onStepChange?: (index: number) => void;
}
export const Stepper = forwardRef<HTMLElement, StepperProps>(function Stepper(
  { label, steps, current, onStepChange, className, ...props },
  ref,
) {
  return (
    <nav
      {...props}
      ref={ref}
      aria-label={label}
      className={['dvy-stepper', className].filter(Boolean).join(' ')}
    >
      <ol>
        {steps.map((step, i) => (
          <li
            key={step.id}
            data-complete={i < current}
            aria-current={i === current ? 'step' : undefined}
          >
            {step.href && !step.disabled ? (
              <a href={safeURL(step.href)}>{step.label}</a>
            ) : onStepChange ? (
              <button type="button" disabled={step.disabled} onClick={() => onStepChange(i)}>
                {step.label}
              </button>
            ) : (
              <span>{step.label}</span>
            )}
            {step.description && <small>{step.description}</small>}
          </li>
        ))}
      </ol>
    </nav>
  );
});

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.