# @cleartrip/ct-design-stepper 中文文档

规范地址：https://npmcn.com/package/%40cleartrip/ct-design-stepper/

版本：5\.13\.0
npm 元数据更新时间：2026-11-16T13:03:00.646Z
中文译文更新时间：2026-11-16T13:08:00.951Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cleartrip/ct-design-stepper
原文对照：https://npmcn.com/package/%40cleartrip/ct-design-stepper/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：113 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：react \>=16\.8\.0，react-dom \>=16\.8\.0，react-native \>=0\.68\.0
- 首次发布：2023-11-05T19:23:22.652Z
- 最新版本发布：2026-11-16T13:03:00.411Z
- 近 30 天下载量：12177（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：780（近 12 个月 365 个）

## 中文简介

步进组件

## 安装

```sh
npm install @cleartrip/ct-design-stepper
```

也可以使用：`pnpm add @cleartrip/ct-design-stepper`、`yarn add @cleartrip/ct-design-stepper`、`bun add @cleartrip/ct-design-stepper`

## README

# 步进

一个垂直的阶梯,使一个阶梯列表具有可选的分阶级别. 它可以起到进度跟踪器的作用,完成的步子会带出一个勾子,而即将到来的步子会变哑;也可以起静态的步子列表来解释一行.

* * *

## 安装

```bash
npm install @cleartrip/ct-design-stepper
# or
pnpm add @cleartrip/ct-design-stepper
```

### 同伴依赖关系

```bash
# Required for all targets
npm install react

# Web only
npm install react-dom

# React Native only
npm install react-native
```

* * *

## 使用量

### 作为进度跟踪器

`activeStep` 标记焦点的步骤 `workflowStep` 使完成.

```tsx
import { Stepper } from '@cleartrip/ct-design-stepper';

function Example() {
  return (
    <Stepper
      steps={[{ label: 'Request booking' }, { label: 'Approval' }, { label: 'Book' }]}
      activeStep={1}
      workflowStep={1}
    />
  );
}
```

### 作为静态列表

`isStatic` 使每个步骤都具有同样的中性,而忽略了进度指数,因为这些步骤解释了一种流动而不是跟踪.

```tsx
<Stepper
  isStatic
  steps={[
    { label: 'Request booking', subtitle: 'Pick a hotel and raise a request' },
    { label: 'Approval', subtitle: 'Your approver reviews the request' },
    { label: 'Book', subtitle: 'Complete the booking once approved' },
  ]}
/>
```

### 有分步骤

子步骤只在目前活动的步骤下扩展.

```tsx
<Stepper
  steps={[
    { label: 'Traveller details' },
    {
      label: 'Payment',
      hasChildren: true,
      subSteps: [{ label: 'Select mode' }, { label: 'Confirm' }],
    },
  ]}
  activeStep={1}
  workflowStep={1}
  activeSubStep={0}
  workflowSubStep={0}
/>
```

* * *

## 道具

| Prop | 类型 | 默认 | 需求 | 说明 |
| --- | --- | --- | --- | --- |
| `steps` | `IStepperStep[]` | `[]` | 对 | 步骤,从上到下. |
| `activeStep` | `number` | `0` | 没有 | 焦点步骤索引. |
| `activeSubStep` | `number` | `0` | 没有 | 主动步骤内焦点分步索引. |
| `workflowStep` | `number` | `0` | 没有 | 在本索引完成前的步骤. |
| `workflowSubStep` | `number` | `0` | 没有 | 在本索引完成之前的分步骤. |
| `isStatic` | `boolean` | `false` | 没有 | 渲染出每一步中和并忽略了进度指数. |
| `styleConfig` | `IStepperStyleConfig` | `{}` | 没有 | Root、行、图标、标签和垂直行的样式覆盖. |

### ISTEPERStep 系统

| 外地 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `label` | `string` | 对 | 台阶标签. |
| `subtitle` | `string` | 没有 | 标签下的副线. |
| `hasChildren` | `boolean` | 没有 | 当活动时步骤是否扩展为子步骤 . |
| `subSteps` | `IStepperSubStep[]` | 没有 | 分步骤,只在步骤活动时才被提供. |
| `onClick` | `() => void` | 没有 | 在按下步骤的图标或标签时被放出. |

* * *

## 步态

-   `DONE` 完成:有滴答的绿色圆形
-   `CURRENT` 重点:突出标签的圆形
-   `PENDING` — 即将到来: 圆形和标签
-   `NEUTRAL` ——无进展关系,被使用 `isStatic`

* * *

## 阶梯级

-   `OUTER` - 一个顶级步骤
-   `INNER` ——分步骤

* * *

## 无障碍

-   构成部分遵循无障碍最佳做法
-   确保在需要时提供适当的ARIA属性
-   用屏幕读取器测试以确保可用性

## 常见问题

### @cleartrip/ct-design-stepper 是什么？

步进组件

### 如何安装 @cleartrip/ct-design-stepper？

在项目目录运行 npm install @cleartrip/ct-design-stepper，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.0）、react-dom（\>=16\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cleartrip/ct-design-stepper 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cleartrip/ct-design-stepper 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cleartrip/ct-design-stepper 可以商用吗？

@cleartrip/ct-design-stepper 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cleartrip/ct-design-stepper 的下载量有多少？

根据 npm 官方下载统计，@cleartrip/ct-design-stepper 在 2026/10/10 – 2026/11/08 这 30 天内被下载 12,177 次，日均约 406 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cleartrip/ct-design-stepper 还在维护吗？

最新版本 5\.13\.0 发布于 2026/11/16（今天）；至今共发布 780 个版本，其中过去 12 个月发布了 365 个；首次发布于 2023/11/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

