<Steps> component both show a sequence, but they set different expectations.
Use <Steps> when the reader performs a sequence and each action needs explanation. Use a numbered list when the sequence is simple or describes what the system does.
When to use the steps component
Use<Steps> when:
- The reader performs each step.
- Each step needs code, substeps, decisions, or more context than a single list item can hold.
Example steps
When a numbered list is better
Use a numbered list when:- Each item fits in one or two lines.
- You’re listing things in a logical order, not guiding someone through a task.
- The content doesn’t need sub-elements like code blocks, images, or multiple lines of context.
Example descriptive numbered list
<Steps> component doesn’t help communicate the sequence.
Example procedural numbered list
The one-line step problem
A common misuse of the steps component is wrapping content without using the component’s full capabilities.Not the best use of steps
Better as a numbered list
Step titles matter
Readers scan step titles to understand the overall procedure. If you settitleSize to h2 or h3 on <Steps>, the titles also become headings on the page. A title like “Configure” is less helpful than “Configure your webhook endpoint.” The latter tells you exactly what the step is about.
Generally, start step titles with a verb and end with the specific thing being acted on.
- “Installation” → “Install project dependencies”
- “Analytics script” → “Add the analytics script to your layout”
- “Test” → “Test the connection”