The autocomplete input allows you to search through a list of options.
The options prop can accept three different formats of values:
value and label keys (see example above)['A', 'B', 'C']{ a: 'A', b: 'B', c: 'C' }If you assign options as an empty array, the input will be rendered in a disabled state.
By default, the autocomplete input will render in single-select mode:
By setting the multiple prop the autocomplete input will render in multi-select mode:
Notice in the example above that because the multiple prop is set, the value prop must be an array.
The autocomplete 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:
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.
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:
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:
FormKit's autocomplete 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 autocomplete 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:
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 prop 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.
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.
If you would rather load options when the autocomplete 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:
The autocomplete input allows you to customize the look and feel of each option by using the option slot. In this example, we are using the option slot to display each option's asset; logo and name:
The autocomplete input allows you to customize the look and feel of the selected option.
The autocomplete input allows you to customize the look and feel of the selected option by using the selection-appearance prop. For either the single-select or multi-select
autocomplete, you can set the selection-appearance prop to text-input (default) or option:
If you only want to customize the display of the selected option, set the selection appearance to option.
The autocomplete 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:
If you would like the listbox to remain expanded after selecting a value, you can set close-on-select to false.
If you want the options to be reloaded when the user commits a selection, use the reload-on-commit prop:
To enable opening the autocomplete's listbox on click of its search input, set the open-on-click prop to true:
If you would like to open the autocomplete's listbox anytime the input is clicked, set the open-on-focus prop to true:
If open-on-focus is used, open-on-click will implicitly be set.
For single-select autocompletes only, if you would like to clear the search input when the listbox is opened, set the clear-search-on-open:
For a single-select autocomplete, you can set the selection-removable prop. When set to true, a remove button will be displayed next to the selected option. This prop is by default set to true for autocompletes with selection appearance of option.
The selection-removable prop cannot be used for multi-selects.
If you want the listbox to expand when an selection is removed, use the open-on-remove prop:
If you would like to limit the number of options that can be selected, you can use the max prop:
Now let's combine what we've learned so far by leveraging the option slot for custom markup, and setting the options prop to a function that will return pages of movies from an API:
| Prop | Type | Default | Description |
|---|---|---|---|
| debounce | number | 200 | Number of milliseconds to debounce calls to an options function. |
| options | any | [] | The list of options the user can select from. |
| load-on-scroll | boolean | false | When set to `true`, the autocomplete will try loading more options based on the end-user`s scroll position |
| selection-appearance | string | text-input | Changes the way the option label is display. |
| multiple | boolean | false | Allows for multiple selections. |
| open-on-click | boolean | false | The autocomplete is expanded upon focus of the input, as opposed to waiting to expand until a search value is entered. |
| filter | function | null | Used to apply your own custom filter function for static options. |
| option-loader | function | null | Used for hydrating initial value, or performing an additional request to load more information of a selected option. |
| empty-message | string | undefined | Renders a message when there are no options to display. |
| max | number | undefined | Limits the number of options that can be selected. |
| open-on-remove | boolean | false | When the `selection-removable` prop is set to `true`, the autocomplete 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-focus | boolean | false | |
| options-appearance | string | undefined | For multi-select autocompletes, 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-open | boolean | false | When set to `true`, the autocomplete will always load the options when the listbox is opened. |
| load-on-created | boolean | false | When set to `true`, the autocomplete will load the options when the node is created. |
| clear-search-on-open | boolean | false | When set to `true`, the search input will be cleared when the listbox is opened. |
| max | number | string | undefined | If you would like to limit the number of options that can be selected, you can use the `max` prop (applies only to multi-select). |
| Show Universal props | |||
| config | Object | {} | Configuration options to provide to the input’s node and any descendent node of this input. |
| delay | Number | 20 | Number of milliseconds to debounce an input’s value before the commit hook is dispatched. |
| dirtyBehavior | string | touched | Determines how the "dirty" flag of this input is set. Can be set to touched or compare — touched (the default) is more performant, but will not detect when the form is once again matching its initial state. |
| errors | Array | [] | Array of strings to show as error messages on this field. |
| help | String | '' | Text for help text associated with the input. |
| id | String | input_{n} | The unique id of the input. Providing an id also allows the input’s node to be globally accessed. |
| ignore | Boolean | false | Prevents an input from being included in any parent (group, list, form etc). Useful when using inputs for UI instead of actual values. |
| index | Number | undefined | Allows 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. |
| label | String | '' | Text for the label element associated with the input. |
| name | String | input_{n} | The name of the input as identified in the data object. This should be unique within a group of fields. |
| parent | FormKitNode | contextual | By default the parent is a wrapping group, list or form — but this props allows explicit assignment of the parent node. |
| prefix-icon | String | '' | Specifies an icon to put in the prefixIcon section. |
| preserve | boolean | false | Preserves the value of the input on a parent group, list, or form when the input unmounts. |
| preserve-errors | boolean | false | By 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-schema | Object | {} | An object of section keys and schema partial values, where each schema partial is applied to the respective section. |
| suffix-icon | String | '' | Specifies an icon to put in the suffixIcon section. |
| type | String | text | The type of input to render from the library. |
| validation | String, Array | [] | The validation rules to be applied to the input. |
| validation-visibility | String | blur | Determines when to show an input's failing validation rules. Valid values are blur, dirty, and live. |
| validation-label | String | {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-rules | Object | {} | Additional custom validation rules to make available to the validation prop. |
| value | Any | undefined | Seeds the initial value of an input and/or its children. Not reactive. Can seed entire groups (forms) and lists.. |
You can target a specific section of an input using that section's "key", allowing you to modify that section's classes, HTML (via :sections-schema, or content (via slots)). Read more about sections here.
The autocomplete's structure changes depending on a few different scenarios:
selection-appearance has been set to text-input (the default) or option.multiple attribute.text-inputoption, single selectionoption, multiple selectionBelow is the inner options list (listbox) structure from the diagrams above:
| Section-key | Description |
|---|---|
| selector | The selector section is a button element that opens the dropdown options list. |
| selections | Contains individual selection sections. |
| selection | Contains the selected option. |
| listitem | A list item element that contains the option section. |
| option | A div that contains the option content. |
| listbox | The listbox section is a ul element that contains the options list. |
| dropdownWrapper | Wraps the listbox section. A div that handles scrolling the listbox. |
| optionLoading | A span element that is conditionally rendered within the selected option when loading is occurring. |
| loaderIcon | An element for outputting an icon in the selector element when loading is occurring. |
| selectIcon | An element for outputting an icon in the selector element when the dropdown is closed. |
| loadMore | A list item element that is conditionally rendered at the bottom of the options list when there are more pages to load. |
| loadMoreInner | A span element that acts as a wrapper for the loaderIcon within the loadMore section. |
| removeSelection | A button element used for removing a specific selection. |
| closeIcon | An element for outputting an icon within the removeSelection button. |
| listboxButton | A button element that is used to open the dropdown. |
| emptyMessage | A list item element that is conditionally rendered when there are no options to display. |
| emptyMessageInner | A span element that acts as a wrapper for the emptyMessage section. |
| Show Universal section keys | |
| outer | The outermost wrapping element. |
| wrapper | A wrapper around the label and input. |
| label | The label of the input. |
| prefix | Has no output by default, but allows content directly before an input element. |
| prefixIcon | An element for outputting an icon before the prefix section. |
| inner | A wrapper around the actual input element. |
| suffix | Has no output by default, but allows content directly after an input element. |
| suffixIcon | An element for outputting an icon after the suffix section. |
| input | The input element itself. |
| help | The element containing help text. |
| messages | A wrapper around all the messages. |
| message | The element (or many elements) containing a message — most often validation and error messages. |