1.0.5 • Published 1 month ago

@tanzhenxing/zx-steps v1.0.5

Weekly downloads
-
License
ISC
Repository
-
Last release
1 month ago

zx-steps 步骤条组件

基于 Element Plus Steps 组件设计的 uni-app 步骤条组件,支持 H5、小程序和 App,不依赖浏览器特有的 DOM。

特性

  • ✅ 基础步骤导航
  • ✅ 多种显示方向(水平/垂直)
  • ✅ 居中对齐
  • ✅ 带描述文案
  • ✅ 带图标的步骤
  • ✅ 简洁风格
  • ✅ 多种状态(等待/处理中/完成/错误/成功)
  • ✅ 自定义间距
  • ✅ 可定制主题
  • ✅ 支持插槽自定义
  • ✅ 跨端兼容

安装方法

将组件复制到项目的 components 目录中即可使用。

基础用法

<template>
  <zx-steps :active="active" finish-status="success">
    <zx-step title="步骤 1"></zx-step>
    <zx-step title="步骤 2"></zx-step>
    <zx-step title="步骤 3"></zx-step>
  </zx-steps>
  <button @click="next">下一步</button>
</template>

<script setup>
import { ref } from 'vue';
import ZxSteps from '@/components/zx-steps/zx-steps.vue';
import ZxStep from '@/components/zx-steps/zx-step.vue';

const active = ref(0);

const next = () => {
  active.value = (active.value + 1) % 4;
};
</script>

含状态的步骤条

<template>
  <zx-steps :active="1" :space="200" finish-status="success">
    <zx-step title="已完成"></zx-step>
    <zx-step title="处理中"></zx-step>
    <zx-step title="步骤 3"></zx-step>
  </zx-steps>
</template>

居中的步骤条

<template>
  <zx-steps :active="2" align-center>
    <zx-step title="步骤 1" description="这是一段描述文字"></zx-step>
    <zx-step title="步骤 2" description="这是一段描述文字"></zx-step>
    <zx-step title="步骤 3" description="这是一段描述文字"></zx-step>
  </zx-steps>
</template>

带描述的步骤条

<template>
  <zx-steps :active="1">
    <zx-step title="步骤 1" description="这里是步骤 1 的详细描述"></zx-step>
    <zx-step title="步骤 2" description="这里是步骤 2 的详细描述"></zx-step>
    <zx-step title="步骤 3" description="这里是步骤 3 的详细描述"></zx-step>
  </zx-steps>
</template>

带图标的步骤条

<template>
  <zx-steps :active="1">
    <zx-step title="步骤 1" icon="✏️"></zx-step>
    <zx-step title="步骤 2" icon="⬆️"></zx-step>
    <zx-step title="步骤 3" icon="🖼️"></zx-step>
  </zx-steps>
</template>

垂直的步骤条

<template>
  <view style="height: 300px;">
    <zx-steps direction="vertical" :active="active">
      <zx-step title="步骤 1" description="这是一段描述文字"></zx-step>
      <zx-step title="步骤 2" description="这是一段描述文字"></zx-step>
      <zx-step title="步骤 3" description="这是一段描述文字"></zx-step>
    </zx-steps>
  </view>
</template>

简洁风格的步骤条

<template>
  <zx-steps :active="1" simple>
    <zx-step title="步骤 1"></zx-step>
    <zx-step title="步骤 2"></zx-step>
    <zx-step title="步骤 3"></zx-step>
  </zx-steps>
</template>

API

ZxSteps Props

属性名说明类型默认值
active设置当前激活步骤Number0
direction显示方向,可选值为 horizontal 或 verticalStringhorizontal
space每个 step 的间距,支持百分比或像素值String/Number-
process-status设置当前步骤的状态,可选值为 wait/process/finish/error/successStringprocess
finish-status设置结束步骤的状态,可选值为 wait/process/finish/error/successStringfinish
align-center进行居中对齐Booleanfalse
simple是否应用简洁风格Booleanfalse

ZxSteps Slots

插槽名说明
default步骤组件(ZxStep)

ZxStep Props

属性名说明类型默认值
title标题String-
description描述文案String-
icon自定义图标String-
status设置当前步骤的状态,可选值为 wait/process/finish/error/successString-

ZxStep Slots

插槽名说明
icon自定义图标
title自定义标题
description自定义描述文案

注意事项

  1. 步骤条至少需要包含 2 个 zx-step 子组件
  2. active 属性从 0 开始计数
  3. 简洁模式下,align-center、description、direction、space 属性均无效
  4. 如需定制主题颜色,可修改组件样式中的相关颜色变量
1.0.5

1 month ago

1.0.4

2 months ago

1.0.3

2 months ago

1.0.2

12 months ago

1.0.1

1 year ago

1.0.0

1 year ago