rovingFocus boolean true Name rovingFocus Description When false , navigating through the items using arrow keys will be disabled.
Type boolean Default true disabled boolean false Name disabled Description When true , prevents the user from interacting with the toggle group and all its items.
Type boolean Default false orientation ' vertical ' | ' horizontal ' 'horizontal' Name orientation Description The orientation of the component, which determines how focus moves: horizontal for left/right arrows and vertical for up/down arrows. Lays the swatches out in a row, wrapping, or in a column with each label beside its swatch.
Type ' vertical ' | ' horizontal ' Default 'horizontal' dir Direction — Name dir Description The reading direction of the combobox when applicable.
If omitted, inherits globally from ConfigProvider or assumes LTR (left-to-right) reading mode.
Type ' ltr ' | ' rtl ' Default — loop boolean true Name loop Description When loop and rovingFocus is true , keyboard navigation will loop from last item to first, and vice versa.
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 , indicates that the user must set the value before the owning form can be submitted.
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 and 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 — size SwatchSize — Name size Description The size of every swatch in the group.
Type ' md ' | ' xs ' | ' sm ' | ' lg ' Default — shape SwatchShape — Name shape Description The corner shape of every swatch: rounded or a full circle.
Type ' default ' | ' pill ' Default — labelClass ClassValue — Name labelClass Description Classes added to every swatch's label; an item's own labelClass wins.
Type null | string | false | Record < string , any > | ClassValue[] Default —