Form Tags

Lightweight custom tagged input form control, with options for customized interface rendering, duplicate tag detection and optional tag validation.

Tags are arrays of short strings, used in various ways such as assigning categories. Use the default user interface, or create your own custom interface via the use of the default scoped slot.

Basic usage

Tags will have any leading and tailing whitespace removed, and duplicate tags are not permitted. Tags that contain spaces are permitted by default.

Tags are added by clicking the Add button, pressing the Enter key or optionally when the change event fires on the new tag input (i.e. when focus moves from the input). The Add button will only appear when the user has entered a new tag value.

Type a new tag and press enter

Value: []

HTML

vue

<template>
  <label for="tags-basic">Type a new tag and press enter</label>
  <BFormTags input-id="tags-basic" v-model="value" />
  <p class="mt-2">Value: {{ value }}</p>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange'])
</script>

Tag creation using separators

To auto create tags when a separator character is typed (i.e. Space, ,, etc.), set the separator prop to the character that will trigger the tag to be added. If multiple separator characters are needed, then include them as a single string (i.e. ' ,;'), or an array of characters (i.e. [' ', ',', ';']), which will trigger a new tag to be added when Space, ,, or ; are typed). Separators must be a single character.

The following example will auto create a tag when Space, ,, or ; are typed:

Enter tags separated by space, comma or semicolon

apple
orange

Value: [ "apple", "orange" ]

HTML

vue

<template>
  <div>
    <label for="tags-separators">Enter tags separated by space, comma or semicolon</label>
    <BFormTags
      input-id="tags-separators"
      v-model="value"
      separator=" ,;"
      placeholder="Enter new tags separated by space, comma or semicolon"
      no-add-on-enter
    ></BFormTags>
    <p class="mt-2">Value: {{ value }}</p>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange'])
</script>

Last tag removal via backspace keypress

When the prop remove-on-delete is set, and the user presses Backspace (or Del) and the input value is empty, the last tag in the tag list will be removed.

Enter tags separated by space, comma or semicolonEnter new tags separated by space

apple
orange
grape

Press Backspace to remove the last tag entered

Value: [ "apple", "orange", "grape" ]

HTML

vue

<template>
  <div>
    <label for="tags-remove-on-delete">Enter new tags separated by space</label>
    <BFormTags
      input-id="tags-remove-on-delete"
      :input-attrs="{'aria-describedby': 'tags-remove-on-delete-help'}"
      v-model="value"
      separator=" "
      placeholder="Enter new tags separated by space"
      remove-on-delete
      no-add-on-enter
    ></BFormTags>
    <BFormText id="tags-remove-on-delete-help" class="mt-2">
      Press <kbd>Backspace</kbd> to remove the last tag entered
    </BFormText>
    <p>Value: {{ value }}</p>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange', 'grape'])
</script>

Styling Options

Several props are available to alter the basic styling of the default tagged interface:

Prop	Description
`tag-pills`	Renders the tags with the appearance of pills
`tag-variant`	Applies one of the Bootstrap contextual variant theme colors to the tags
`size`	Set the size of the component's appearance. `sm`, `md` (default), or `lg`
`placeholder`	The placeholder text for the new tag input element
`state`	Sets the contextual state of the control. Set to `true` (for valid), `false` (for invalid), or `null`
`disabled`	Places the component in a disabled state

For additional props, see the component reference section at the bottom of this page.

The focus and validation state styling of the component relies upon BootstrapVueNext's custom CSS.

Enter tags

apple
orange
grape

Value: [ "apple", "orange", "grape" ]

HTML

vue

<template>
  <div>
    <label for="tags-pills">Enter tags</label>
    <BFormTags
      input-id="tags-pills"
      v-model="value"
      tag-variant="primary"
      tag-pills
      size="lg"
      separator=" "
      placeholder="Enter new tags separated by space"
    ></BFormTags>
    <p class="mt-2">Value: {{ value }}</p>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange', 'grape'])
</script>

Using with native browser `<form>` submission

The value of the tagged input will not be submitted via standard form action unless you provide a name via the name prop. When a name is provided, <BFormTags> will create a hidden <input> for each tag. The hidden input will have the name attribute set to the value of the name prop.

The hidden inputs will also be generated when using custom rendering (when the name prop is set).

Tag validation

By default, <BFormTags> detects when the user is attempting to enter a (case-sensitive) duplicate tag, and will provide integrated feedback to the user.

