Switch 开关

表示两种相互对立的状态间的切换。

基础用法

绑定 v-model 到一个 Boolean 类型的变量。 CSS 变量 --el-switch-on-color--el-switch-off-color 决定了两种状态下的背景颜色。

尺寸

开启

开启

开启

文字描述

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

可以使用 active-text 属性与 inactive-text 属性来设置开关的文字描述。

按月付费

按月付费

Y
超出省略
完整展示多个内容

自定义图标

提示

使用 active-iconinactive-icon 属性来添加图标。 你可以传递组件名称的字符串(需提前注册)或者组件本身(SVG Vue 组件)。 Element Plus 提供了一套图标,你可以在 icon 页面找到。

你可以使用 active-iconinactive-icon 属性来显示图标。 使用 inline-prompt 属性来控制图标是否显示在圆点内部。


扩展的类型

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

禁用状态

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

加载状态

设置 loading 属性为 true 表示开关处于加载状态。

阻止切换

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

自定义动作图标 2.3.9

你可以通过 active-action-iconinactive-action-icon 属性来显示图标。

自定义动作插槽 2.4.4

你可以使用 active-actioninactive-action 插槽来自定义动作内容。

T

API

属性

名称描述类型默认值
model-value / v-model绑定值,应等于 active-valueinactive-value,默认类型为 booleanboolean / string / numberfalse
disabled是否禁用booleanfalse
加载中是否处于加载状态booleanfalse
size开关的大小枚举''
width开关的宽度number / string''
inline-prompt图标或文字是否显示在点内,文字只渲染第一个字符booleanfalse
active-iconon 状态下显示的图标组件,会覆盖 active-textstring / Component
inactive-iconoff 状态下显示的图标组件,会覆盖 inactive-textstring / Component
active-action-icon 2.3.9on 状态下动作中显示的图标组件string / Component
inactive-action-icon 2.3.9off 状态下动作中显示的图标组件string / Component
active-texton 状态下显示的文字string''
inactive-textoff 状态下显示的文字string''
active-valueon 状态下的开关值boolean / string / numbertrue
inactive-valueoff 状态下的开关值boolean / string / numberfalse
名称开关的 input namestring''
validate-event是否触发表单验证booleantrue
before-change开关状态改变前的钩子。 如果返回 false 或者返回 Promise 且被 reject,则停止切换Function
idinput 的 idstring
tabindex输入框的 tabindexstring / number
aria-label a11y 2.7.2与原生输入框的 `aria-label` 相同string
active-color 已弃用on 状态下的背景颜色(请改用 CSS 变量 --el-switch-on-colorstring''
inactive-color 已弃用off 状态下的背景颜色(请改用 CSS 变量 --el-switch-off-colorstring''
border-color 已弃用开关的边框颜色(请改用 CSS 变量 --el-switch-border-colorstring''
label a11y 已废弃与原生输入框的 `aria-label` 相同string

事件

名称描述类型
change当绑定值改变时触发Function

Switch 插槽

名称描述
active-action 2.4.4自定义开启状态的动作
inactive-action 2.4.4自定义关闭状态的动作
active 2.13.0自定义开启状态的内容
inactive 2.13.0自定义关闭状态的内容

暴露

方法描述类型
focus手动聚焦开关组件Function

来源

组件源码样式源码文档源码

贡献者