Switch开关

开关选择器。

何时使用

  • 需要表示开关状态/两种状态之间的切换时;

  • checkbox 的区别是,切换 switch 会直接触发状态改变,而 checkbox 一般用于状态标记,需要和提交操作配合。

代码演示

Switch开关 - 图1

基本

最简单的用法。

  1. import { Switch } from 'antd';
  2. function onChange(checked) {
  3. console.log(`switch to ${checked}`);
  4. }
  5. ReactDOM.render(<Switch defaultChecked onChange={onChange} />, mountNode);

Switch开关 - 图2

文字和图标

带有文字和图标。

  1. import { Switch } from 'antd';
  2. import { CloseOutlined, CheckOutlined } from '@ant-design/icons';
  3. ReactDOM.render(
  4. <>
  5. <Switch checkedChildren="开启" unCheckedChildren="关闭" defaultChecked />
  6. <br />
  7. <Switch checkedChildren="1" unCheckedChildren="0" />
  8. <br />
  9. <Switch
  10. checkedChildren={<CheckOutlined />}
  11. unCheckedChildren={<CloseOutlined />}
  12. defaultChecked
  13. />
  14. </>,
  15. mountNode,
  16. );

Switch开关 - 图3

加载中

标识开关操作仍在执行中。

  1. import { Switch } from 'antd';
  2. ReactDOM.render(
  3. <>
  4. <Switch loading defaultChecked />
  5. <br />
  6. <Switch size="small" loading />
  7. </>,
  8. mountNode,
  9. );

Switch开关 - 图4

不可用

Switch 失效状态。

  1. import { Switch, Button } from 'antd';
  2. const App = () => {
  3. const [disabled, setDisabled] = React.useState(true);
  4. const toggle = () => {
  5. setDisabled(!disabled);
  6. };
  7. return (
  8. <>
  9. <Switch disabled={disabled} defaultChecked />
  10. <br />
  11. <Button type="primary" onClick={toggle}>
  12. Toggle disabled
  13. </Button>
  14. </>
  15. );
  16. };
  17. ReactDOM.render(<App />, mountNode);

Switch开关 - 图5

两种大小

size="small" 表示小号开关。

  1. import { Switch } from 'antd';
  2. ReactDOM.render(
  3. <>
  4. <Switch defaultChecked />
  5. <br />
  6. <Switch size="small" defaultChecked />
  7. </>,
  8. mountNode,
  9. );

API

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

方法

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