Skip to content

Commit d871931

Browse files
committed
update steps
1 parent cf88666 commit d871931

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

components/steps.mdx

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: 'Steps'
3-
description: 'Sequence content using the Steps component'
4-
icon: 'list-todo'
2+
title: "Steps"
3+
description: "Sequence content using the Steps component"
4+
icon: "list-todo"
55
---
66

7-
Use steps to display a series of sequential actions or events. You can add as many steps as needed for your workflow.
7+
Use steps to display a series of sequential actions or events. You can add as many steps as needed.
88

99
<Steps>
1010
<Step title="First Step">
@@ -18,9 +18,7 @@ Use steps to display a series of sequential actions or events. You can add as ma
1818
</Step>
1919
</Steps>
2020

21-
<RequestExample>
22-
23-
```mdx Steps Example
21+
```mdx Steps example
2422
<Steps>
2523
<Step title="First Step">
2624
These are instructions or content that only pertain to the first step.
@@ -34,40 +32,38 @@ Use steps to display a series of sequential actions or events. You can add as ma
3432
</Steps>
3533
```
3634

37-
</RequestExample>
38-
3935
## Steps properties
4036

4137
<ResponseField name="children" type="ReactElement<StepProps>[]" required>
42-
A list of `Step` components
38+
A list of `Step` components.
4339
</ResponseField>
4440

4541
<ResponseField name="titleSize" type="string" default="p">
46-
The size of the step titles. One of `p`, `h2`, and `h3`
42+
The size of the step titles. One of `p`, `h2`, and `h3`.
4743
</ResponseField>
4844

4945
## Individual step properties
5046

5147
<ResponseField name="children" type="string | ReactNode" required>
52-
The content of a step either as plain text or components
48+
The content of a step either as plain text or components.
5349
</ResponseField>
5450

5551
<ResponseField name="icon" type="string or svg">
56-
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide icon](https://lucide.dev/icons), or SVG code in `icon={}`
52+
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide icon](https://lucide.dev/icons), or SVG code in `icon={}`.
5753
</ResponseField>
5854

5955
<ResponseField name="iconType" type="string">
60-
One of `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`
56+
For Font Awesome icons only: One of `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
6157
</ResponseField>
6258

6359
<ResponseField name="title" type="string">
64-
The title is the primary text for the step and shows up next to the indicator
60+
The title is the primary text for the step and shows up next to the indicator.
6561
</ResponseField>
6662

6763
<ResponseField name="stepNumber" type="number">
68-
The number of the step
64+
The number of the step.
6965
</ResponseField>
7066

7167
<ResponseField name="titleSize" type="string" default="p">
72-
The size of the step titles. One of `p`, `h2`, and `h3`
68+
The size of the step titles. One of `p`, `h2`, and `h3`.
7369
</ResponseField>

0 commit comments

Comments
 (0)