Checkbox

Select one or more values from a list of options or items.

Code


                                                        
                                                        
                                                            <PyxisCheckbox
                                                            v-model="modelValue"
                                                            @update:modelValue="updateCheckbox"
                                                            data-testid="checkbox"
                                                        />
                                                        
                                                            

Example of a regular Checkbox component

Props

The Checkbox component supports the following Props:

Name

Type

Default

Required

dataTestid

string

undefined

true

v-model

string | number |boolean| (number |boolean|string)[]

undefined

false

label

string

undefined

false

id

string

undefined

false

name

string

undefined

false

disabled

boolean

false

false

isIndeterminate

boolean

false

false

trueValue

string | number|boolean

true

false

falseValue

string | number|boolean

false

false

value

string | number|boolean

'on'

false

labelledBy

string

undefined

false

Events

The interactions on the Checkbox component are handled by the following Events

  • @update:modelValue : This event is emitted when the Checkbox component's state or data is updated