ant-design/components/switch/index.zh-CN.md
二货爱吃白萝卜 20561d6f9d
docs: Fix component doc alignment & support import usage (#48004)
* docs: init ref

* docs all support

* docs: fix link show
2024-03-22 14:22:42 +08:00

2.4 KiB
Raw Permalink Blame History

category group title subtitle description cover coverDark demo
Components 数据录入 Switch 开关 使用开关切换两种状态之间。 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rtArRpBNDZcAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*al07RK8SGf4AAAAAAAAAAAAADrJ8AQ/original
cols
2

何时使用

  • 需要表示开关状态/两种状态之间的切换时;
  • checkbox 的区别是,切换 switch 会直接触发状态改变,而 checkbox 一般用于状态标记,需要和提交操作配合。

代码演示

基本 不可用 文字和图标 两种大小 加载中 自定义组件 Token

API

通用属性参考:通用属性

参数 说明 类型 默认值 版本
autoFocus 组件自动获取焦点 boolean false
checked 指定当前是否选中 boolean false
checkedChildren 选中时的内容 ReactNode -
className Switch 器类名 string -
defaultChecked 初始是否选中 boolean false
defaultValue defaultChecked 的别名 boolean - 5.12.0
disabled 是否禁用 boolean false
loading 加载中的开关 boolean false
size 开关大小,可选值:default small string default
unCheckedChildren 非选中时的内容 ReactNode -
value checked 的别名 boolean - 5.12.0
onChange 变化时的回调函数 function(checked: boolean, event: Event) -
onClick 点击时的回调函数 function(checked: boolean, event: Event) -

方法

名称 描述
blur() 移除焦点
focus() 获取焦点

主题变量Design Token

FAQ

为什么在 Form.Item 下不能绑定数据?

Form.Item 默认绑定值属性到 value 上,而 Switch 的值属性为 checked。你可以通过 valuePropName 来修改绑定的值属性。

<Form.Item name="fieldA" valuePropName="checked">
  <Switch />
</Form.Item>