Prop | Default | Type |
---|---|---|
as | 'div' | AsTag | Component The element or component this component should render as. Can be overwritten by |
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 | AcceptableValue | AcceptableValue[] The default active value of the item(s). Use when you do not need to control the state of the item(s). | |
dir | 'ltr' | 'rtl' The reading direction of the combobox when applicable. | |
disabled | false | boolean When |
loop | true | boolean When |
modelValue | AcceptableValue | AcceptableValue[] The controlled value of the active item(s). Use this when you need to control the state of the items. Can be binded with | |
name | string The name of the field. Submitted with its owning form as part of a name/value pair. | |
orientation | 'vertical' | 'horizontal' The orientation of the component, which determines how focus moves: | |
required | boolean When | |
rovingFocus | true | boolean When |
type | 'single' | 'multiple' Determines whether a "single" or "multiple" items can be selected at a time. This prop will overwrite the inferred type from |
Emit | Payload |
---|---|
update:modelValue | [payload: AcceptableValue | AcceptableValue[]] Event handler called when the value of the toggle changes. |
Slots (default) | Payload |
---|---|
modelValue | AcceptableValue | AcceptableValue[] | undefined Current toggle values |