步骤流程
展示多步骤任务的当前位置和完成情况。允许跳转与校验规则由业务决定,当前步骤、完成步骤和失败步骤不要混淆;移动端检查竖向呈现。
随附图标许可
源码查看器包含 ICON_ATTRIBUTION.md,以及本组示例实际使用的图标集合原始许可。再分发示例时请保留;react-icons 封装包的许可证不能替代各图标集合自身的条款。
- Lucide: ISC
安装与初始化
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
渲染前配置 ChakraProvider、defaultSystem 和 Emotion。保留宿主项目的 React 版本并检查 peer 兼容。官方 npm 安装提供组件包,不会复制以下示例源码。locale、next-themes 和框架专属 SSR 配置见资源安装指南;npm 安装之外还需单独复制所选示例源码。
完整原生使用示例
这是固定版本的真实示例,不是通用 API 伪代码。复制完整源码依赖并保留命名导出;附加依赖逐例列在下方。
import { Button, ButtonGroup, Steps } from "@chakra-ui/react"
export const StepsBasic = () => {
return (
<Steps.Root defaultStep={1} count={steps.length}>
<Steps.List>
{steps.map((step, index) => (
<Steps.Item key={index} index={index} title={step.title}>
<Steps.Indicator />
<Steps.Title>{step.title}</Steps.Title>
<Steps.Separator />
</Steps.Item>
))}
</Steps.List>
{steps.map((step, index) => (
<Steps.Content key={index} index={index}>
{step.description}
</Steps.Content>
))}
<Steps.CompletedContent>All steps are complete!</Steps.CompletedContent>
<ButtonGroup size="sm" variant="outline">
<Steps.PrevTrigger asChild>
<Button>Prev</Button>
</Steps.PrevTrigger>
<Steps.NextTrigger asChild>
<Button>Next</Button>
</Steps.NextTrigger>
</ButtonGroup>
</Steps.Root>
)
}
const steps = [
{
title: "Step 1",
description: "Step 1 description",
},
{
title: "Step 2",
description: "Step 2 description",
},
{
title: "Step 3",
description: "Step 3 description",
},
]
全部示例与复现要求
示例名称用于选择演示,不是组件通用 variant 属性。复制所选示例全部 sourceFiles;compositions 别名表示本地文件,不是 npm 包。保留相对导入或映射到宿主真实目录。React peer 单独检查;编辑器示例保留一致的固定 Tiptap 扩展版本。
基础用法
steps-basic · 命名导出 StepsBasic · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-basic.tsx
不同尺寸
steps-with-sizes · 命名导出 StepsWithSizes · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-sizes.tsx
不同变体
steps-with-variants · 命名导出 StepsWithVariants · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-variants.tsx
不同颜色
steps-with-colors · 命名导出 StepsWithColors · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-colors.tsxvendor/apps/compositions/src/lib/color-palettes.ts
触发器
steps-with-trigger · 命名导出 StepsWithTrigger · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-trigger.tsx
垂直
steps-vertical · 命名导出 StepsVertical · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-vertical.tsx
受控状态
steps-controlled · 命名导出 StepsControlled · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-controlled.tsx
校验
steps-with-validation · 命名导出 StepsWithValidation · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-validation.tsx
外部状态仓库
steps-with-store · 命名导出 StepsWithStore · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-store.tsx
图标
steps-with-icon · 命名导出 StepsWithIcon · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0 react-icons@5.6.0
vendor/apps/compositions/src/examples/steps-with-icon.tsx
说明
steps-with-description · 命名导出 StepsWithDescription · 上游原始示例
npm install @chakra-ui/react@3.37.0 @emotion/react@11.14.0
vendor/apps/compositions/src/examples/steps-with-description.tsx
原生 API 与源码参考
源码查看器保留原始声明、import 与继承关系。Ark UI 事件契约、Chakra 样式属性和 recipe 类型仍以原生包为准;本指南不平铺或编造默认值。代码注释保留原文,不冒充正文翻译。
npm/@chakra-ui/react@3.37.0/dist/types/components/steps/index.d.tsnpm/@chakra-ui/react@3.37.0/dist/types/components/steps/namespace.d.tsnpm/@chakra-ui/react@3.37.0/dist/types/components/steps/steps.d.ts
状态与安装后检查
执行严格类型检查、目标项目生产构建和实际操作。检查名称/焦点/键盘、深浅色、窄屏、原生支持的空/加载/错误状态以及卸载清理。预览限制远程接口、上传与下载,业务服务需自行配置。复制命令或预览就绪不代表安装完成或后端成功。
来源与许可边界
https://github.com/chakra-ui/chakra-ui/tree/2e7517745cff2fcde0b8012f136cf99611ff262a
本页是 JGuang 双语实用说明,不声称全文翻译上游 MDX。原始文档与示例字节保留在 vendor。保留仓库 MIT、compositions 的 ISC 元数据和独立依赖声明;原始许可元数据差异与缺失完整声明仍作为显式审查事项,不包含 Chakra Pro 付费内容。