Skip to content

Tags Input ​

Use bo-tags-input when users can enter a list of short text values. Enter or a delimiter commits the draft value.

Usage ​

Vue
Press Enter or type a comma.
Vue
<bo-tags-input>
  v-model="tags"
  label="Technologies"
  placeholder="Add a tag"
  hint="Press Enter or type a comma."
/>

Limits and delimiters ​

Use max-tags to limit entries and delimiters to change the commit characters.

Vue
<bo-tags-input>
  v-model="tags"
  label="Keywords"
  :max-tags="3"
  :allow-duplicates="false"
  :delimiters="[';']"
/>

API ​

Prop / eventTypeDefaultDescription
id / dataTestIdstringautogeneratedRoot and input attributes.
modelValuestring[][]Tags used by v-model.
placeholderstring-Draft input placeholder.
delimitersstring[][',']Characters that commit a tag.
maxTagsnumber-Maximum tag count.
allowDuplicatesbooleanfalseAllows repeated tag text.
inputMode / namenative input typestext / -Keyboard hint and hidden form value.
label / description / error / hintstring-Field messaging.
required / disabled / readOnly / autofocusbooleanfalseInput states and initial focus.
role / ariaLabel / ariaLabelledBy / ariaDescribedBynative accessibility typescombobox / -Input semantics.
update:modelValue(value: string[]) event-Emitted when tags change.
focus / blurevent-Emitted by the draft input.
focus / addTag / removeTagexposed methods-Focuses, adds, or removes tags programmatically.

Released under the MIT License.