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.
Vertical
For side panels and long flows.
Props
Steps props
Progress through a known sequence: done, current and upcoming steps.
| Prop | Type | Default | Description |
|---|---|---|---|
currentrequired | Key | - | The step in progress (by id). Earlier steps show as done. |
stepsrequired | Step[] | - | The steps: id, title, optional description. |
aria-label | string | - | Name of the list. Default "Progress". |
className | string | - | 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
| Key | Does |
|---|---|
| Tab | Moves to the steps you can go back to |
| Enter | Goes 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.