Back to Vant Weapp

Steps 步骤条

packages/steps/README.md

1.11.73.6 KB
Original Source

Steps 步骤条

介绍

用于展示操作流程的各个环节,让用户了解当前的操作在整体流程中的位置。

引入

app.jsonindex.json中引入组件,详细介绍见快速上手

json
"usingComponents": {
  "van-steps": "@vant/weapp/steps/index"
}

代码演示

基础用法

html
<van-steps steps="{{ steps }}" active="{{ active }}" />
javascript
Page({
  data: {
    steps: [
      {
        text: '步骤一',
        desc: '描述信息',
      },
      {
        text: '步骤二',
        desc: '描述信息',
      },
      {
        text: '步骤三',
        desc: '描述信息',
      },
      {
        text: '步骤四',
        desc: '描述信息',
      },
    ],
  },
});

自定义样式

可以通过 active-iconactive-color 属性设置激活状态下的图标和颜色。

html
<van-steps
  steps="{{ steps }}"
  active="{{ active }}"
  active-icon="success"
  active-color="#38f"
/>

自定义图标

可以通过 inactiveIconactiveIcon 属性分别设置每一项的图标。

html
<van-steps steps="{{ steps }}" active="{{ active }}" />
javascript
Page({
  data: {
    steps: [
      {
        text: '步骤一',
        desc: '描述信息',
        inactiveIcon: 'location-o',
        activeIcon: 'success',
      },
      {
        text: '步骤二',
        desc: '描述信息',
        inactiveIcon: 'like-o',
        activeIcon: 'plus',
      },
      {
        text: '步骤三',
        desc: '描述信息',
        inactiveIcon: 'star-o',
        activeIcon: 'cross',
      },
      {
        text: '步骤四',
        desc: '描述信息',
        inactiveIcon: 'phone-o',
        activeIcon: 'fail',
      },
    ],
  },
});

竖向步骤条

可以通过设置direction属性来改变步骤条的显示方式。

html
<van-steps
  steps="{{ steps }}"
  active="{{ active }}"
  direction="vertical"
  active-color="#ee0a24"
/>

API

Steps Props

参数说明类型默认值
active当前步骤number0
steps步骤配置集合,见下面配置项Step 配置项数组[]
direction显示方向,可选值为 horizontal verticalstringhorizontal
active-color激活状态颜色string#07c160
inactive-color未激活状态颜色string#969799
active-icon激活状态底部图标,可选值见 Icon 组件stringchecked
inactive-icon未激活状态底部图标,可选值见 Icon 组件string-

Events

事件名称说明回调参数
bind:click-step点击步骤时触发的事件event.detail:当前步骤的索引

外部样式类

类名说明
custom-class根节点样式类
desc-class描述信息样式类

Step 配置项

键名说明类型
text当前步骤名称string
desc当前步骤描述信息string
activeIcon当前步骤激活状态底部图标string
inactiveIcon当前步骤未激活状态底部图标,可选值见 Icon 组件string