mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-30 06:09:34 +08:00
Code Issues Actions 33 Packages Projects Releases Wiki Activity
7e782daec0
ant-design/components/switch/index.en-US.md
Tom Xu d44f404eae
docs: sort api (#27251) 
* chore: improve sort api table scripts

* sort api

* add ignore

* Revert "sort api"

This reverts commit 343505d5f0.

* sort api

* Update package.json

* sort api

* Delete sort-api.js

* sort api

* sort api

* sort api

* fix

* Update index.zh-CN.md

* fix input-number

* fix input-number

* sort func

* fix

* Method moved to the end

* carousel method
2020-10-21 10:33:43 +08:00

1.5 KiB
Raw Blame History

category type title cover
Components Data Entry Switch https://gw.alipayobjects.com/zos/alicdn/zNdJQMhfm/Switch.svg

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.

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