You can optionally provide a tag validator method via the tag-validator prop. The validator function will receive one argument which is the tag being added, and should return either true if the tag passes validation and can be added, or false if the tag fails validation (in which case it is not added to the array of tags). Integrated feedback will be provided to the user listing the invalid tag(s) that could not be added.

Tag validation occurs only for tags added via user input. Changes to the tags via the v-model are not validated.

Tags validation example

You must provide at least 3 tags and no more than 8

Tags must be 3 to 5 characters in length and all lower case. Enter tags separated by spaces or press enter.

HTML

vue

<template>
  <div>
    <BFormGroup label="Tags validation example" label-for="tags-validation" :state="state">
      <BFormTags
        input-id="tags-validation"
        v-model="tags"
        :input-attrs="{'aria-describedby': 'tags-validation-help'}"
        :tag-validator="tagValidator"
        :state="state"
        separator=" "
      ></BFormTags>

      <template #invalid-feedback> You must provide at least 3 tags and no more than 8 </template>

      <template #description>
        <div id="tags-validation-help">
          Tags must be 3 to 5 characters in length and all lower case. Enter tags separated by
          spaces or press enter.
        </div>
      </template>
    </BFormGroup>
  </div>
</template>

<script setup lang="ts">
const dirty = ref<boolean>(false)
const tags = ref<string[]>([])

const state = computed(() => {
  // Overall component validation state
  return dirty.value ? tags.value.length > 2 && tags.value.length < 9 : null
})

watch(tags, () => {
  // Set the dirty flag on first change to the tags array
  dirty.value = true
})

const tagValidator = (tag) => {
  // Individual tag validator function
  return tag === tag.toLowerCase() && tag.length > 2 && tag.length < 6
}
</script>

Detecting new, invalid, and duplicate tags

The event tag-state will be emitted whenever new tags are entered into the new tag input element, tags that do not pass validation, or duplicate tags are detected. The event handler will receive three arrays as its arguments:

validTags (tags that pass validation)
invalidTags (tags that do not pass validation)
duplicateTags (tags that would be a duplicate of existing or validTags)

The event will be emitted only when the new tag input changes (characters are entered that would be considered part of a tag), or when the user attempts to add a tag (i.e. via Enter, clicking the Add button, or entering a separator). The three arrays will be empty when the user clears the new tag input element (or contains just spaces).

If you are providing your own feedback for duplicate and invalid tags (via the use of the tag-state event) outside of the <BFormTags> component, you can disable the built in duplicate and invalid messages by setting the props duplicate-tag-text and invalid-tag-text (respectively) to either an empty string ('') or null.

Enter tags

Tags: []

Event values:

validTags: []
invalidTags: []
duplicateTags: []

HTML

vue

<template>
  <div>
    <label for="tags-state-event">Enter tags</label>
    <BFormTags
      input-id="tags-state-event"
      v-model="tags"
      :tag-validator="validator"
      placeholder="Enter tags (3-5 characters) separated by space"
      separator=" "
      @tag-state="onTagState"
    ></BFormTags>
    <p class="mt-2">Tags: {{ tags }}</p>
    <p>Event values:</p>
    <ul>
      <li>validTags: {{ validTags }}</li>
      <li>invalidTags: {{ invalidTags }}</li>
      <li>duplicateTags: {{ duplicateTags }}</li>
    </ul>
  </div>
</template>

<script setup lang="ts">
const tags = ref<string[]>([])
const validTags = ref<string[]>([])
const invalidTags = ref<string[]>([])
const duplicateTags = ref<string[]>([])
const onTagState = (valid, invalid, duplicate) => {
  validTags.value = valid
  invalidTags.value = invalid
  duplicateTags.value = duplicate
}
const validator = (tag) => {
  return tag.length > 2 && tag.length < 6
}
</script>

Limiting tags

If you want to limit the amount of tags the user is able to add use the limit prop. When configured, adding more tags than the limit allows is only possible by the v-model.

When the limit of tags is reached, the user is still able to type but adding more tags is disabled. A message is shown to give the user feedback about the reached limit. This message can be configured by the limit-tags-text prop. Setting it to either an empty string ('') or null will disable the feedback.

Removing tags is unaffected by the limit prop.

Enter tags

Value: []

HTML

vue

