Skip to main content

switch

WdSwitch

Applicable Scenarios​

Used for controlling yes and no (Boolean value).

Basic Capabilities Description​

  1. Bind a field of type 'Boolean'. After the form container is bound to the data model, the Boolean values in the model are automatically rendered as switch components for yes/no control. The initial state of the switch (on/off) and the component size (effective on PC, not on mobile) can be configured.

  2. Supports personalized configuration of titles, including title content, alignment, whether to wrap (when enabled, wraps to the next line if title text exceeds one line; when disabled, truncates with ellipsis if title text exceeds one line), title position, width, and title tooltip.

  1. Supports personalized configuration of switch buttons, including tooltips below the switch buttons and whether to display underlines on mobile devices.

Note:

  • The size configuration of switch buttons only takes effect on PC.
  • If the component is within a form container, its size, title alignment, position, line wrapping, and width will inherit the form container's property configuration by default.

To learn more about usage scenarios for form components, refer to the Form Common Scenarios Practice Guide.

Example​

Interactive Preview​

Different Types of Switches​

Different Layouts of Switches​

Disabled State of Switch​

Switch Required Icon, Title Tooltip, Bottom Note, etc.​

Style API Custom Styles​

#wd-page-root .wd-form-item .wd-switch.is-checked .wd-switch__box {
  background-color: green;
}

Properties​

组件接收的外部传入的属性

属性名
属性标识
类型
说明
显示标题labelVisibleboolean

默认值：true

标题对齐labelAlignstring

表单场景下默认会跟随表单容器的标题对齐配置

标题换行labelWrapboolean

如果标题内容过长关闭时只显示一行、溢出省略；开启时换行展示。表单场景下默认会跟随表单容器的标题换行配置

标题位置layoutstring

设置标题在表单组件的展示位置，表单场景下默认会跟随表单容器的标题的位置配置

标题宽度labelWidthstring

您可以输入数值 + px、%等单位，示例：200px

表单场景下默认会跟随表单容器的标题宽度配置

标题提示labelTipsstring

PC/H5端生效

配置标题的工具提示内容

下方提示extrastring

配置后提示内容常显在组件下方

移动端显示下划线borderedH5boolean

关闭后移动端不显示底部下划线

示例：true

必填requiredboolean

启用后该组件强制必填，值不可为空

示例：false

必填标识requiredFlagboolean

启用后，组件若要求必填，则会显示必填星号标记

示例：true

必填校验提示requiredMsgstring

启用必填，但组件值为空时的提示信息

示例："该项为必填项"

状态statusstring

示例："edit"

绑定字段namestring

表单字段的Key值，用于提交数据时，匹配数据模型字段标识。页面内需保证唯一。

标题内容labelstring

示例："标题"

开关状态valueboolean

默认开关状态

示例：false

组件尺寸(PC端)sizestring

开关的尺寸大小，仅在PC端生效

示例：""

Events​

组件暴露的事件，可以监听组件的事件来触发一些外部的动作

事件名
事件code
事件出参 event.detail
适用情况
说明
值改变changeobject
  • value: boolean

    所选开关状态
兼容三端

-

Property API​

通过属性 API，可以获取组件内部的状态和属性值，可以通过$w.componentId.propertyName 来访问组件内部的值，如 $w.input1.value ，详请请参考 属性 API

只读属性名
属性标识
类型
说明
绑定字段namestring

表单字段的Key值，用于提交数据时，匹配数据模型字段标识。页面内需保证唯一。

标题内容labelstring
开关状态valueboolean

默认开关状态

必填requiredboolean

启用后该组件强制必填，值不可为空

是否展示visibleboolean

组件是否展示

是否禁用disabledboolean

组件是否禁用

是否只读readOnlyboolean

组件是否只读

Method API​

通过方法 API，可以通过程序触发组件内部的方法，比如提交表单，显示弹窗等, 可以通过$w.componentId.methodName来调用组件方法，如 $w.form1.submit()

方法名
方法标识
参数
方法说明
设置值setValueboolean值

通过 $w.id1.setValue("weda") 设置组件值

设置显隐setVisibleboolean显示

通过 $w.id1.setVisible(false) 设置组件为隐藏

设置禁用setDisabledboolean禁用

通过 $w.id1.setDisabled(true) 设置组件为禁用

清空值clearValue

通过 $w.id1.clearValue() 清空组件值

设置只读setReadOnlyboolean只读

通过 $w.id1.setReadOnly(true) 设置组件为只读

触发校验handleValidate

通过 $w.id1.handleValidate() 校验组件值

清除校验clearValidate

通过 $w.id1.clearValidate() 清除组件校验

Style API​

通过样式 API，可以覆盖组件中内部元素的样式来实现自定义，例如在低代码编辑器中中通过 #wd-page-root .wd-btn 即可为所有的按钮组件编写样式，通过 :scope 可以控制单个组件样式， 详细说明请参考样式 API

名称
类名
说明和示例
根元素.wd-switch-root组件最外层元素
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-switch-root {
  /* 在这里编写CSS 样式 */
}
H5 端根元素.wd-h5-switch-root可设定 H5 端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-h5-switch-root {
  /* 在这里编写CSS 样式 */
}
PC 端根元素.wd-pc-switch-root可设定 PC 端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-pc-switch-root {
  /* 在这里编写CSS 样式 */
}
小程序端根元素.wd-mp-switch-root可设定小程序端的根元素样式
/* :scope 指的是当前组件元素 */
/* 具体可参考样式 API 文档 */
:scope.wd-mp-switch-root {
  /* 在这里编写CSS 样式 */
}
组件标题样式.wd-switch-root .wd-form-item-wrap__label组件标题元素

:scope .wd-form-item-wrap__label {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
表单控件根节点样式.wd-switch-root .wd-form-item-wrap__control设置表单控件根元素样式

:scope .wd-form-item-wrap__control {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
编辑态-按钮选中样式.wd-switch-root .is-checked .wd-switch__box::before编辑态-按钮选中样式

      :scope .is-checked .wd-switch__box::before {
        background-color: red;
      }
编辑态-按钮未选中样式.wd-switch-root .wd-switch__box::before编辑态-按钮未选中样式

      :scope .wd-switch__box::before {
        background-color: gray;
      }
编辑态-校验信息.wd-switch-root .wd-g-text-error设置组件校验信息样式

:scope .wd-g-text-error {
    font-size: 20px;
    color: gray;
  }
提示文字.wd-switch-root .wd-form-item__help-text设置组件提示文字样式

:scope .wd-form-item__help-text {
    font-size: 20px;
    color: gray;
  }
禁用态-按钮选中样式.wd-switch-root .is-disabled.is-checked .wd-switch__box::before禁用态-按钮选中样式

      :scope .is-disabled.is-checked .wd-switch__box::before {
        background-color: red;
      }
禁用态-按钮未选中样式.wd-switch-root .is-disabled .wd-switch__box::before禁用态-按钮未选中样式

      :scope .is-disabled .wd-switch__box::before {
        background-color: gray;
      }
只读态-按钮选中样式.wd-switch-root .is-readonly.is-checked .wd-switch__box::before只读态-按钮选中样式

      :scope .is-readonly.is-checked .wd-switch__box::before {
        background-color: red;
      }
只读态-按钮未选中样式.wd-switch-root .is-readonly .wd-switch__box::before只读态-按钮未选中样式

      :scope .is-readonly .wd-switch__box::before {
        background-color: gray;
      }

了解样式 API

Version Changes​

  • Property changes
  • Style changes
  • widget api changes