CheckboxGroup

stable

API

Props

All props accepted by this component, with their type, default value and description.

id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
active
boolean | IStateEffectConfig
label
string
size
TSize | number
value
any
disabled
boolean
height
number | string
width
number | string
maxHeight
number | string
maxWidth
number | string
minHeight
number | string
minWidth
number | string
focused
boolean
valueComparator
(a: any, b: any) => boolean
messages
Array<string> | string
indeterminate
boolean
color
TColor
bgColor
TColor
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
borderColor
string
rounded
boolean | number | string | TRounded | null | undefined
elevation
TElevation
padding
boolean | number | string
margin
boolean | number | string
error
string | boolean
inline
boolean
multiple
boolean
modelValue
any
errorMessages
Array<string> | string
maxErrors
number | string
name
string
readonly
boolean
rules
Array<any>
validateOn
TValidateOn
validationValue
any
fontSize
TFontSize
fontWeight
TFontWeight
lineHeight
TLineHeight
hint
string
type
string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
borderTop
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
hover
boolean | IStateEffectConfig
density
TDensity
activeClass
string
hoverClass
string
centerAffix
boolean
hideDetails
boolean | string
hideSpinButtons
boolean
persistentHint
boolean
direction
TDirection
appendAvatar
string
appendIcon
TIcon
prependAvatar
string
prependIcon
TIcon
prependAriaLabel
string
appendAriaLabel
string
indeterminateIcon
TIcon
required
boolean
falseIcon
TIcon
trueIcon
TIcon
ripple
boolean | { class: string }
items
Array<any> | Record<string, any>

API

Slots

Content slots exposed by this component.

#default
#label
#item

API

Emits

Events emitted by this component.

@update:modelValue
any

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…