<template>
  <div>
    <label for="tags-limit">Enter tags</label>
    <BFormTags input-id="tags-limit" v-model="value" :limit="limit" remove-on-delete></BFormTags>
    <p class="mt-2">Value: {{ value }}</p>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>([])
const limit = ref<number>(5)
</script>

Custom rendering with default scoped slot

If you fancy a different look and feel for the tags control, you can provide your own custom rendering via the default scoped slot. You can either create your own tags, or use our helper <BFormTag> component.

Scope properties

The default scoped slot provides numerous properties and methods for use in rendering your custom interface. Not all properties or methods are required to generate your interface.

The default slot scope properties are as follows:

Property	Type	Description
`addButtonText`	String	The value of the `add-button-text` prop
`addButtonVariant`	String	The value of the `add-button-variant` prop
`addTag`	Function	Method to add a new tag. Assumes the tag is the value of the input, but optionally accepts one argument which is the tag value to be added
`disableAddButton`	Boolean	Will be `true` if the tag(s) in the input cannot be added (all invalid and/or duplicates)
`disabled`	Boolean	`true` if the component is in the disabled state. Value of the `disabled` prop
`duplicateTagText`	String	The value of the `duplicate-tag-text` prop
`duplicateTags`	Array	Array of the duplicate tag(s) the user has entered
`form`	String	The value of the `form` prop
`inputAttrs`	Object	Object of attributes to apply to the new tag input element via `v-bind="inputAttrs"`. See below for details
`inputHandlers`	Object	Object of event handlers to apply to the new tag input element via `v-on="inputHandlers"`. See below for details
`inputId`	String	ID to add to the new tag input element. Defaults to prop `input-id`. If not provided a unique ID is auto-generated. Also available via 'inputAttrs.id'
`inputType`	String	Type of input to render (normalized version of prop `input-type`)
`invalidTagText`	String	The value of the `invalid-tag-text` prop
`invalidTags`	Array	Array of the invalid tag(s) the user has entered
`isDuplicate`	Boolean	`true` if the user input contains duplicate tag(s)
`isInvalid`	Boolean	`true` if the user input contains invalid tag(s)
`isLimitReached`	Boolean	`true` if a `limit` is configured and the amount of tags has reached the limit
`limitTagsText`	String	The value of the `limit-tags-text` prop
`limit`	String	The value of the `limit` prop
`noTagRemove`	Boolean	The value of the `no-tag-remove` prop
`placeholder`	String	The value of the `placeholder` prop
`removeTag`	Function	Method to remove a tag. Accepts one argument which is the tag value to remove
`required`	Boolean	The value of the `required` prop
`separator`	String	The value of the `separator` prop
`size`	String	The value of the `size` prop
`state`	Boolean	The contextual state of the component. Value of the `state` prop. Possible values are `true`, `false`, or `null`
`tagClass`	String, Array, or Object	The value of the `tag-variant` prop. Class (or classes) to apply to the tag elements
`tagPills`	Boolean	The value of the `tag-pills` prop
`tagRemoveLabel`	String	Value of the `tag-remove-label` prop. Used as the `aria-label` attribute on the remove button of tags
`tagVariant`	String	Value of the `tag-variant` prop
`tags`	Array	Array of current tag strings

`inputAttrs` object properties

The inputAttrs object contains attributes to bind (v-bind) to the new tag input element.

Property	Type	Description
disabled	Boolean	The `disabled` attribute for the new tag input. Value of the `disabled` prop
form	String	The value of the `form` prop
id	String	The `id` attribute for the new tag input
value	String	The `value` attribute for the new tag input

The inputAttrs object will also include any attributes set via the input-attrs prop. Note that the above attributes take precedence over any of the same attributes specified in the input-attrs prop.

`inputHandlers` object properties

The inputHandlers object contains event handlers to bind (v-on) to the new tag input element.

Property	Type	Description
`change`	Function	Event handler for the input element `change` event. Accepts a single argument of either an event object or a string. Change will trigger adding the tag.
`input`	Function	Event handler for the input element `input` event. Accepts a single argument of either an event object or a string. Updates the internal v-model for the new tag input element
`keydown`	Function	Event handler for the input element keydown `Enter` and `Del` events. Accepts a single argument which is the native keydown event object

The change handler, when needed, must be enabled via the add-on-change prop, otherwise it is a noop method.

Using native browser inputs

The scope contains attributes and event handlers that can be directly bound to native <input> or <select> elements.

