A Lookup is a predictive text input that presents a dropdown menu with suggestions based on the current input value.
Use the Lookup component to let users search through a dataset to choose a predefined value for a form field. This can be useful when there are many options the user can choose from, so they need to filter the items via a text query.
Lookup includes the following elements:
A TextInput where the user types to look for the suggested results. This can optionally include a start icon, clear button, and placeholder text.
- Dropdown menu
Suggested results are displayed via the Menu component.
Refer to the Lookup component in Codex Figma.
An input field featuring an optional placeholder will enable users to initiate their search for suggested results. These suggestions will be displayed within a dropdown menu, and if the menu cannot fully accommodate the results, a scrollbar with the choice of infinite scroll can be included.
Clearable, with start icon
An optional start icon and clear button could appear within the input field.
With custom menu item display
Custom content and formats can be applied to change the appearance of menu items according to your needs.
If there are no results for the text typed by the user, a non-interactive "no results" message will be displayed within the menu.
Lookup within a form field
A Lookup can be wrapped within a Field to include features like label, description, help text, or validation messages.
Interaction can take place within both the input and the displayed menu:
- Filled active (with a menu item selected)
The Lookup component will emit
input events on input, which the parent component should react to by computing or fetching menu items, then providing those items to the Lookup component for display by updating the
Items are displayed via the MenuItem component—see the MenuItem docs for more options. In this example, a
menuConfig object is passed to the Lookup to bold the label text.
Note that in this example, menu items are Wikidata items with a human-readable label and a Wikidata entity ID value.
The parent component must update the
menu-items prop after each
input event, otherwise the Lookup component will stay in the pending state indefinitely. If there are no results for the given input, set the
menu-items prop to an empty array (
With custom menu item display
menu-item slot can be used to set up custom menu item content and formatting.
With "no results" content
A non-interactive "no results" message can be displayed via the
no-results slot. If populated, this slot will automatically display when there are zero menu items.
With fetched results and infinite scroll
Often, Lookup is used to fetch results from an API endpoint. Parent components should react to the
input event emitted by Lookup to search for results, then pass back to the Lookup either an array of results to display as menu items or an empty array if there are no results. Between those two events, a pending state animation will display in the input.
Scrolling is enabled by setting the
visibleItemLimit property of the
With scrolling enabled, when the user nears the end of the list of results, a
load-more event is emitted. The parent component can react to this by fetching more results and appending them to the list of menu items provided to the Lookup. These new items will then be displayed within the menu.
Clearable, with start icon
Props of the TextInput component can be bound to Lookup and will be passed down to the TextInput component inside of it, so you can take advantage of features like the "clear" button and icons.
Attributes (except for
class) will fall through to the input element, so you can set things like
placeholder on the Lookup component and they'll be applied to the input.
A Lookup can be wrapped in the Field component to add features like a semantic label, description and help text, validation messages, and more. See the Field page for more information.
Search Wikidata items
Start typing the name of a Wikidata item to see suggestions
Typical use of this component will involve listening for
input events, fetching or otherwise computing menu items, then passing those menu items back to the Lookup for display.
TextInput props apply
This component contains a TextInput component. You can bind TextInput props to this component and they will be passed to the TextInput within.
Attributes passed to input
This component will pass any HTML attributes applied to it, except for CSS class, to the
<input> element within the component.
|Value of the current selection.|
Must be bound with
The property should be initialized to
|Initial value of the text input.||-|
|Whether the entire component is disabled.||-|
|Configuration for various menu features. All properties default to false.|
See the MenuConfig type.
|event ||When an input value change is committed by the user (e.g. on blur)|
|When the user scrolls towards the bottom of the menu.|
If it is possible to add or load more menu items, then now would be a good moment so that the user can experience infinite scrolling.
|selected ||When the selected value changes.|
|value ||When the text input value changes.|
|event ||When the input comes into focus|
|event ||When the input loses focus|
|menu-item||Display of an individual item in the menu||menu-item |
|no-results||Message to show if there are no results to display.|
There is no true CSS-only version of the Lookup component. However, a CSS-only TextInput component can be used instead, since it has visual parity with the Lookup component with its menu collapsed. For example, you could display a CSS-only TextInput on page load while a Vue app loads, then replace it with the Vue Lookup component once the Vue app has mounted.
The example below is a simple text input with a placeholder, but icons and different states are supported—see the TextInput docs for more information.