Skip to content
Alea0.1

Navigation

Steps

Progress through a known sequence: done, current and upcoming steps, horizontal or vertical.

Ant Design: Steps

import { Steps } from '@alea/ui';

Examples

Steps

Done steps can be revisited with onStepPress.

  1. PlanLab Pro yearly
  2. PayCard or PayPal

Vertical

For side panels and long flows.

  1. Pick a colorYour brand purple (done)
  2. Choose a systemTailwind, Material or Radix
  3. Apply to Figma

Props

Steps props

Progress through a known sequence: done, current and upcoming steps.

PropTypeDefaultDescription
currentrequiredKey-The step in progress (by id). Earlier steps show as done.
stepsrequiredStep[]-The steps: id, title, optional description.
aria-labelstring-Name of the list. Default "Progress".
classNamestring-Extra class names for the root element.
onStepPress((id: Key) => void)-Lets people jump back to finished steps.
orientation"horizontal" | "vertical"'horizontal'horizontal (default) or vertical.

Accessibility

  • An ordered list; the current step has aria-current="step" and done steps say so.

Keyboard

KeyDoes
TabMoves to the steps you can go back to
EnterGoes to that step (with onStepPress)

Do and don't

Do

  • Name steps by what happens: Account, Plan, Pay.

Don't

  • Don't use for more than six steps.
Tested with axe, keyboard and screen reader roles