mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Dean from Mintlify
1aaae5f9bf
* Update accordions.mdx * add snippet for icons * use icon snippet for consistency * add required/optional icon snippets * update for required/optional --------- Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
66 lines
1.8 KiB
Plaintext
66 lines
1.8 KiB
Plaintext
---
|
|
title: "Steps"
|
|
description: "Sequence content using the Steps component"
|
|
icon: "list-todo"
|
|
---
|
|
|
|
import IconsOptional from "/snippets/icons-optional.mdx";
|
|
|
|
Use steps to display a series of sequential actions or events. You can add as many steps as needed.
|
|
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
|
|
```mdx Steps example
|
|
<Steps>
|
|
<Step title="First Step">
|
|
These are instructions or content that only pertain to the first step.
|
|
</Step>
|
|
<Step title="Second Step">
|
|
These are instructions or content that only pertain to the second step.
|
|
</Step>
|
|
<Step title="Third Step">
|
|
These are instructions or content that only pertain to the third step.
|
|
</Step>
|
|
</Steps>
|
|
```
|
|
|
|
## Steps properties
|
|
|
|
<ResponseField name="children" type="ReactElement<StepProps>[]" required>
|
|
A list of `Step` components.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, and `h3`.
|
|
</ResponseField>
|
|
|
|
## Individual step properties
|
|
|
|
<ResponseField name="children" type="string | ReactNode" required>
|
|
The content of a step either as plain text or components.
|
|
</ResponseField>
|
|
|
|
<IconsOptional />
|
|
|
|
<ResponseField name="title" type="string">
|
|
The title is the primary text for the step and shows up next to the indicator.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="stepNumber" type="number">
|
|
The number of the step.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="titleSize" type="string" default="p">
|
|
The size of the step titles. One of `p`, `h2`, and `h3`.
|
|
</ResponseField>
|