ant-design-vue/components/checkbox/index.en-US.md

1.4 KiB

API

Props

Checkbox

Property Description Type Default
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

events

Events Name Description Arguments
change The callback function that is triggered when the state changes. Function(e:Event)

Checkbox Group

Property Description Type Default
defaultValue Default selected value string[] []
disabled Disable all checkboxes boolean false
options Specifies options string[] | Array<{ label: string value: string disabled?: boolean, onChange?: function }> []
value Used for setting the currently selected value. string[] []

events

Events Name Description Arguments
change The callback function that is triggered when the state changes. Function(checkedValue)

Methods

Checkbox

Name Description
blur() remove focus
focus() get focus