mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
882cec62d6
* docs: Add components overview page * fix detail * remove ContributorsList form overview page * fix components url * improve code style * remove extra file * fix detail * fix lint * fix lint * docs: Finish components overview page * fix lint * docs: Update cover * fix lint * update cover * update menu * improve overview page * refactor code * fix order * update title * add components count * fix overview page ssr bug * move less file * update title margin Co-authored-by: arvinxx <arvinx@foxmail.com>
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Entry
|
|
title: Checkbox
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/p7QZthygf/Checkbox.svg
|
|
---
|
|
|
|
Checkbox component.
|
|
|
|
## When To Use
|
|
|
|
- Used for selecting multiple values from several options.
|
|
- If you use only one checkbox, it is the same as using Switch to toggle between two states. The difference is that Switch will trigger the state change directly, but Checkbox just marks the state as changed and this needs to be submitted.
|
|
|
|
## API
|
|
|
|
### Props
|
|
|
|
#### Checkbox
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| autoFocus | get focus when component mounted | boolean | false | |
|
|
| checked | Specifies whether the checkbox is selected. | boolean | false | |
|
|
| defaultChecked | Specifies the initial state: whether or not the checkbox is selected. | boolean | false | |
|
|
| disabled | Disable checkbox | boolean | false | |
|
|
| indeterminate | indeterminate checked state of checkbox | boolean | false | |
|
|
| onChange | The callback function that is triggered when the state changes. | Function(e:Event) | - | |
|
|
|
|
#### Checkbox Group
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| defaultValue | Default selected value | string\[] | \[] | |
|
|
| disabled | Disable all checkboxes | boolean | false | |
|
|
| name | The `name` property of all `input[type="checkbox"]` children | string | - | |
|
|
| options | Specifies options | string\[] | \[] | |
|
|
| value | Used for setting the currently selected value. | string\[] | \[] | |
|
|
| onChange | The callback function that is triggered when the state changes. | Function(checkedValue) | - | |
|
|
|
|
### Methods
|
|
|
|
#### Checkbox
|
|
|
|
| Name | Description | Version |
|
|
| ------- | ------------ | ------- |
|
|
| blur() | remove focus | |
|
|
| focus() | get focus | |
|