Switch开关

开关选择器。

何时使用#

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

代码演示

文字说明

Form

基本

最简单的用法。

TypeScript
JavaScript
import {
  Form,
  Checkbox,
  Switch,
} from 'antd';
import React from 'react';

const onChange = (checked: boolean) => {
  console.log(`switch to ${checked}`);
};

const App: React.FC = () => {
  const [checked, setChecked] = React.useState(false)
  const [form] = Form.useForm()
  const userName = Form.useWatch('username', form);
  const fav = Form.useWatch('fav', form);
  console.log(form.getFieldsValue())
  const initialValues = {
    username: true,
    fav: ['A', "C"]
  }
  return (
    <div>
      <Switch defaultChecked onChange={onChange} />
      <Switch
        size="small"
        checked={checked}
        onChange={() => setChecked(!checked)}
      >
        文字说明
      </Switch>
      <br />
      <hr />
      <br />
      <h1>Form</h1>
      <Form
        layout="horizontal"
        form={form}
        initialValues={initialValues}
        onValuesChange={console.log}
      >
        <Form.Item label="Checkbox" valuePropName="checked" name="username">
          <Checkbox>Checkbox</Checkbox>
        </Form.Item>
        <Form.Item label="Switch" valuePropName="checked" name="username">
          <Switch>Switch</Switch>
        </Form.Item>
        <Form.Item label="Checkbox Group" name="fav">
          <Checkbox.Group>
            <Checkbox value="A">A</Checkbox>
            <Checkbox value="B">B</Checkbox>
            <Checkbox value="C">C</Checkbox>
          </Checkbox.Group>
        </Form.Item>
        <Form.Item label="Switch" name="fav">
          <Switch.Group>
            <Switch value="A">A</Switch>
            <Switch value="B">B</Switch>
            <Switch value="C">C</Switch>
          </Switch.Group>
        </Form.Item>
        <Form.Item label="Switch" name="fav">
          <Switch.Group layout="vertical">
            <Switch value="A">A</Switch>
            <Switch value="B">B</Switch>
            <Switch value="C">C</Switch>
          </Switch.Group>
        </Form.Item>
      </Form>
    </div>
  )
}

export default App;

文字和图标

带有文字和图标。

TypeScript
JavaScript
import { CheckOutlined, CloseOutlined } from '@ant-design/icons';
import { Switch } from 'antd';
import React from 'react';

const App: React.FC = () => (
  <>
    <Switch checkedChildren="开启" unCheckedChildren="关闭" defaultChecked />
    <br />
    <Switch checkedChildren="1" unCheckedChildren="0" />
    <br />
    <Switch
      checkedChildren={<CheckOutlined />}
      unCheckedChildren={<CloseOutlined />}
      defaultChecked
    />
  </>
);

export default App;

加载中

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

TypeScript
JavaScript
import { Switch } from 'antd';
import React from 'react';

const App: React.FC = () => (
  <>
    <Switch loading defaultChecked />
    <br />
    <Switch size="small" loading />
  </>
);

export default App;

不可用

Switch 失效状态。

TypeScript
JavaScript
import { Button, Switch } from 'antd';
import React, { useState } from 'react';

const App: React.FC = () => {
  const [disabled, setDisabled] = useState(true);

  const toggle = () => {
    setDisabled(!disabled);
  };

  return (
    <>
      <Switch disabled={disabled} defaultChecked />
      <br />
      <Button type="primary" onClick={toggle}>
        Toggle disabled
      </Button>
    </>
  );
};

export default App;

两种大小

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

TypeScript
JavaScript
import { Switch } from 'antd';
import React from 'react';

const App: React.FC = () => (
  <>
    <Switch defaultChecked />
    <br />
    <Switch size="small" defaultChecked />
  </>
);

export default App;

API#

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

方法#

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