rovingFocus boolean true Name rovingFocus Description When false
Type boolean Default true disabled boolean false Name disabled Description When true
Type boolean Default false orientation DataOrientation — Name orientation Description The orientation of the component, which determines how focus moves: horizontal vertical
Type ' vertical ' | ' horizontal ' Default — dir Direction — Name dir Description The reading direction of the combobox when applicable.
If omitted, inherits globally from ConfigProvider
Type ' ltr ' | ' rtl ' Default — loop boolean true Name loop Description When loop rovingFocus true
Type boolean Default true asChild boolean false Name asChild Description Change the default rendered element for the one passed as a child, merging their props and behavior.
Read our Composition guide for more details.
Type boolean Default false as AsTag | Component — Name as Description The element or component this component should render as. Can be overwritten by asChild
Type ComponentOptions < any , any , any , ComputedOptions , MethodOptions , any , any , any , string , {}, {}, string , {}, {}, {}, string , ComponentProvideOptions > | ( props : any , ctx : Omit < { attrs : Attrs ; slots : Readonly < InternalSlots > ; emit : ( event : string , ... args : any [] ) => void ; expose : < Exposed extends Record < string , any > = Record < string , any >> ( exposed ?: Exposed | undefined ) => void ; }, ' expose ' > ) : any | ComponentPublicInstanceConstructor < any , any , any , any , ComputedOptions , MethodOptions > | ' a ' | ' button ' | ' div ' | ' form ' | ' h2 ' | ' h3 ' | ' img ' | ' input ' | ' label ' | ' li ' | ' nav ' | ' ol ' | ' p ' | ' span ' | ' svg ' | ' ul ' | ' template ' | {} & string Default — name string — Name name Description The name of the field. Submitted with its owning form as part of a name/value pair.
Type string Default — required boolean false Name required Description When true
Type boolean Default false type SingleOrMultipleType — Name type Description Determines whether a "single" or "multiple" items can be selected at a time.
This prop will overwrite the inferred type from modelValue defaultValue
Type ' single ' | ' multiple ' Default — modelValue AcceptableValue | AcceptableValue[] — Name modelValue Description The controlled value of the active item(s).
Use this when you need to control the state of the items. Can be binded with v - model
Type null | string | number | bigint | Record < string , any > | AcceptableValue[] Default — defaultValue AcceptableValue | AcceptableValue[] — Name defaultValue Description The default active value of the item(s).
Use when you do not need to control the state of the item(s).
Type null | string | number | bigint | Record < string , any > | AcceptableValue[] Default — class ClassValue — Name class Description Classes added to the part's own element, after its recipe classes.
Type null | string | false | Record < string , any > | ClassValue[] Default — variant ToggleVariant — Name variant Description The visual style of every item: transparent or outlined.
Type ' default ' | ' outline ' Default — size ToggleSize — Name size Description Type ' md ' | ' sm ' | ' lg ' | ' icon-sm ' | ' icon-md ' | ' icon-lg ' Default — spacing ToggleGroupSpacing 0 Name spacing Description The gap between items, from none to 4 steps; at 0 the items join into one control.
Type 0 | 1 | 2 | 3 | 4 Default 0