Checkbox Group Element

An element used to create a group of checkbox options.

#Examples

#Options

Name Type Description
items object List of checkbox options.
disable array List of option keys to be disabled.
disabled boolean Whether the field is disabled.
default array Value of element when the form is initially loaded or reseted.

#Properties

Name Type Default Description
items object {} List of checkbox options.
disables array [] List of option keys to be disabled.
disabled boolean false Whether all the checkboxes are disabled.
defaultValue array [] Value of element when the form is initially loaded or reseted.

#Methods

# .checkAll()

Checks all checkboxes.


# .uncheckAll()

Checks all checkboxes.


# .disableAll()

Disabled all checkboxes.


# .enableAll()

Enables all checkboxes.


# .check(options)

Parameters
  • options arr|str|num : key of one or more checkboxes to check.

Checks a checkbox or checkboxes.


# .uncheck(options)

Parameters
  • options arr|str|num : key of one or more checkboxes to uncheck.

Unchecks a checkbox or checkboxes.


# .disable(options)

Parameters
  • options arr|str|num : key of one or more checkboxes to disable.

Disables a checkbox or checkboxes.


# .enable(options)

Parameters
  • options arr|str|num : key of one or more checkboxes to enable.

Enables a checkbox or checkboxes.


#Slots

# checkbox

Props
  • el$ object : The element component.
  • item object : The checkbox item's object.
  • value str|num|bool : The checkbox item's value.

Contains the checkbox field.