Vue Autocomplete

Autocomplete is a text box that displays suggestions while a user types. This demo shows how to customize the Autocomplete component and handle value changes.

DevExtreme Accessibility Compliance

DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo’s accessibility level, click the Run AXE^® Validation button to launch the AXE^® web accessibility evaluation tool.

All trademarks or registered trademarks are property of their respective owners. AXE^® Terms of Use

The overall accessibility level of your application depends on the Autocomplete features used.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

<template> <div class="form"> <div class="dx-fieldset"> <div class="dx-fieldset-header">Default Mode</div> <div class="dx-field"> <div class="dx-field-label">First Name</div> <div class="dx-field-value"> <DxAutocomplete :data-source="names" v-model:value="firstName" placeholder="Type first name..." @value-changed="updateEmployeeInfo" /> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">With Clear Button</div> <div class="dx-field"> <div class="dx-field-label">Last Name</div> <div class="dx-field-value"> <DxAutocomplete :data-source="surnames" v-model:value="lastName" :show-clear-button="true" placeholder="Type last name..." @value-changed="updateEmployeeInfo" /> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Disabled</div> <div class="dx-field"> <div class="dx-field-label">Position</div> <div class="dx-field-value"> <DxAutocomplete :data-source="positions" :value="position" :disabled="true" :input-attr="{ 'aria-label': 'Position' }" /> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Custom Item Template and Data Source Usage</div> <div class="dx-field"> <div class="dx-field-label">State</div> <div class="dx-field-value"> <DxAutocomplete :data-source="states" v-model:value="state" value-expr="State_Long" placeholder="Type state name..." item-template="stateTemplate" @value-changed="updateEmployeeInfo" > <template #stateTemplate="{ data }"> <span>{{ data.State_Long }} ({{ data.State_Short }})</span> </template> </DxAutocomplete> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Custom Store and Search Options</div> <div class="dx-field"> <div class="dx-field-label">Current Client</div> <div class="dx-field-value"> <DxAutocomplete :data-source="clientsStore" v-model:value="currentClient" :min-search-length="2" :search-timeout="500" placeholder="Type client name..." value-expr="Text" @value-changed="updateEmployeeInfo" /> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Event Handling</div> <div class="employees-data"> Employee data: <span>{{ fullInfo }}</span> </div> </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; import ODataStore from 'devextreme/data/odata/store'; import { DxAutocomplete } from 'devextreme-vue/autocomplete'; import CustomStore from 'devextreme/data/custom_store'; import 'whatwg-fetch'; import { names, surnames, positions } from './data.ts'; const statesStore = new ODataStore({ version: 2, url: 'https://js.devexpress.com/Demos/DevAV/odata/States?$select=Sate_ID,State_Long,State_Short', key: 'Sate_ID', keyType: 'Int32', }); const clientsCustomStore = new CustomStore({ key: 'Value', useDefaultSearch: true, load(loadOptions) { let params = '?'; [ 'skip', 'take', 'filter', ].forEach((option) => { if (option in loadOptions && isNotEmpty(loadOptions[option])) { params += `${option}=${JSON.stringify(loadOptions[option])}&`; } }); params = params.slice(0, -1); return fetch(`https://js.devexpress.com/Demos/Mvc/api/DataGridWebApi/CustomersLookup${params}`) .then((response) => response.json()) .then((data) => ({ data: data.data, })) .catch(() => { throw new Error('Data Loading Error'); }); }, }); const firstName = ref(''); const lastName = ref(''); const position = ref(positions[0]); const state = ref(''); const currentClient = ref(''); const fullInfo = ref(''); const states = ref(statesStore); const clientsStore = ref(clientsCustomStore); function updateEmployeeInfo() { let employeeInfo = ''; employeeInfo += `${firstName.value || ''} ${lastName.value || ''}`.trim(); employeeInfo += (employeeInfo && position) ? `, ${position.value}` : position.value || ''; employeeInfo += (employeeInfo && state.value) ? `, ${state.value}` : state.value || ''; employeeInfo += (employeeInfo && currentClient.value) ? `, ${currentClient.value}` : currentClient.value || ''; fullInfo.value = employeeInfo; } function isNotEmpty(value) { return value !== undefined && value !== null && value !== ''; } </script> <style> .employees-data { padding-top: 16px; padding-bottom: 10px; } </style>

