The HTML aria-autocomplete attribute
The aria-autocomplete attribute describes how a textbox or combobox predicts input. Values: none, inline (completes in the field), list (shows a list of suggestions), or both. It is for custom widgets, not the native autocomplete attribute.
Overview
The aria-autocomplete attribute indicates what kind of autocomplete a text input or combobox provides.
It is a widget property: a declaration about the widget that is normally set once, rather than a state that changes as the user interacts. Because ARIA does nothing on its own, keep it accurate and update it in JavaScript if the widget's behavior does change; a stale value is worse than none. And wherever a native element already expresses the same thing (a <textarea> for multi-line input, the required or readonly attribute, a native multiple select), use that instead.
Like all ARIA, aria-autocomplete changes only the accessibility tree (what assistive technology perceives), never the element's behavior or appearance. The first rule of ARIA applies: if a native HTML element or attribute conveys this, use that instead, and only reach for ARIA when nothing native fits.
Syntax
<input role="combobox" aria-autocomplete="list" aria-expanded="false">
Values
| Value |
|---|
| none | inline | list | both |
Example
<input role="combobox" aria-autocomplete="both" aria-expanded="false" aria-controls="opts">
Best practices
- Follow the first rule of ARIA: use a native HTML element or attribute that conveys this where one exists, rather than adding ARIA.
- Set it to match the behavior you actually implement, and change it only if that behavior changes.
- Use the matching native attribute where one exists (
required,readonly,multiple) instead of the ARIA version. - Set it only on an element whose role actually supports this property.