The following example includes the suggested ARIA attributes and roles needed for screen-reader support.

apple
orange
banana
pear
peach

HTML

vue

<template>
  <div>
    <BFormTags v-model="value" no-outer-focus class="mb-2">
      <template v-slot="{tags, inputAttrs, inputHandlers, addTag, removeTag}">
        <BInputGroup aria-controls="my-custom-tags-list">
          <input
            v-bind="inputAttrs"
            v-on="inputHandlers"
            placeholder="New tag - Press enter to add"
            class="form-control"
          />
          <BInputGroupText>
            <BButton @click="addTag()" variant="primary">Add</BButton>
          </BInputGroupText>
        </BInputGroup>
        <ul
          id="my-custom-tags-list"
          class="list-unstyled d-inline-flex flex-wrap mb-0"
          aria-live="polite"
          aria-atomic="false"
          aria-relevant="additions removals"
        >
          <!-- Always use the tag value as the :key, not the index! -->
          <!-- Otherwise screen readers will not read the tag additions and removals correctly -->
          <BCard
            v-for="tag in tags"
            :key="tag"
            :id="`my-custom-tags-tag_${tag.replace(/\s/g, '_')}_`"
            tag="li"
            class="mt-1 me-1"
            body-class="py-1 pe-2 text-nowrap"
          >
            <strong>{{ tag }}</strong>
            <BButton
              @click="removeTag(tag)"
              variant="link"
              size="sm"
              :aria-controls="`my-custom-tags-tag_${tag.replace(/\s/g, '_')}_`"
              >remove</BButton
            >
          </BCard>
        </ul>
      </template>
    </BFormTags>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange', 'banana', 'pear', 'peach'])
</script>

Using custom form components

The scope contains attributes and event handlers that can be directly bound to most custom inputs or select components (the event handlers accept either a string tag value or a native event object). Any component that emits input as characters are typed, and (optionally) emits change when the input value changes (i.e on blur or select), and uses the prop value as the v-model, should work without modification.

In this example, we are using the <BFormTag> helper component, but feel free to render tags using standard HTML or components.

appleorangebanana

HTML

vue

<template>
  <div>
    <BFormTags v-model="value" no-outer-focus class="mb-2">
      <template v-slot="{tags, inputAttrs, inputHandlers, tagVariant, addTag, removeTag}">
        <BInputGroup class="mb-2">
          <BFormInput
            v-bind="inputAttrs"
            v-on="inputHandlers"
            placeholder="New tag - Press enter to add"
            class="form-control"
          ></BFormInput>
          <BInputGroupText>
            <BButton @click="addTag()" variant="primary">Add</BButton>
          </BInputGroupText>
        </BInputGroup>
        <div class="d-inline-block" style="font-size: 1.5rem;">
          <BFormTag
            v-for="tag in tags"
            @remove="removeTag(tag)"
            :key="tag"
            :title="tag"
            :variant="tagVariant"
            class="me-1"
            >{{ tag }}</BFormTag
          >
        </div>
      </template>
    </BFormTags>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>(['apple', 'orange', 'banana'])
</script>

The following is an example of using a custom select component for choosing from a pre-defined set of tags:

Tagged input using select

HTML

vue

<template>
  <div>
    <BFormGroup label="Tagged input using select" label-for="tags-component-select">
      <!-- Prop `add-on-change` is needed to enable adding tags vie the `change` event -->
      <BFormTags
        id="tags-component-select"
        v-model="value"
        size="lg"
        class="mb-2"
        add-on-change
        no-outer-focus
      >
        <template v-slot="{tags, inputAttrs, inputHandlers, disabled, removeTag}">
          <ul v-if="tags.length > 0" class="list-inline d-inline-block mb-2">
            <li v-for="tag in tags" :key="tag" class="list-inline-item">
              <BFormTag @remove="removeTag(tag)" :title="tag" :disabled="disabled" variant="info">{{
                tag
              }}</BFormTag>
            </li>
          </ul>
          <BFormSelect
            v-bind="inputAttrs"
            v-on="inputHandlers"
            :disabled="disabled || availableOptions.length === 0"
            :options="availableOptions"
          >
            <template #first>
              <!-- This is required to prevent bugs with Safari -->
              <option disabled value="">Choose a tag...</option>
            </template>
          </BFormSelect>
        </template>
      </BFormTags>
    </BFormGroup>
  </div>
</template>

