ant-design/components/switch/index.en-US.md
MadCcc e7edfa42d7
docs: update overview img ()
* docs: update overview img

* chore: code clean

* chore: code clean

* chore: update

* chore: code clean
2022-11-30 20:14:41 +08:00

1.8 KiB

category group title cover demo
Components Data Entry Switch https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rtArRpBNDZcAAAAAAAAAAAAADrJ8AQ/original
cols
2

Switching Selector.

When To Use

  • If you need to represent the switching between two states or on-off state.
  • The difference between Switch and Checkbox is that Switch will trigger a state change directly when you toggle it, while Checkbox is generally used for state marking, which should work in conjunction with submit operation.

Examples

Basic Disabled Text & icon Two sizes Loading

API

Property Description Type Default
autoFocus Whether get focus when component mounted boolean false
checked Determine whether the Switch is checked boolean false
checkedChildren The content to be shown when the state is checked ReactNode -
className The additional class to Switch string -
defaultChecked Whether to set the initial state boolean false
disabled Disable switch boolean false
loading Loading state of switch boolean false
size The size of the Switch, options: default small string default
unCheckedChildren The content to be shown when the state is unchecked ReactNode -
onChange Trigger when the checked state is changing function(checked: boolean, event: Event) -
onClick Trigger when clicked function(checked: boolean, event: Event) -

Methods

Name Description
blur() Remove focus
focus() Get focus