Skip to content

LimeSteps 步骤条组件

一个功能丰富的步骤条组件,用于展示流程进度。支持横向和纵向布局、自定义状态、主题定制等多种配置,可用于展示订单流程、任务进度等多种场景。组件提供了丰富的自定义选项,可以满足各种复杂的界面设计需求。

插件依赖:lime-sharedlime-style

文档链接

📚 组件详细文档请访问以下站点:

安装方法

  1. 在uni-app插件市场入口 中搜索并导入lime-steps
  2. 导入后可能需要重新编译项目
  3. 在页面中使用l-stepsl-step组件

注意🔔

本插件依赖的【lime-svg】是原生插件,如果购买(收费为6元)则需要自定义基座,才能使用, 若不需要删除即可

代码演示

基础

current 属性表示当前步骤的索引,从 0 起计。

html
<l-steps :current="current" @change="change">
	<l-step title="买家下单" content="辅助信息"></l-step>
	<l-step title="商家接单" content="辅助信息"></l-step>
	<l-step title="买家提货" content="辅助信息"></l-step>
	<l-step title="交易完成" content="辅助信息"></l-step>
</l-steps>
js
const current = ref(1);
const change = (value : number) => {
	current.value = value;
}

图标

通过 icon 属性设置图标

html
<l-steps :current="current" @change="change">
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息"></l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

图标

通过 type 属性设置dot 可以小圆点的简略模式。

html
<l-steps :current="current"  type="dot" @change="change">
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息"></l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

状态

通过status属性设置状态, 共支持 4 种状态:未完成(wait)、已完成(finish)、进行中(process)、错误(error)。

html
<l-steps :current="current"  @change="change">
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息" status="error"></l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

自定义样式

通过activeColor属性设置当前激活色,finishBgColor可以设置完成的背景色。

html
<l-steps :current="current"  @change="change" activeColor="#FFB400" finishBgColor="rgba(255, 180, 0, 0.1)">
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息"></l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

竖向步骤条

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

html
<l-steps :current="current"  @change="change" layout="vertical" >
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息"></l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

竖向自定义内容

可以通过 extra 插槽可自定义额外内容。

html
<l-steps :current="current"  @change="change" layout="vertical" >
	<l-step icon="cart" title="买家下单" content="辅助信息"></l-step>
	<l-step icon="cart" title="商家接单" content="辅助信息">
		<template #extra>
			<view>
				<image
					src="https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*P0S-QIRUbsUAAAAAAAAAAABkARQnAQ"
					alt="图标"
					style="width: 100%;"
					mode="widthFix"/>
			</view>
		</template>
	</l-step>
	<l-step icon="cart" title="买家提货" content="辅助信息"></l-step>
	<l-step icon="cart" title="交易完成" content="辅助信息"></l-step>
</l-steps>

快速预览

导入插件后,可以直接使用以下标签查看演示效果:

html
<!-- 代码位于 uni_modules/lime-steps/components/lime-steps -->
<lime-steps />

插件标签说明

标签名说明
l-steps步骤条组件标签
l-step步骤组件标签
lime-steps演示标签

Vue2使用说明

main.js中添加以下代码:

js
// vue2项目中使用
import Vue from 'vue'
import VueCompositionAPI from '@vue/composition-api'
Vue.use(VueCompositionAPI)

详细配置请参考官方文档:Vue Composition API

API文档

steps Props 属性

属性名说明类型默认值
current当前步骤number-
value自定义步骤值number-
modelValue受控属性number-
defaultCurrent默认当前步骤number-
status当前步骤状态string'process'
layout布局方向string'horizontal'
readonly是否只读booleanfalse
sequence步骤顺序string'positive'
type步骤条风格string'default'
activeColor激活状态颜色string-
finishBgColor完成状态背景色string-
waitColor等待状态颜色string-
waitBgColor等待状态背景色string-

Steps Events

事件名说明回调参数
change当前步骤发生变化时触发index: number

step Props

属性名说明类型默认值
content步骤描述string-
icon图标名称string-
title标题string-
titleRight标题右侧信息string-
status步骤状态string'wait'

Step Slots

名称说明
icon图标status
title标题-
content步骤描述-
extra额外-

主题定制

组件提供了以下CSS变量,可用于自定义样式:

变量名称默认值描述
--l-step-dot-size8px点状步骤条的大小
--l-step-circle-size22px圆形步骤条的大小
--l-step-circle-font-size$font-size圆形步骤条的字体大小
--l-step-circle-icon-size$font-size-md圆形步骤条的图标大小
--l-step-description-color$text-color-3步骤描述文字颜色
--l-step-wait-circle-bg-color$gray-1等待状态背景色
--l-step-wait-circle-color$text-color-3等待状态文字颜色
--l-step-wait-title-color$text-color-3等待状态标题颜色
--l-step-wait-icon-color$text-color-3等待状态图标颜色
--l-step-wait-dot-border-color$gray-4等待状态点状边框颜色
--l-step-process-circle-colorwhite进行中状态文字颜色
--l-step-process-circle-bg-color$primary-color进行中状态背景色
--l-step-process-title-color$primary-color进行中状态标题颜色
--l-step-process-icon-color$primary-color进行中状态图标颜色
--l-step-process-dot-border-color$primary-color进行中状态点状边框颜色
--l-step-finish-circle-color$primary-color完成状态文字颜色
--l-step-finish-circle-bg-color$primary-color-1完成状态背景色
--l-step-finish-title-color$text-color-1完成状态标题颜色
--l-step-finish-icon-color$primary-color完成状态图标颜色
--l-step-finish-dot-border-color$primary-color完成状态点状边框颜色
--l-step-error-circle-color$error-color错误状态文字颜色
--l-step-error-circle-bg-color$error-color-1错误状态背景色
--l-step-error-title-color$error-color错误状态标题颜色
--l-step-error-icon-color$error-color错误状态图标颜色
--l-step-error-dot-border-color$error-color错误状态点状边框颜色
--l-step-line-color$gray-4步骤条连接线颜色
--l-step-finish-line-color$primary-color完成状态连接线颜色

支持与赞赏

如果你觉得本插件解决了你的问题,可以考虑支持作者:

支付宝赞助微信赞助

源代码

组件源码