ant-design/components/switch/index.en-US.md

---
category: Components
type: Data Entry
title: Switch
---

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

### Switch

Property | Description | Type | Default |
-----|-----|-----|------|
checked | determine whether the `Switch` is checked  | boolean | false |
defaultChecked | to set the initial state | boolean | false |
onChange | a callback function, can be executed when the checked state is changing | Function(checked:Boolean) | |
checkedChildren | content to be shown when the state is checked | string\|ReactNode  | |
unCheckedChildren | content to be shown when the state is unchecked | string\|ReactNode  | |
size | the size of the `Switch`, options: `default` `small` | string | default |
docs: Switch-translation (#2489) 2016-07-26 09:17:46 +08:00			`---`
			`category: Components`
docs: 调整组件导航结构 (#3758) - Layout 更名为 Grid 2016-11-09 14:43:32 +08:00			`type: Data Entry`
docs: Switch-translation (#2489) 2016-07-26 09:17:46 +08:00			`title: Switch`
			`---`

			`Switching Selector.`

Fix doc headings 2016-09-10 13:43:30 +08:00			`## When To Use`
docs: Switch-translation (#2489) 2016-07-26 09:17:46 +08:00
			`- 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`

			`### Switch`

			`Property \| Description \| Type \| Default \|`
			`-----\|-----\|-----\|------\|`
docs: Unify type naming (#4636) * Unify name of ReactNode type in document * Lowser all string type name * Lowercase all number type name * Lowercase all boolean type name * Unify array type * Lowercase all object type name * Unify mutilple types 2017-01-20 20:10:50 +08:00			checked \| determine whether the `Switch` is checked \| boolean \| false \|
			`defaultChecked \| to set the initial state \| boolean \| false \|`
docs: Switch-translation (#2489) 2016-07-26 09:17:46 +08:00			`onChange \| a callback function, can be executed when the checked state is changing \| Function(checked:Boolean) \| \|`
docs: Unify type naming (#4636) * Unify name of ReactNode type in document * Lowser all string type name * Lowercase all number type name * Lowercase all boolean type name * Unify array type * Lowercase all object type name * Unify mutilple types 2017-01-20 20:10:50 +08:00			`checkedChildren \| content to be shown when the state is checked \| string\\|ReactNode \| \|`
			`unCheckedChildren \| content to be shown when the state is unchecked \| string\\|ReactNode \| \|`
			size \| the size of the `Switch`, options: `default` `small` \| string \| default \|