Skip to content

Switch 开关

表示两种相互对立的状态间的切换,多用于触发「开/关」。

基础用法

绑定 v-model 到一个 Boolean 类型的变量。 active-colorinactive-color 属性来设置开关的背景色。

尺寸

提供 largedefaultsmall 三种尺寸。

文字描述

使用 active-text 属性与 inactive-text 属性来设置开关的文字描述。 使用 inline-prompt 属性来使文字显示在开关内部。

扩展的 value 类型

你可以设置 active-valueinactive-value 属性,它们接受 BooleanStringNumber 类型的数据。

禁用状态

设置 disabled 属性,接受一个 Boolean,设置 true 即可禁用。

加载状态

设置 loading 属性,接受一个 Boolean,设置 true 即加载中状态。

阻止切换

设置 before-change 属性,若返回 false 或者返回 Promise 且被 reject,则停止切换。

API

Attributes

属性名说明类型默认值
v-model / model-value绑定值boolean / string / numberfalse
disabled是否禁用booleanfalse
loading是否处于加载中状态booleanfalse
size开关的尺寸stringdefault
width开关的宽度(像素)string / number
active-iconswitch 打开时所显示图标的组件名,设置此项会忽略 active-textstring
inactive-iconswitch 关闭时所显示图标的组件名,设置此项会忽略 inactive-textstring
active-textswitch 打开时的文字描述string
inactive-textswitch 关闭时的文字描述string
active-valueswitch 打开时的值boolean / string / numbertrue
inactive-valueswitch 关闭时的值boolean / string / numberfalse
active-colorswitch 打开时的背景色string
inactive-colorswitch 关闭时的背景色string
nameswitch 对应的 name 属性string
validate-event改变 switch 状态时是否触发表单的校验booleantrue
before-changeswitch 状态改变前的钩子, 返回 false 或者返回 Promise 且被 reject 则停止切换function
inline-prompt无论图标或文本是否显示在开关内部booleanfalse

Events

事件名说明回调参数
changeswitch 状态发生变化时的回调函数val: 新状态的值
inputswitch 状态发生变化时的回调函数val: 新状态的值