Checkbox

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.

Common props ref：Common props

Property	Description	Type	Default
autoFocus	If 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	If disable checkbox	boolean	false
indeterminate	The indeterminate checked state of checkbox	boolean	false
onChange	The callback function that is triggered when the state changes	(e: CheckboxChangeEvent) => void	-
onBlur	Called when leaving the component	function()	-
onFocus	Called when entering the component	function()	-

Property	Description	Type	Default	Version
defaultValue	Default selected value	(string \| number)[]	[]
disabled	If disable all checkboxes	boolean	false
name	The `name` property of all `input[type="checkbox"]` children	string	-
options	Specifies options	string[] \| number[] \| Option[]	[]
value	Used for setting the currently selected value	(string \| number \| boolean)[]	[]
title	title of the option	`string`	-
className	className of the option	`string`	-	5.25.0
style	styles of the option	`React.CSSProperties`	-
onChange	The callback function that is triggered when the state changes	(checkedValue: T[]) => void	-

typescript

interface Option {
  label: string;
  value: string;
  disabled?: boolean;
}

Name	Description	Version
blur()	Remove focus
focus()	Get focus
nativeElement	Returns the DOM node of the Checkbox	5.17.3

Form.Item default bind value to value property, but Checkbox value property is checked. You can use valuePropName to change bind property.

tsx

<Form.Item name="fieldA" valuePropName="checked">
  <Checkbox />
</Form.Item>