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​

External properties received by the component

Property Name
Property Identifier
Type
Description
显示标题labelVisibleboolean

Default value: true

标题对齐labelAlignstring

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

标题换行labelWrapboolean

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

标题位置layoutstring

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

标题宽度labelWidthstring

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

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

标题提示labelTipsstring

PC/H5端生效

配置标题的工具提示内容

下方提示extrastring

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

移动端显示下划线borderedH5boolean

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

Example: true

必填requiredboolean

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

Example: false

必填标识requiredFlagboolean

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

Example: true

必填校验提示requiredMsgstring

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

Example: "该项为必填项"

状态statusstring

Example: "edit"

绑定字段namestring

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

标题内容labelstring

Example: "标题"

开关状态valueboolean

默认开关状态

Example: false

组件尺寸(PC)sizestring

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

Example: ""

Events​

Events exposed by the component. You can listen to component events to trigger external actions

Event Name
Event Code
Event Output Parameters event.detail
Applicable Scenarios
Description
值改变changeobject
  • value: boolean

    所选开关状态
Compatible with all platforms

-

Property API​

Through the Property API, you can access the internal state and property values of components. You can access internal values using$w.componentId.propertyName, such as $w.input1.value. For details, please refer to Property API

Read-only Property Name
Property Identifier
Type
Description
绑定字段namestring

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

标题内容labelstring
开关状态valueboolean

默认开关状态

必填requiredboolean

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

是否展示visibleboolean

组件是否展示

是否禁用disabledboolean

组件是否禁用

是否只读readOnlyboolean

组件是否只读

Method API​

Through the Method API, you can programmatically trigger internal methods of components, such as submitting forms, displaying popups, etc. You can call component methods using $w.componentId.methodName, such as $w.form1.submit()

Method Name
Method Identifier
Parameters
Method Description
设置值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​

Through the Style API, you can override the styles of internal elements in components to achieve customization. For example, in the low-code editor, you can write styles for all button components using #wd-page-root .wd-btn, and control individual component styles with :scope. For detailed instructions, please refer toStyle API

Name
Class Name
Description and Examples
根元素.wd-switch-root组件最外层元素
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-switch-root {
  /* Write CSS styles here */
}
H5 端根元素.wd-h5-switch-root可设定 H5 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-h5-switch-root {
  /* Write CSS styles here */
}
PC 端根元素.wd-pc-switch-root可设定 PC 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-pc-switch-root {
  /* Write CSS styles here */
}
小程序端根元素.wd-mp-switch-root可设定小程序端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-mp-switch-root {
  /* Write CSS styles here */
}
组件标题样式.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;
      }

Learn about Style API

Version Changes​

  • Property changes
  • Style changes
  • widget api changes