Theme

Pro installation quickstart 🚀

The taglist input allows users to search through a list of options and apply any number of tags. Users can also drag and drop tags to re-order:

The options prop can accept three different formats of values:

  • An array of objects with value and label keys (see example above)
  • An array of strings ['A', 'B', 'C']
  • An object literal with key-value pairs { a: 'A', b: 'B', c: 'C' }
  • A function that returns any of the above
Empty options

If you assign options as an empty array, the input will be rendered in a disabled state.

Basic example

The taglist input allows users to search through a list of options and apply any number of tags. Users can also drag and drop tags to re-order:

Load live example

Filtering

The taglist input will filter options with its own internal search function. You can replace this search function by providing the filter prop a function of your own. Your function will receive two arguments, the option being iterated over and the current search value:

Load live example

Allow new values

The taglist input, unlike the dropdown or autocomplete inputs, allows you to enter an arbitrary value (a value not in the list of options). This is useful for creating new tags on the fly. To enable this feature, set the allow-new-values prop to true.

Load live example

Dynamic options

Instead of passing a static list to the options prop, you can assign it to a function. Doing so is useful when you need to load options from an API or another source.

Search parameter

In this example, we'll assign the options prop the searchMovies function. By doing so, searchMovies will receive the context object as an argument. Within this context object is the search property, which is the current search value. To perform our search, we'll use the search value as the query parameter for our API request:

Load live example

Page and hasNextPage parameters

A likely scenario you'll encounter is needing to search through a paginated API. This can be done by referencing the same context object as before. Within this object, we can utilize the page and hasNextPage properties. The page property is the current page number, and the hasNextPage property is a function to be called when there are more pages to load:

Load live example

Loading Style

Instead of requiring your users to click the Load more button to load additional options, you can set the loadOnScroll prop to true, which will paginate options as you scroll to the bottom of the options list.

Option loader

Rehydrating values

FormKit's taglist input also provides an optionLoader prop that allows you to rehydrate values that are not in the options list. In this example, we'll provide the taglist an initial value (a movie ID), and assign the optionLoader to a function that will make a request to the API to get the movie:

Load live example

Notice in the example above that the optionLoader function is passed two arguments: the value of the selected option (in this case, the movie ID) and the cachedOption. The cachedOption is used for preventing unnecessary lookups. If the cachedOption is not null it means that the selected option has already been loaded, and you can return the cachedOption directly.

Loading Style

Instead of requiring your users to click the Load more button to load additional options, you can set the loadOnScroll prop to true, which will paginate options as you scroll to the bottom of the options list.

Load on created

If you would rather load options when the taglist is created, you can set the load-on-created prop to true, and our function, loadCurrentlyPopularMovies will be called without the user needing to expand the listbox:

Load live example

Tag appearance

Just like the taglist input or Autocomplete input, the taglist input allows you to utilize slots to customize the look and feel of the options list and the selected option by leveraging the renderless component pattern.

In this example, we are going to use the tag slot to customize the look of the tags:

Load live example

Behavioral props

Empty message

The taglist input, by default, will not expand the listbox when no search results are found while filtering. You can change this behavior by assigning the empty-message prop a message to display when no results are found:

Load live example

Max

The max prop allows you to limit the number of options that can be selected. When the max limit is reached, the taglist input will disable the listbox:

Load live example

Close on select

If you would like the taglist's listbox to remain open in between selections, set the close-on-select prop to false:

Load live example

Reload on commit

If you want the options to be reloaded (with static options, this would filter the options with the value of empty string, and with dynamic options, this would make a request to the options loader with the value of empty string) when the user commits a selection, use the reload-on-commit prop:

Load live example

Open on click

To enable opening the taglist's listbox on click of its search input, set the open-on-click prop to true:

Load live example

Open on focus

If you would like to open the taglist's listbox anytime its search input is focused, set the open-on-focus prop to true:

Load live example
Open on focus vs Open on click