<script setup lang="ts">
const value = ref<string[]>([])
const options = ref<string[]>([
  'Apple',
  'Orange',
  'Banana',
  'Lime',
  'Peach',
  'Chocolate',
  'Strawberry',
])
const availableOptions = computed(() => {
  return options.value.filter((opt) => customPredefinedTags.value.indexOf(opt) === -1)
})
</script>

If the custom input is using custom event names that mimic input and change, and/or needs the .native modifier for keydown, you can do something similar to below to bind the event handlers:

vue

<template #default="{inputAttrs, inputHandlers, removeTag, tags}">
  <custom-input
    :id="inputAttrs.id"
    :custom-value-prop="inputAttrs.value"
    @custom-input-event="inputHandlers.input($event)"
    @custom-change-event="inputHandlers.change($event)"
    @keydown.native="inputHandlers.keydown($event)"
  ></custom-input>
  <template v-for="tag in tags">
    <!-- Your custom tag list here -->
  </template>
</template>

The inputHandlers.input handler must be bound to an event that updates with each character entered by the user for the as-you-type tag validation to work.

Advanced custom rendering usage

In situations where the inputHandlers will not work with your custom input, or if you need greater control over tag creation, you can take advantage of the additional properties provided via the default slot's scope.

Disable

Duplicate tag value cannot be added again!

There are no tags specified. Add a new tag above.

HTML

vue

<template>
  <div>
    <BFormCheckbox switch size="lg" v-model="disabled">Disable</BFormCheckbox>
    <BFormTags
      v-model="advancedTags"
      @input="resetInputValue()"
      tag-variant="success"
      class="mb-2 mt-2"
      :disabled="disabled"
      no-outer-focus
      placeholder="Enter a new tag value and click Add"
      :state="state"
    >
      <template v-slot="{tags, inputId, placeholder, disabled, addTag, removeTag}">
        <BInputGroup>
          <!-- Always bind the id to the input so that it can be focused when needed -->
          <BFormInput
            v-model="newTag"
            :id="inputId"
            :placeholder="placeholder"
            :disabled="disabled"
            :formatter="formatter"
          ></BFormInput>
          <BInputGroupText>
            <BButton @click="addTag(newTag)" :disabled="disabled" variant="primary">Add</BButton>
          </BInputGroupText>
        </BInputGroup>
        <BFormInvalidFeedback :state="advancedState">
          Duplicate tag value cannot be added again!
        </BFormInvalidFeedback>
        <ul v-if="tags.length > 0" class="mb-0">
          <li v-for="tag in tags" :key="tag" :title="`Tag: ${tag}`" class="mt-2">
            <span class="d-flex align-items-center">
              <span class="me-2">{{ tag }}</span>
              <BButton
                :disabled="disabled"
                size="sm"
                variant="outline-danger"
                @click="removeTag(tag)"
              >
                remove tag
              </BButton>
            </span>
          </li>
        </ul>
        <BFormText v-else> There are no tags specified. Add a new tag above. </BFormText>
      </template>
    </BFormTags>
  </div>
</template>

<script setup lang="ts">
const newTag = ref<string>('')
const disabled = ref<boolean>(false)
const value = ref<string[]>([])
const state = computed(() => {
  // Return false (invalid) if new tag is a duplicate
  return value.value.indexOf(newTag.value.trim()) > -1 ? false : null
})
const resetInputValue = () => {
  newTag.value = ''
}
const formatter = (value) => {
  return value.toUpperCase()
}
</script>

The following is an example of using the <BDropdown> component for choosing or searching from a pre-defined set of tags:

Tagged input using dropdown

HTML

vue

