Explore the API reference for the Vue Checks & radios component and discover how to effectively utilize its props for customization.
On this page
CFormCheck
jsx
import { CFormCheck } from '@coreui/vue-pro'
Props
Property
Default
Type
button
-
object
Create button-like checkboxes and radio buttons.
falseValue4.10.0+
-
string
Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the false state.
feedback4.3.0+
-
string
Provide valuable, actionable feedback.
feedbackInvalid4.3.0+
-
string
Provide valuable, actionable feedback.
feedbackValid4.3.0+
-
string
Provide valuable, actionable invalid feedback when using standard HTML form validation which applied two CSS pseudo-classes, :invalid and :valid.
hitArea
-
string
Sets hit area to the full area of the component.
id
-
string
The id global attribute defines an identifier (ID) that must be unique in the whole document.
indeterminate
-
boolean
Input Checkbox indeterminate Property
inline
-
boolean
Group checkboxes or radios on the same horizontal row by adding.
invalid
-
boolean
Set component validation state to invalid.
label
-
string
The element represents a caption for a component.
modelValue
-
array, boolean, string
The default name for a value passed using v-model.
reverse4.8.0+
-
boolean
Put checkboxes or radios on the opposite side.
tooltipFeedback4.3.0+
-
boolean
Display validation feedback in a styled tooltip.
trueValue4.10.0+
-
string
Use in conjunction with the v-model directive to specify the value that should be assigned to the bound variable when the checkbox is in the true state.
type
'checkbox'
string
Specifies the type of component.
valid
-
boolean
Set component validation state to valid.
value
-
string
The value attribute of component.
Events
Event name
change
Event occurs when the checked value has been changed.
update:modelValue
Emit the new value whenever there’s a change event.