• 简体中文
  • Steps 步骤条

    展示任务的进展和当前步骤。

    基础用法

    交互预览基础用法
    1. 创建项目填写基本信息
    2. 确认配置检查项目信息
    3. 完成开始使用
    basic.tsx
    import { Button, type StepItem, Steps } from '@sudden3/leaf-ui';
    import { useState } from 'react';
    
    const items: readonly StepItem[] = [
      { title: '创建项目', description: '填写基本信息' },
      { title: '确认配置', description: '检查项目信息' },
      { title: '完成', description: '开始使用' },
    ];
    export function StepsBasic() {
      const [current, setCurrent] = useState(1);
      return (
        <div className="leaf-demo-stack leaf-demo-stack--wide">
          <Steps items={items} current={current} onChange={setCurrent} />
          <div className="leaf-demo-row">
            <Button variant="outline" disabled={current === 0} onClick={() => setCurrent(current - 1)}>
              上一步
            </Button>
            <Button disabled={current === 2} onClick={() => setCurrent(current + 1)}>
              下一步
            </Button>
          </div>
          <Steps items={items} current={1} direction="vertical" status="error" size="sm" />
        </div>
      );
    }
    

    Steps API

    属性类型默认值说明
    itemsreadonly StepItem[]必填步骤列表
    currentnumber0当前步骤的索引,从 0 开始
    status'process' | 'finish' | 'error''process'当前步骤状态
    direction'horizontal' | 'vertical''horizontal'排列方向
    size'sm' | 'md' | 'lg''md'步骤尺寸
    loadingbooleanfalse当前步骤展示加载图标
    onChange(current: number) => void—设置后可点击步骤

    StepItem

    属性类型默认值说明
    keystring—稳定标识
    titleReactNode必填步骤名称
    descriptionReactNode—补充说明
    iconReactNode—自定义图标
    status'wait' | 'process' | 'finish' | 'error'—覆盖该步骤状态
    disabledbooleanfalse禁止点击该步骤

    类型

    定义组件属性或组装列表时可导入相关类型。

    import type { StepsProps, StepItem } from '@sudden3/leaf-ui';

    使用说明

    current 由应用维护;onChange 提供目标索引。未指定单项 status 时,会根据 current 自动显示已完成、进行中和等待状态。