<template>
  <div>
    <BFormGroup label="Tagged input using dropdown" label-for="tags-with-dropdown">
      <BFormTags id="tags-with-dropdown" v-model="value" no-outer-focus class="mb-2">
        <template v-slot="{tags, disabled, addTag, removeTag}">
          <ul v-if="tags.length > 0" class="list-inline d-inline-block mb-2">
            <li v-for="tag in tags" :key="tag" class="list-inline-item">
              <BFormTag @remove="removeTag(tag)" :title="tag" :disabled="disabled" variant="info">{{
                tag
              }}</BFormTag>
            </li>
          </ul>

          <BDropdown size="sm" variant="outline-secondary" block menu-class="w-100" no-caret>
            <template #button-content> &#x1f50d; <span>Choose tags</span> </template>
            <BDropdownForm @submit.stop.prevent="() => {}">
              <BFormGroup
                label="Search tags"
                label-for="tag-search-input"
                label-cols-md="auto"
                class="mb-0"
                label-size="sm"
                :description="searchDesc"
                :disabled="disabled"
              >
                <BFormInput
                  v-model="search"
                  id="tag-search-input"
                  type="search"
                  size="sm"
                  autocomplete="off"
                ></BFormInput>
              </BFormGroup>
            </BDropdownForm>
            <BDropdownDivider></BDropdownDivider>
            <BDropdownItemButton
              v-for="option in availableOptions"
              :key="option"
              @click="onOptionClick({option, addTag})"
            >
              {{ option }}
            </BDropdownItemButton>
            <BDropdownText v-if="availableOptions.length === 0">
              There are no tags available to select
            </BDropdownText>
          </BDropdown>
        </template>
      </BFormTags>
    </BFormGroup>
  </div>
</template>

<script setup lang="ts">
const options = ref<string[]>([
  'Apple',
  'Orange',
  'Banana',
  'Lime',
  'Peach',
  'Chocolate',
  'Strawberry',
])
const search = ref<string>('')
const value = ref<string[]>([])

const criteria = computed(() => search.value.trim().toLowerCase())
const availableOptions = computed(() => {
  const searchCriteria = criteria.value

  // Filter out already selected options
  const optionsFiltered = options.value.filter((opt) => value.value.indexOf(opt) === -1)
  if (searchCriteria) {
    // Show only options that match criteria
    return optionsFiltered.filter((opt) => opt.toLowerCase().indexOf(searchCriteria) > -1)
  }
  // Show all options available
  return optionsFiltered
})
const searchDesc = computed(() => {
  if (criteria.value && availableOptions.value.length === 0) {
    return 'There are no tags matching your search criteria'
  }
  return ''
})
const onOptionClick = ({option, addTag}) => {
  addTag(option)
  search.value = ''
}
</script>

Creating wrapper components

You can easily create a custom wrapper component with your preferred rendering style as follows:

vue

<template>
  <BFormTags :value="modelValue">
    <template v-slot="{tags, addTag, removeTag, inputAttrs, inputHandlers}">
      <!-- Place your custom rendering here -->
    </template>
  </BFormTags>
</template>

<script setup lang="ts">

defineProps({
  modelValue: string[]
})

const value = ref<string[]>([])
</script>

`<BFormTag>` helper component

BootstrapVueNext provides the helper component <BFormTag>, for use with the default scoped slot of <BFormTags>. The component is based upon <BBadge> and <BButton>.

<BFormTag> supports the same variants as <BBadge> and also supports pill styling. Sizing is based on the containing element's font-size.

The remove event is emitted when the <BFormTag> remove button is clicked.

Tags that are too wide for their parent container will automatically have their text content truncated with an ellipsis. For this reason, it is always good practice to supply a title via the title prop when using the default slot of <BFormTag> for the tag content.

Note <BFormTag> requires BootstrapVueNext's custom CSS/SCSS for proper styling.

Component Reference

<BFormTag>

View Source

<BFormTag> Properties
<BFormTag> Events
<BFormTag> Slots

Properties

Prop	Type	Default	Description
disabled	`boolean`	`false`	When set to `true`, disables the component's functionality and places it in a disabled state
id	`string`	`undefined`	Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed
no-remove	`boolean`	`false`	When set, the tag will not have a remove button
pill	`boolean`	`false`	Makes the tag have a pill appearance
remove-label	`string`	`'Remove tag'`	The value of the 'aria-label' attribute on the remove button in the tag
tag	`string`	`'<span>'`	Specify the HTML tag to render instead of the default tag
title	`string`	`undefined`	Value to place in the 'title' attribute of the tag. Will also be used for the tag content if no default slot provided
variant	`ColorVariant \| null`	`'secondary'`	Applies one of the Bootstrap theme color variants to the component. When implemented `bg-variant` and `text-variant` will take precedence

Events

Event	Args	Description
remove	`remove: string` - text of the tag to remove	Emitted when the remove button is clicked

Slots

Name	Scope	Description
default		Content to place in the tag. Overrides the `title` prop

<BFormTags>

View Source

<BFormTags> Properties
<BFormTags> Events
<BFormTags> Slots

Properties