export const names = ['James', 'John', 'Robert', 'Michael', 'William', 'David', 'Richard', 'Charles', 'Joseph', 'Thomas', 'Christopher', 'Daniel', 'Paul', 'Mark', 'Donald', 'George', 'Kenneth', 'Steven', 'Edward', 'Brian', 'Ronald', 'Anthony', 'Kevin', 'Jason', 'Jeff', 'Mary', 'Patricia', 'Linda', 'Barbara', 'Elizabeth', 'Jennifer', 'Maria', 'Susan', 'Margaret', 'Dorothy', 'Lisa', 'Nancy', 'Karen', 'Betty', 'Helen', 'Sandra', 'Donna', 'Carol', 'Ruth', 'Sharon', 'Michelle', 'Laura', 'Sarah', 'Kimberly', 'Deborah']; export const surnames = ['Anderson', 'Smith', 'Johnson', 'Williams', 'Jones', 'Brown', 'Davis', 'Miller', 'Wilson', 'Moore', 'Taylor', 'Thomas', 'Jackson', 'White', 'Harris', 'Martin', 'Thompson', 'Garcia', 'Martinez', 'Robinson', 'Clark', 'Rodriguez', 'Lewis', 'Lee', 'Walker', 'Hall', 'Allen', 'Young', 'Hernandez', 'King', 'Wright', 'Lopez', 'Hill', 'Scott', 'Green', 'Adams', 'Baker', 'Gonzalez', 'Nelson', 'Carter', 'Mitchell', 'Perez', 'Roberts', 'Turner', 'Phillips', 'Campbell', 'Parker', 'Evans', 'Edwards', 'Collins', ]; export const positions = ['CEO', 'COO', 'CTO', 'CMO', 'HR Manager', 'IT Manager', 'Controller', 'Sales Manager', 'Support Manager'];

import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.6/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>

Bind Autocomplete to Data

Use one of the following properties to supply data to the component:

items[]
Accepts a local data array.
dataSource
Accepts a local data array, DataSource object, or DevExtreme data store. In this demo, every Autocomplete component is bound to a local array, except the following components:
- "Custom Item Template and Data Source Usage"
  Uses an ODataStore.
- "Custom Store and Search Options"
  Uses a CustomStore.

The value property stores the selected item. You can use the same property to select an item programmatically, as shown in the "Disabled" Autocomplete component.

If the data source contains objects, you should specify the valueExpr property. It accepts a data field name that uniquely identifies each data object. In this demo, valueExpr is specified only for the "Custom Item Template and Data Source Usage" and "Custom Store and Search Options" components because other components are bound to arrays of primitive values.

Configure Search Parameters

When a user types the first character, Autocomplete displays suggestions. To increase the number of characters that triggers suggestions, use the minSearchLength property. You can also specify the time interval Autocomplete should wait before it displays suggestions. Assign this time interval in milliseconds to the searchTimeout property. See the "Custom Store and Search Options" Autocomplete component for an example.

In most cases, the data field that supplies Autocomplete with suggestions is the same data field that is used to search for the entered text. If you use two different fields, assign the field that supplies Autocomplete with suggestions to the valueExpr property and the field used to search to the searchExpr property. Note that searchExpr also accepts arrays if you want to search multiple fields.

Handle Value Change

To handle value changes, implement the onValueChanged function. In this demo, we use onValueChanged to display the values of all Autocomplete components.

Appearance Customization

You can specify the following properties to customize the Autocomplete component's appearance:

placeholder
The text that is displayed when Autocomplete is empty.
showClearButton
Adds a Clear button that empties the Autocomplete value as shown in the "With Clear Button" Autocomplete component.
disabled
Disables the component.
itemTemplate
Customizes the appearance of the Autocomplete suggestions. See the "Custom Item Template and Data Source Usage" component for an example.