Forms
Checkbox
+ CCheckbox supports boolean choices, custom checked values, array groups, and
+ indeterminate presentation while retaining a native checkbox input.
+
Boolean value
+Array group
+
+ When the model is an array, each checkbox adds or removes its value. This is
+ useful for permissions and independent feature selections.
+
States and sizes
+Custom values
+
+ true-value and false-value replace the default boolean values for
+ scalar models.
+
Three-state checkbox
+
+ Add three-state to cycle through unchecked, checked, and indeterminate values.
+ The model sequence is false → true → null → false, where null
+ represents the indeterminate state. Three-state behavior applies to scalar models, not
+ array groups.
+
Properties
+-
+
model-value- A scalar checkbox value or an array used by
v-model. value- Value added to or removed from an array model.
true-value- Scalar value emitted when checked. Defaults to true.
false-value- Scalar value emitted when unchecked. Defaults to false.
indeterminate- Displays a mixed state without changing the model by itself.
three-state- Cycles a scalar model through false, true, and null.
sizesmall,medium, orlarge.disabled- Disables interaction.
required- Applies native required validation.
invalid- Applies invalid styling and
aria-invalid.