Prop	Type	Default	Description
add-button-text	`string`	`'Add'`	Text for the built in 'Add' button. Slot `add-button-text` takes precedence
add-button-variant	`ButtonVariant \| null`	`'outline-secondary'`	Applies one of the Bootstrap theme color variants to the 'Add' button
add-on-change	`boolean`	`false`	When set, enables adding the tag on the input's 'change' event
autofocus	`boolean`	`false`	When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control
disabled	`boolean`	`false`	When set to `true`, disables the component's functionality and places it in a disabled state
duplicate-tag-text	`string`	`'Duplicate tag(s)'`	The message when duplicate tags are detected. Set to an empty string to disable the message
form	`string`	`undefined`	ID of the form that the form control belongs to. Sets the `form` attribute on the control
input-attrs	`Readonly<AttrsValue>`	`undefined`	Additional attributes to apply to the new tag input element
input-class	`ClassValue`	`undefined`	Class (or classes) to apply to the new tag input element
input-id	`string`	`undefined`	Id to apply to the new tag input element. If not provided, a unique Id will be auto generated
input-type	`InputType`	`'text'`	Specifies the type of input to use: 'text', 'email', 'tel', 'url', or 'number'. Default is 'text'
invalid-tag-text	`string`	`'Invalid tag(s)'`	The error message when invalid tags are detected. Set to an empty string to disable the message
limit	`Numberish`	`undefined`	The maximum amount of tags that can be added. The limit can still be exceeded if manipulated outside of the component
limit-tags-text	`string`	`'Tag limit reached'`	The message when the limit is reached. Set to an empty string to disable the message
model-value	`string[]`	`'() => []'`
name	`string`	`undefined`	Sets the value of the 'name' attribute on the form control. When set, creates a hidden input for each tag
no-add-on-enter	`boolean`	`false`	When set, disables adding the tag on the input's 'keydown.enter' event
no-outer-focus	`boolean`	`false`	When set, disables the focus styling of the component root element
no-tag-remove	`boolean`	`false`	When set, the tags will not have a remove button
placeholder	`string`	`'Add tag...'`	Sets the `placeholder` attribute value on the form control
remove-on-delete	`boolean`	`false`	When set, enables removal of last tag in tags when user presses delete or backspace and the input is empty
required	`boolean`	`undefined`	Adds the `required` attribute to the form control
separator	`string \| readonly string[]`	`undefined`	Separator character(s) that will trigger a tag to be created
size	`Size`	`'md'`	Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'
state	`boolean \| null`	`undefined`	Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state
tag-class	`ClassValue`	`undefined`	Class (or classes) to apply to the tags
tag-pills	`boolean`	`false`	Makes the built in tags have a pill appearance
tag-remove-label	`string`	`undefined`	The value of the 'aria-label' attribute on the remove button in the tag
tag-removed-label	`string`	`'Tag removed'`
tag-validator	`(t: string) => boolean`	`'() => true'`	Optional tag validator method. Passed a single argument of tag being added. Should return 'true' if the tag passes validation, or 'false' if the tag cannot be added
tag-variant	`ColorVariant \| null`	`'secondary'`	Applies one of the Bootstrap theme color variants to the tags

Events

Event	Args	Description
blur	`event: FocusEvent` - Native blur event (before any formatting)	Emitted when component loses focus
focus	`event: FocusEvent` - Native focus event (before any formatting)	Emitted when component gains focus
focusin	`event: FocusEvent` - Native focusin event (before any formatting)	Emitted when internal elements of component gain focus.
focusout	`event: FocusEvent` - Native focusout event (before any formatting)	Emitted when internal elements of component lose focus.
tag-state	`valid-tags: Array` - Array of new tag(s) added (or that will be added). Will be zero length if no tags added `invalid-tags: Array` - Array of tag(s) that cannot be added because they did not pass validation. Will be zero length if no invalid tags `duplicate-tags: Array` - Array of tag(s) that cannot be added because they would be a duplicate tag. Will be zero length if no duplicate tags	Emitted when tags in the user input are parsed
update:model-value	`value: Array` - Array of current tags	Emitted when the tags changes. Updates the v-model

Slots

