Skip to content

Switch 开关

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

基础用法

绑定 v-model 到一个 Boolean 类型的变量。

开关类型

开关分为 circle 圆形(默认)、round 圆角两种类型。

开关主题

Switch 组件提供了五个不同的主题:outset、inset、bordered、outlined 和 flat。通过设置 effect 属性来改变主题,默认为 outset。

禁用状态

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

文字描述

使用 active-text 属性与 inactive-text 属性来设置开关的文字描述。使用 inline-prompt 属性来控制文本是否显示在点内。

关闭
开启

显示自定义图标

使用 inactive-icon 和 active-icon 属性来添加图标。 使用 inline-prompt 属性来控制图标显示在点内。

扩展的 value 类型

可以设置 active-value 和 inactive-value 属性, 接受 Boolean、String 或 Number 类型的值。

加载状态

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

阻止切换

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

开关尺寸

开关组件提供除了默认值 medium 以外的三种尺寸。额外的尺寸:large、small、mini,通过设置 size 属性来配置它们。

Switch API

Switch Attributes

参数名描述类型默认值
v-model绑定值,须等于 active-value 或 inactive-value,默认为 Boolean 类型Boolean String Numberfalse
disabled是否禁用Booleanfalse
loading是否显示加载中Booleanfalse
type开关类型Stringcircle
effect开关主题Stringoutset
size开关尺寸Stringmedium
width开关的宽度String Numberfalse
inline-prompt无论图标或文本是否显示在点内,只会呈现文本的第一个字符Booleanfalse
active-value开关打开的值Boolean String Numbertrue
inactive-value开关关闭的值Boolean String Numberfalse
active-icon开关打开时所显示图标,设置此项会忽略 active-textString Component-
inactive-icon开关关闭时所显示图标,设置此项会忽略 inactive-textString Component-
active-text开关打开时的文字描述String''
inactive-text开关关闭时的文字描述String''
name开关对应的 name 属性String''
validate-event开关状态改变时是否触发表单的校验Booleantrue
before-change开关状态改变前的钩子, 返回 false 或者返回 Promise 且被 reject 则停止切换Boolean Function-
idinput 的 idString-
tabindexinput 的 tabindexString Number-

Switch Events

事件名描述参数
change开关状态发生变化时的回调函数Function

Switch Exposes

参数名描述类型
focus手动 focus 到开关组件Function