Switch 开关

用于切换两种对立状态。

基础用法

v-model 绑定到一个 Boolean 类型的变量。 你可以使用 --el-switch-on-color--el-switch-off-color CSS 变量来设置两种状态的背景色。

尺寸

打开

打开

打开

文字描述

使用 active-textinactive-text 属性来添加文本描述。 使用 inline-prompt 属性来控制文本是否显示在圆点内。

使用 active-textinactive-text 属性来添加文本描述。

按月付费

按月付费

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

自定义图标

提示

使用 active-iconinactive-icon 属性来添加图标。 您可以传入已预先注册的组件名称(字符串)或者 SVG Vue 组件本身。 Element Plus 提供了一组图标,您可以在 图标 找到它们。

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


扩展的值类型

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

禁用状态

添加 disabled 属性可禁用开关。

加载状态

loading 属性设置为 true,以表示开关正在加载中。

阻止切换

设置 before-change 属性。 如果返回 false 或返回一个被拒绝的 Promise,则将停止切换。

自定义操作图标 2.3.9

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

自定义操作插槽 2.4.4

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

API

属性

名称描述类型默认值
model-value / v-model绑定值,必须等于 `active-value` 或 `inactive-value`,默认为 `boolean` 类型布尔值 / 字符串 / 数字false
disabled开关是否被禁用booleanfalse
加载中开关是否处于加载状态booleanfalse
size开关的尺寸枚举''
width开关的宽度number / string''
内联提示图标或文本是否显示在圆点内,文本只渲染第一个字符booleanfalse
激活时的图标处于 `on` 状态时显示的图标组件,会覆盖 `active-text`string / Component
非激活时的图标处于 `off` 状态时显示的图标组件,会覆盖 `inactive-text`string / Component
激活时的操作图标 2.3.9处于 `on` 状态时操作中显示的图标组件string / Component
非激活时的操作图标 2.3.9处于 `off` 状态时操作中显示的图标组件string / Component
激活时的文本处于 `on` 状态时显示的文本string''
非激活时的文本处于 `off` 状态时显示的文本string''
激活时的值处于 `on` 状态时的开关值布尔值 / 字符串 / 数字true
非激活时的值处于 `off` 状态时的开关值布尔值 / 字符串 / 数字false
名称开关的输入框名称string''
validate-event是否触发表单验证booleantrue
切换前的钩子在开关状态改变前的钩子。 如果返回 `false` 或者返回一个被拒绝的 `Promise`,则将停止切换Function
id输入框的 idstring
tabindex输入框的 tabindexstring / number
aria-label a11y 2.7.2与原生输入框的 `aria-label` 相同string
激活时的颜色 已废弃处于 `on` 状态时的背景色 ( 使用 CSS 变量 `--el-switch-on-color` 替代 )string''
非激活时的颜色 已废弃处于 `off` 状态时的背景色 ( 使用 CSS 变量 `--el-switch-off-color` 替代 )string''
边框颜色 已废弃开关的边框颜色 ( 使用 CSS 变量 `--el-switch-border-color` 替代 )string''
label a11y 已废弃与原生输入框的 `aria-label` 相同string

事件

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

Switch 插槽

名称描述
激活时的操作 2.4.4自定义激活时的操作
非激活时的操作 2.4.4自定义非激活时的操作

暴露

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

来源

组件样式文档

贡献者