Name	Scope	Description
addButtonText		Content to place in the built in 'Add' button. Takes precedence over the 'add-button-text' prop. Not used when the default scoped slot is provided
default	`add-button-text: string` - Value of the 'add-button-text' prop `add-button-variant: string` - Value of the 'add-button-variant' prop `add-tag: (tag?: string) => void` - Method to add a new tag. Assumes the tag is the value of the input, but optionally accepts one argument which is the tag value to be added `disable-add-button: boolean` - Will be `true` if the tag(s) in the input cannot be added (all invalid and/or duplicates) `disabled: boolean` - If the component is in the disabled state. Value of the 'disabled' prop `duplicate-tag-text: string` - The value of the 'duplicate-tag-text' prop `duplicate-tags: Array` - Array of duplicate tag(s) that could not be added `form: string` - Value of the 'form' prop `input-attrs: Record<string, unknown>` - Object of attributes to apply to native input elements via 'v-bind="inputAttrs"' `input-class: ClassValue` - Class (or classes) to apply to the new tag input element. Value of the 'input-class' prop `input-handlers: Object` - Object of event handlers to apply to native input elements via 'v-on="inputHandlers"' `input-id: string` - Id to add to the new tag input element. Defaults to prop 'input-id'. If not provided a unique Id is auto-generated. Also available via 'inputAttrs.id' `input-type: InputType` - The type of input to use: 'type', 'email', 'tel', 'url', or 'number'. Default is 'text'. Normalized value of the 'input-type' prop `invalid-tag-text: string` - The value of the 'invalid-tag-text' prop `invalid-tags: Array` - Array of invalid tag(s) that could not be added. Requires a validator function via the 'tag-validator' prop `is-duplicate: boolean` - Will be `true` if the user has attempted to add duplicate tag(s) `is-invalid: boolean` - Will be `true` if the input has invalid tag(s). Requires a validator function via the 'tag-validator' prop `is-limit-reached: boolean` - Will be `true` if the input has reached the maximum amount of tags defined by the 'limit' prop `limit-tags-text: string` - The value of the 'limit-tag-text' prop `no-tag-remove: boolean` - The value of the 'no-tag-remove' prop `placeholder: string` - The value of the 'placeholder' prop Not yet implemented: `remove: () => void` - Method to fully reset the tags input `remove-tag: (tag?: string) => void` - Method to remove a tag. Accepts one argument which is the tag value to remove `required: boolean` - Value of the 'required' prop `separator: string \| readonly string[]` - The value of the 'separator' prop `size: Size` - The value of the 'size' prop `state: boolean \| null` - The contextual state of the component. Value of the 'state' prop. Possible values are true, false or null `tag-class: ClassValue` - Class (or classes) to apply to the tag elements. Value of the 'tag-class' prop `tag-pills: boolean` - Value of the `tag-pills` prop `tag-remove-label: string` - ARIA label for the remove button on tags. Value of the 'tag-remove-label' prop `tag-removed-label: string` - Value of the 'tag-removed-label' prop `tag-variant: ColorVariant` - Value of the 'tag-variant' prop `tag-validator: (t: string) => boolean` - Value of the 'tag-variant' prop `tag-variant: ColorVariant \| null` - Value of the 'tag-variant' prop	Slot to override the default rendering of the tags component
tag	`tag: string` - Value of the tag `tag-class: ClassValue` - Class (or classes) to apply to the tag element `tag-variant: ColorVariant \| null` - Color variant to apply to the tag `tag-pills: boolean` - Render the tag as a pill `remove-tag: (tag?: string) => void` - Method to remove a tag. Accepts one argument which is the tag value to remove	Slot to override the default rendering an individual tag

Form Tags ​

Basic usage ​

Tag creation using separators ​

Last tag removal via backspace keypress ​

Styling Options ​

Using with native browser <form> submission ​

Tag validation ​

Detecting new, invalid, and duplicate tags ​

Limiting tags ​

Custom rendering with default scoped slot ​

Scope properties ​

inputAttrs object properties ​

inputHandlers object properties ​

Using native browser inputs ​

Using custom form components ​

Advanced custom rendering usage ​

Creating wrapper components ​

<BFormTag> helper component ​

Component Reference

Properties

Events

Slots

Properties

Events

Slots

Form Tags

Basic usage

Tag creation using separators

Last tag removal via backspace keypress

Styling Options

Using with native browser `<form>` submission

Tag validation

Detecting new, invalid, and duplicate tags

Limiting tags

Custom rendering with default scoped slot

Scope properties

`inputAttrs` object properties

`inputHandlers` object properties

Using native browser inputs

Using custom form components

Advanced custom rendering usage

Creating wrapper components

`<BFormTag>` helper component