Reka UI logoReka
backdrop
PropDefaultType
as
'button'
AsTag | Component

The element or component this component should render as. Can be overwritten by asChild.

asChild
boolean

Change the default rendered element for the one passed as a child, merging their props and behavior.

Read our Composition guide for more details.

defaultValue
boolean | 'indeterminate'

The value of the checkbox when it is initially rendered. Use when you do not need to control its value.

disabled
boolean

When true, prevents the user from interacting with the checkbox

id
string

Id of the element

modelValue
boolean | 'indeterminate' | null

The controlled value of the checkbox. Can be binded with v-model.

name
string

The name of the field. Submitted with its owning form as part of a name/value pair.

required
boolean

When true, indicates that the user must set the value before the owning form can be submitted.

value
'on'
AcceptableValue

The value given as data when submitted with a name.

EmitPayload
update:modelValue
[value: boolean | 'indeterminate']

Event handler called when the value of the checkbox changes.

Slots (default)Payload
modelValue
false | true | 'indeterminate'

Current value

state
CheckedState

Current state