> ## Documentation Index
> Fetch the complete documentation index at: https://adminroletesting-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 步骤

> 使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。

使用步骤来展示一系列按顺序进行的操作或事件。你可以根据需要添加任意多的步骤。

<Steps>
  <Step title="第一步">
    以下仅适用于第一步的说明或内容。
  </Step>

  <Step title="第二步">
    以下仅适用于第二步的说明或内容。
  </Step>

  <Step title="第三步">
    以下仅适用于第三步的说明或内容。
  </Step>
</Steps>

```mdx Steps example theme={null}
<Steps>
  <Step title="第一步">
    以下仅适用于第一步的说明或内容。
  </Step>
  <Step title="第二步">
    以下仅适用于第二步的说明或内容。
  </Step>
  <Step title="第三步">
    以下仅适用于第三步的说明或内容。
  </Step>
</Steps>
```

<div id="steps-properties">
  ## Steps 属性
</div>

<ResponseField name="children" type="ReactElement<StepProps>[]" required>
  `Step` 组件列表。
</ResponseField>

<ResponseField name="titleSize" type="string" default="p">
  步骤标题的字号。可选值为 `p`、`h2`、`h3` 和 `h4`。
</ResponseField>

<div id="individual-step-properties">
  ## 单个步骤属性
</div>

<ResponseField name="title" type="string" required>
  标题是该步骤的主要文本，显示在指示器旁边。
</ResponseField>

<ResponseField name="children" type="string | ReactNode">
  步骤的内容，可以是纯文本或组件。
</ResponseField>

<ResponseField name="icon" type="string">
  要显示的图标。

  可选值：

  * [Font Awesome](https://fontawesome.com/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `fontawesome`)
  * [Lucide](https://lucide.dev/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `lucide`)
  * [Tabler](https://tabler.io/icons) 图标名称 (如果你在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `tabler`)
  * 指向外部托管图标的 URL
  * 项目中图标文件的路径
  * 用花括号包裹的 SVG 代码

  对于自定义 SVG 图标：

  1. 使用 [SVGR 转换器](https://react-svgr.com/playground/) 转换你的 SVG。
  2. 将 SVG 代码粘贴到 SVG 输入框。
  3. 从 JSX 输出框中复制完整的 `<svg>...</svg>` 元素。
  4. 用花括号包裹可用于 JSX 的 SVG 代码：`icon={<svg ...> ... </svg>}`。
  5. 根据需要调整 `height` 和 `width`。
</ResponseField>

<ResponseField name="iconType" type="string">
  [Font Awesome](https://fontawesome.com/icons) 的图标样式。仅在使用 Font Awesome 图标时生效。

  可选值：`regular`、`solid`、`light`、`thin`、`sharp-solid`、`duotone`、`brands`。
</ResponseField>

<ResponseField name="stepNumber" type="number">
  步骤编号。
</ResponseField>

<ResponseField name="titleSize" type="string" default="p">
  步骤标题的字号。可选值为 `p`、`h2`、`h3` 和 `h4`。
</ResponseField>

<ResponseField name="id" type="string">
  步骤的自定义 ID，用于锚点链接和目录导航。
</ResponseField>

<ResponseField name="noAnchor" type="boolean" default="false">
  是否隐藏该步骤的锚点链接。
</ResponseField>