modelValue AcceptableValue | AcceptableValue[] — Name modelValue Description The controlled value of the selected tag(s). Can be binded with v - model selectionMode multiple
Type null | string | number | bigint | Record < string , any > | AcceptableValue[] Default — defaultValue AcceptableValue | AcceptableValue[] — Name defaultValue Description The value of the selected tag(s) when initially rendered. Use when you do not need to control the selection.
Type null | string | number | bigint | Record < string , any > | AcceptableValue[] Default — selectionMode TagGroupSelectionMode 'none' Name selectionMode Description The type of selection that is allowed. Tags are not selectable when none
Type ' single ' | ' multiple ' | ' none ' Default 'none' disallowEmptySelection boolean false Name disallowEmptySelection Description When true
Type boolean Default false escapeKeyBehavior ' none ' | ' clearSelection ' 'clearSelection' Name escapeKeyBehavior Description Whether pressing <kbd>Escape</kbd> clears the selection.
Type ' none ' | ' clearSelection ' Default 'clearSelection' disabled boolean false Name disabled Description When true
Type boolean Default false dir Direction — Name dir Description The reading direction of the tag group when applicable.
If omitted, inherits globally from ConfigProvider
Type ' ltr ' | ' rtl ' Default — loop boolean true Name loop Description When true
Type boolean Default true by string | ( ( a : AcceptableValue , b : AcceptableValue ) => boolean ) — Name by Description Use this to compare objects by a particular field, or pass your own comparison function for complete control over how objects are compared.
Type string | ( a : AcceptableValue , b : AcceptableValue ) : boolean Default — 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 'div' 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 'div' 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 —