Steps 步骤条

引导用户按照流程完成任务的导航条。

何时使用

当任务复杂或者存在先后关系时，将其分解成一系列步骤，从而简化任务。

API

基本用法

small



default



large

<template>
  small
  <br />
  <br />
  <f-steps :current="1" size="small">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
  <br />
  <br />
  default
  <br />
  <br />
  <f-steps :current="1">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
  <br />
  <br />
  large
  <br />
  <br />
  <f-steps :current="1" size="large">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
</template>

<script setup lang="ts"></script>

<style lang="scss" scoped></style>

自定义图标用法

<template>
  <f-steps :current="1">
    <f-step>
      <template #icon>
        <UserOutlined />
      </template>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~">
      <template #icon>
        <UserOutlined />
      </template>
    </f-step>
    <f-step title="未进行" description="description~">
      <template #icon>
        <UserOutlined />
      </template>
    </f-step>
    <f-step title="未进行" description="description~">
      <template #icon>
        <UserOutlined />
      </template>
    </f-step>
  </f-steps>
</template>

<script setup lang="ts">
import { UserOutlined } from '@ant-design/icons-vue'
</script>

<style lang="scss" scoped></style>

点状用法

<template>
  <f-steps progress-dot :current="1">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
</template>

<script setup lang="ts"></script>

<style lang="scss" scoped></style>

导航用法

<template>
  <f-steps type="navigation" v-model:current="current" isAllowClick>
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
</template>

<script setup lang="ts">
import { ref } from 'vue'
const current = ref(1)
</script>

<style lang="scss" scoped></style>

箭头用法

<template>
  <f-steps type="arrow" :current="1">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
</template>

<script setup lang="ts"></script>

<style lang="scss" scoped></style>

垂直用法

<template>
  <f-steps direction="vertical" :current="1">
    <f-step>
      <template #title>已完成</template>
      <template #description>
        <span>description~</span>
      </template>
    </f-step>
    <f-step title="进行中" description="description~" />
    <f-step title="未进行" description="description~" />
    <f-step title="未进行" description="description~" />
  </f-steps>
</template>

<script setup lang="ts"></script>

<style lang="scss" scoped></style>

Steps

整体步骤条。

参数	说明	类型	默认值	版本
current (v-model)	指定当前步骤，从 0 开始记数。在子 Step 元素中，可以通过 status 属性覆盖状态, 1.5.0 后支持 v-model	number	0
direction	指定步骤条方向。目前支持水平（horizontal）和竖直（vertical）两种方向	string	horizontal
initial	起始序号，从 0 开始记数	number	0
labelPlacement	指定标签放置位置，默认水平放图标右侧，可选vertical放图标下方	string	horizontal
percent	当前 process 步骤显示的进度条进度（只对基本类型的 Steps 生效）	number	-	3.0
progressDot	点状步骤条，可以设置为一个 作用域插槽,labelPlacement 将强制为vertical	Boolean or v-slot:progressDot="{index, status, title, description, prefixCls, iconDot}"	false
responsive	当屏幕宽度小于 532px 时自动变为垂直模式	boolean	true	3.0
size(新)	指定大小，目前支持普通（default）和迷你（small），新增(large)	string	default
status	指定当前步骤的状态，可选 wait process finish error	string	process
type(新)	步骤条类型，有 default 和 navigation,arrow 3 种	string	default	1.5.0
isAllowClick(新)	是否有点击交互	boolean	false

注意

• type扩展了一个arrow字段。
• size扩展了一个large字段。
• isAllowClick为新增，UI 设计表明进度条仅表示状态，如需要点击相关交互，需额外配置isAllowClick=true属性,此属性仅限制样式未阻止点击事件。

Steps 事件

事件名称	说明	回调参数	版本
change	点击切换步骤时触发	(current) => void	-	1.5.0

Steps.Step

步骤条内的每一个步骤。

参数	说明	类型	默认值	版本
description	步骤的详情描述，可选	string | slot	-
disabled	禁用点击	boolean	false	1.5.0
icon	步骤图标的类型，可选	string | slot	-
status	指定状态。当不配置该属性时，会使用 Steps 的 current 来自动指定状态。可选：wait process finish error	string	wait
subTitle	子标题	string | slot	-	1.5.0
title	标题	string | slot	-