Open on focus encompasses open on click.

Open on remove

If you want the listbox to expand when an selection is removed, use the open-on-remove prop:

Load live example

Full example

Now let's combine what we've learned so far by leveraging the tag slot for custom markup, and setting the options prop to a function that will return pages of movies from an API:

Load live example

Props & Attributes

PropTypeDefaultDescription
debouncenumber200Number of milliseconds to debounce calls to an options function.
optionsany[]The list of options the user can select from.
load-on-scrollbooleanfalseWhen set to `true`, the taglist will try loading more options based on the end-user`s scroll position
open-on-clickbooleanfalseThe autocomplete is expanded upon focus of the input, as opposed to waiting to expand until a search value is entered.
filterfunctionnullUsed to apply your own custom filter function for static options.
option-loaderfunctionnullUsed for hydrating initial value, or performing an additional request to load more information of a selected option.
allow-new-valuesbooleanfalseAllows end-user to enter a new value that does not exist within the options list.
disable-drag-and-dropbooleantrueDisabled end-user from sorting tags by dragging and dropping.
empty-messagestringundefinedRenders a message when there are no options to display.
maxnumberundefinedLimits the number of options that can be selected.
close-on-selectbooleantrueCloses the listbox when an option is selected.
open-on-removebooleanfalseWhen the `selection-removable` prop is set to `true`, the taglist will not open after the selected value is removed. You can change this behavior by setting the `open-on-remove` prop to `true`.
open-on-focusbooleanfalse
options-appearancestringundefinedFor multi-select taglists, this prop allows you to customize the look and feel of the selected options. Possible values are `default` (the default) or `checkbox`.
always-load-on-openbooleantrueDetermines whether the taglist should always load its options when opened or whether it should reference the options that were previously found when opening.
load-on-createdbooleanfalseWhen set to `true`, the taglist will load the options when the node is created.
popoverbooleanfalseRenders the input's listbox using the browser Popover API.
Show Universal props
configObject{}Configuration options to provide to the input’s node and any descendent node of this input.
delayNumber20Number of milliseconds to debounce an input’s value before the commit hook is dispatched.
dirtyBehaviorstringtouchedDetermines how the "dirty" flag of this input is set. Can be set to touched or comparetouched (the default) is more performant, but will not detect when the form is once again matching its initial state.
errorsArray[]Array of strings to show as error messages on this field.
helpString''Text for help text associated with the input.
idStringinput_{n}The unique id of the input. Providing an id also allows the input’s node to be globally accessed.
ignoreBooleanfalsePrevents an input from being included in any parent (group, list, form etc). Useful when using inputs for UI instead of actual values.
indexNumberundefinedAllows an input to be inserted at the given index if the parent is a list. If the input’s value is undefined, it inherits the value from that index position. If it has a value it inserts it into the lists’s values at the given index.
labelString''Text for the label element associated with the input.
nameStringinput_{n}The name of the input as identified in the data object. This should be unique within a group of fields.
parentFormKitNodecontextualBy default the parent is a wrapping group, list or form — but this props allows explicit assignment of the parent node.
prefix-iconString''Specifies an icon to put in the prefixIcon section.
preservebooleanfalsePreserves the value of the input on a parent group, list, or form when the input unmounts.
preserve-errorsbooleanfalseBy default errors set on inputs using setErrors are automatically cleared on input, setting this prop to true maintains the error until it is explicitly cleared.
sections-schemaObject{}An object of section keys and schema partial values, where each schema partial is applied to the respective section.
suffix-iconString''Specifies an icon to put in the suffixIcon section.
typeStringtextThe type of input to render from the library.
validationString, Array[]The validation rules to be applied to the input.
validation-visibilityStringblurDetermines when to show an input's failing validation rules. Valid values are blur, dirty, and live.
validation-labelString{label prop}Determines what label to use in validation error messages, by default it uses the label prop if available, otherwise it uses the name prop.
validation-rulesObject{}Additional custom validation rules to make available to the validation prop.
valueAnyundefinedSeeds the initial value of an input and/or its children. Not reactive. Can seed entire groups (forms) and lists..
Section-keyDescription
selectorThe selector section is a button element that opens the taglist options list.
selectionsContains individual selection sections.
selectionContains the selected option.
listitemA list item element that contains the option section.
optionA div that contains the option content.
listboxThe listbox section is a ul element that contains the options list.
taglistWrapperWraps the listbox section. A div that handles scrolling the listbox.
optionLoadingA span element that is conditionally rendered within the selected option when loading is occurring.
loaderIconAn element for outputting an icon in the selector element when loading is occurring.
selectIconAn element for outputting an icon in the selector element when the taglist is closed.
loadMoreA list item element that is conditionally rendered at the bottom of the options list when there are more pages to load.
loadMoreInnerA span element that acts as a wrapper for the loaderIcon within the loadMore section.
removeSelectionA button element used for removing a specific selection.
closeIconAn element for outputting an icon within the removeSelection button.
listboxButtonA button element that is used to open the taglist.
emptyMessageA list item element that is conditionally rendered when there are no options to display.
emptyMessageInnerA span element that acts as a wrapper for the emptyMessage section.
Show Universal section keys
outerThe outermost wrapping element.
wrapperA wrapper around the label and input.
labelThe label of the input.
prefixHas no output by default, but allows content directly before an input element.
prefixIconAn element for outputting an icon before the prefix section.
innerA wrapper around the actual input element.
suffixHas no output by default, but allows content directly after an input element.
suffixIconAn element for outputting an icon after the suffix section.
inputThe input element itself.
helpThe element containing help text.
messagesA wrapper around all the messages.
messageThe element (or many elements) containing a message — most often validation and error messages.

Accessibility

All FormKit inputs are designed with the following accessibility considerations in mind. Help us continually improve accessibility for all by filing accessibility issues here:

Semantic markupAria attributesKeyboard accessibleFocus indicatorsColor contrast with the provided themeAccessible labels, help text, and errors
Section KeyAttributeDefaultDescription
inputtabindex0Prioritizes keyboard focus order by setting it to 0.
rolecomboboxIndicates to assistive technologies that this element functions as a combobox.
readonlyRestrict user edits, ensuring data integrity and a controlled, informative user experience.
aria-autocompletelistGuides input suggestions, presenting a collection of values that could complete the user's input.
aria-expandedConveys the expandable state when the element is in focus.
aria-controlsAssociates the listbox element, with this element.
aria-describedbyAssociates an element with a description, aiding screen readers.
aria-activedescendantManage focus to the current active descendent element.
listboxButtontabindex-1Prioritizes keyboard focus order by setting it to -1.
aria-haspopuptrueSignals that an element triggers a pop-up or menu
aria-expandedConveys the expandable state when the element is in focus.
aria-controlsAssociates the listbox element, with this element.
tagWrappertabindex-1Prioritizes keyboard focus order by setting it to -1.
tagrolebuttonIndicates to assistive technologies that this element functions as a button.
tagsaria-livepoliteCommunicates dynamic content changes when selections are on the screen.
removeSelectiontabindex-1Removes the prioritization of keyboard focus on this element.
aria-controlsAssociates the input element, with this element.
Show Universal section key
labellabelforAssociates the label to an input element. Users can click on the label to focus the input or to toggle between states.
inputinputdisabledDisables an HTML element, preventing user interaction and signaling a non-interactive state.
aria-describedbyAssociates an element with a description, aiding screen readers.
aria-requiredAdds this attribute when validation is required.
iconiconforWhenever icon is defined as a label it links it to an input element.

Keyboard Interactions

Keyboard EventDescription
TabMoves the focus to the next focusable input on the page.
Shift + TabMoves the focus to the previous focusable input on the page.