This is the Vuetify 3 documentation, examples and information may be broken or outdated.

Checkboxes

The v-checkbox component provides users the ability to choose between two distinct values. These are very similar to a switch and can be used in complex forms and checklists. A simpler version, v-simple-checkbox is used primarily as a lightweight alternative in data-table components to select rows or display inline boolean data.

Usage

A v-checkbox in its simplest form provides a toggle between 2 values.

v-checkbox/usage.vue

API

Examples

Props

Colors

Checkboxes can be colored by using any of the builtin colors and contextual names using the color prop.

v-checkbox/prop-colors.vue

Model as array

Multiple v-checkbox’s can share the same v-model by using an array.

v-checkbox/prop-model-as-array.vue

Model as boolean

A single v-checkbox will have a boolean value as its value.

v-checkbox/prop-model-as-boolean.vue

States

v-checkbox can have different states such as default, disabled, and indeterminate.

v-checkbox/prop-states.vue

Slots

Label slot

Checkbox labels can be defined in label slot - that will allow to use HTML content.

v-checkbox/slot-label.vue

Misc

Inline text-field

If you need to place checkboxes in line with other components, you can use the v-checkbox-btn component.

This component renders just checkbox, without the trapping of a form input such as validation, a label, and messages.

v-checkbox/misc-inline-textfield.vue

Ready for more?

Continue your learning with related content selected by the Team or move between pages by using the navigation links below.