Skip to content
On this page

Checkbox

Basic

value: false

Icon

Use icon prop to change the checked icon.

Array

ACheckbox also support arrays like a native checkbox.

Selected: []

Color

You can use color prop to change the checkbox color.

Indeterminate

You can trigger indeterminate state of checkbox by setting v-model value to null. Moreover, you can also customize the indeterminate value by setting indeterminate-value prop.

By default, indeterminate value doesn't get cycled through the options. If you want to cycle through the options, you can set cycle-indeterminate prop to true.

API

Checkbox

icon : ConfigurableValue

Icon to render in checkbox square instead of check

modelValue : CheckboxModelValue

Bind v-model value

color : ColorProp

Checkbox color

disabled : boolean

Disable checkbox

uncheckedValue : CheckboxModelValue

Switch value when in off state

indeterminateValue : CheckboxModelValue

Set custom value for indeterminate state

cycleIndeterminate : boolean

Enable cycling indeterminate state

inputClasses : any

Bind classes to input element

label : string

Label text

checkedValue : CheckboxModelValue

Switch value when in on state

default : any

Default slot for rendering checkbox label. If default slot is used label prop will be discarded.

update:modelValue => [value: CheckboxModelValue | undefined]

Released under the MIT License.