| Prop | Default | Type |
|---|---|---|
addOnBlur | booleanWhen | |
addOnPaste | booleanWhen | |
addOnTab | booleanWhen | |
as | 'div' | AsTag | ComponentThe element or component this component should render as. Can be overwritten by |
asChild | booleanChange the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details. | |
convertValue | ((value: string) => AcceptableInputValue)Convert the input value to the desired type. Mandatory when using objects as values and using | |
defaultValue | [] | AcceptableInputValue[]The value of the tags that should be added. Use when you do not need to control the state of the tags input |
delimiter | ',' | string | RegExpThe character or regular expression to trigger the addition of a new tag. Also used to split tags for |
dir | 'ltr' | 'rtl'The reading direction of the combobox when applicable. | |
disabled | booleanWhen | |
displayValue | value.toString() | ((value: AcceptableInputValue) => string)Display the value of the tag. Useful when you want to apply modifications to the value like adding a suffix or when using object as values |
duplicate | booleanWhen | |
id | string | |
max | 0 | numberMaximum number of tags. |
modelValue | AcceptableInputValue[] | nullThe controlled value of the tags input. Can be bind as | |
name | stringThe name of the field. Submitted with its owning form as part of a name/value pair. | |
required | booleanWhen |
| Emit | Payload |
|---|---|
addTag | [payload: AcceptableInputValue]Event handler called when tag is added |
invalid | [payload: AcceptableInputValue]Event handler called when the value is invalid |
removeTag | [payload: AcceptableInputValue]Event handler called when tag is removed |
update:modelValue | [payload: AcceptableInputValue[]]Event handler called when the value changes |
| Slots (default) | Payload |
|---|---|
modelValue | string | number | bigint | Record<string, any>Current input values |
