zhsw_wechat/miniprogram_npm/tdesign-miniprogram/switch/README.md

---

title: Switch 开关 description: 用于控制某个功能的开启和关闭。 spline: form

isComponent: true

引入

全局引入，在 miniprogram 根目录下的app.json中配置，局部引入，在需要引入的页面或组件的index.json中配置。

"usingComponents": {
  "t-switch": "tdesign-miniprogram/switch/switch"
}

代码演示

在开发者工具中预览效果

Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"

基础开关

{{ base }}

带描述开关

{{ label }}

自定义颜色

{{ color }}

开关状态

{{ status }}

尺寸

{{ size }}

API

Switch Props

名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- style | Object | - | 样式 | N custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N custom-value | Array | [true, false] | 用于自定义开关的值，[打开时的值，关闭时的值]。默认为 [true, false]。示例：[1, 0]、['open', 'close']。TS 类型：Array<SwitchValue> | N disabled | Boolean | undefined | 是否禁用组件。优先级：Switch.disabled > Form.disabled | N icon | Array | [] | 0.27.0。开关的图标；[打开时的图标，关闭时的图标]。TS 类型：string[] | N label | Array | [] | 0.27.0。开关的标签；[打开时的标签，关闭时的标签]。TS 类型：string[] | N loading | Boolean | false | 0.27.0。是否处于加载中状态 | N size | String | medium | 0.27.0。开关尺寸。可选项：small/medium/large | N value | String / Number / Boolean | null | 开关值。TS 类型：SwitchValue type SwitchValue = string \| number \| boolean。详细类型定义 | N default-value | String / Number / Boolean | undefined | 开关值。非受控属性。TS 类型：SwitchValue type SwitchValue = string \| number \| boolean。详细类型定义 | N

Switch Events

名称 | 参数 | 描述 -- | -- | -- change | (value: SwitchValue) | 数据发生变化时触发

CSS Variables

组件提供了下列 CSS 变量，可用于自定义样式。 名称 | 默认值 | 描述 -- | -- | -- --td-switch-checked-color | @brand-color | - --td-switch-checked-disabled-color | @brand-color-disabled | - --td-switch-dot-border-color | @bg-color-secondarycontainer | - --td-switch-dot-horizontal-margin | 6rpx | - --td-switch-dot-large-size | 52rpx | - --td-switch-dot-plain-horizontal-margin | 10rpx | - --td-switch-dot-plain-large-size | 44rpx | - --td-switch-dot-plain-size | 36rpx | - --td-switch-dot-plain-small-size | 28rpx | - --td-switch-dot-shadow | @shadow-1 | - --td-switch-dot-size | 44rpx | - --td-switch-dot-small-size | 36rpx | - --td-switch-height | 56rpx | - --td-switch-icon-large-size | 48rpx | - --td-switch-icon-size | 40rpx | - --td-switch-icon-small-size | 32rpx | - --td-switch-label-checked-color | @switch-checked-color | - --td-switch-label-color | @font-gray-4 | - --td-switch-label-font-size | 28rpx | - --td-switch-label-large-font-size | 32rpx | - --td-switch-label-small-font-size | 24rpx | - --td-switch-large-height | 64rpx | - --td-switch-large-radius | calc(@switch-large-height / 2) | - --td-switch-large-width | 104rpx | - --td-switch-radius | calc(@switch-height / 2) | - --td-switch-small-height | 48rpx | - --td-switch-small-radius | calc(@switch-small-height / 2) | - --td-switch-small-width | 78rpx | - --td-switch-unchecked-color | @font-gray-4 | - --td-switch-unchecked-disabled-color | @bg-color-component-disabled | - --td-switch-width | 90rpx | -