步进
一个垂直的阶梯,使一个阶梯列表具有可选的分阶级别. 它可以起到进度跟踪器的作用,完成的步子会带出一个勾子,而即将到来的步子会变哑;也可以起静态的步子列表来解释一行.
安装
npm install @cleartrip/ct-design-stepper
# or
pnpm add @cleartrip/ct-design-stepper
同伴依赖关系
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
使用量
作为进度跟踪器
activeStep 标记焦点的步骤 workflowStep 使完成.
import { Stepper } from '@cleartrip/ct-design-stepper';
function Example() {
return (
<Stepper
steps={[{ label: 'Request booking' }, { label: 'Approval' }, { label: 'Book' }]}
activeStep={1}
workflowStep={1}
/>
);
}
作为静态列表
isStatic 使每个步骤都具有同样的中性,而忽略了进度指数,因为这些步骤解释了一种流动而不是跟踪.
<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' },
]}
/>
有分步骤
子步骤只在目前活动的步骤下扩展.
<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属性
- 用屏幕读取器测试以确保可用性