Checkbox

Checkbox is a form input component that allows users to select one or more options from a set. It supports various colors and sizes to match your application's design system.

Basic Usage

Code Example
Basic.vue

Checkbox

The Checkbox component is a form input that allows users to select one or more options from a set. It supports v-model for two-way binding and offers various styling options.

Checkbox Props Type Description
modelValue
any
v-model The current value of the checkbox.
validator
boolean

Adds the validator class for input validation styling.

theme-controller
boolean

When checked, the page's theme will match the checkbox's value.

color
string

Sets the color of the checkbox. Options: - primary - secondary - accent - success - warning - info - error

   
primary
boolean

Sets the color to primary.

   
secondary
boolean

Sets the color to secondary.

   
accent
boolean

Sets the color to accent.

   
success
boolean

Sets the color to success.

   
warning
boolean

Sets the color to warning.

   
info
boolean

Sets the color to info.

   
error
boolean

Sets the color to error.

size
string

Sets the size of the checkbox. Options: - lg - md (default) - sm - xs

   
lg
boolean

Sets the size to lg.

   
md
boolean

Sets the size to md.

   
sm
boolean

Sets the size to sm.

   
xs
boolean

Sets the size to xs.

Checkbox Events Arguments Description
update:modelValue
v-model Emitted when the checkbox value changes.

Examples

Below are additional usage examples for the Checkbox component. For basic usage, see the intro.

With Label

Showcases a checkbox with a label using the Label and LabelText components.

Code Example
WithLabel.vue

Color

Demonstrates all available color options for the Checkbox component.

Code Example
Color.vue

Size

Demonstrates all available size options for the Checkbox component.

Code Example
Size.vue