<datalist>: The HTML Data List element
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The <datalist>
HTML element contains a set of <option>
elements that represent the permissible or recommended options available to choose from within other controls.
Try it
To bind the <datalist>
element to the control, we give it a unique identifier in the id
attribute, and then add the list
attribute to the <input>
element with the same identifier as value.
Only certain types of <input>
support this behavior, and it can also vary from browser to browser.
Each <option>
element should have a value
attribute, which represents a suggestion to be entered into the input. It can also have a label
attribute, or, missing that, some text content, which may be displayed by the browser instead of value
(Firefox), or in addition to value
(Chrome and Safari, as supplemental text). The exact content of the drop-down menu depends on the browser, but when clicked, content entered into control field will always come from the value
attribute.
Note: <datalist>
is not a replacement for <select>
. A <datalist>
does not represent an input itself; it is a list of suggested values for an associated control. The control can still accept any value that passes vaildation, even if it is not in this suggestion list.
Attributes
This element has no other attributes than the global attributes, common to all elements.
Accessibility
When deciding to use the <datalist>
element, here are some accessibility issues to be mindful of:
- The font size of the data list's options does not zoom, always remaining the same size. The contents of the autosuggest do not grow or shrink when the rest of the contents are zoomed in or out.
- As targeting the list of options with CSS is very limited to non-existent, rendering can not be styled for high-contrast mode.
- Some screen reader/browser combinations, including NVDA and Firefox, do not announce the contents of the autosuggest popup.
Examples
Textual types
Recommended values in types text, search, url, tel, email and number, are displayed in a drop-down menu when user clicks or double-clicks on the control. Typically the right side of a control will also have an arrow pointing to the presence of predefined values.
<label for="myBrowser">Choose a browser from this list:</label>
<input list="browsers" id="myBrowser" name="myBrowser" />
<datalist id="browsers">
<option value="Chrome"></option>
<option value="Firefox"></option>
<option value="Opera"></option>
<option value="Safari"></option>
<option value="Microsoft Edge"></option>
</datalist>
Date and Time types
The types month, week, date, time and datetime-local can show an interface that allows a convenient selection of a date and time. Predefined values can be shown there, allowing the user to quickly fill the control value.
Note: When type is not supported, text
type creating simple text field will be used instead. That field will correctly recognize recommended values and display them to the user in a drop-down menu.
<input type="time" list="popularHours" />
<datalist id="popularHours">
<option value="12:00"></option>
<option value="13:00"></option>
<option value="14:00"></option>
</datalist>
Range type
The recommended values in the range type will be shown as series of hash marks that the user can easily select.
<label for="tick">Tip amount:</label>
<input type="range" list="tickmarks" min="0" max="100" id="tick" name="tick" />
<datalist id="tickmarks">
<option value="0"></option>
<option value="10"></option>
<option value="20"></option>
<option value="30"></option>
</datalist>
Color type
The color type can show predefined colors in a browser-provided interface.
<label for="colors">Pick a color (preferably a red tone):</label>
<input type="color" list="redColors" id="colors" />
<datalist id="redColors">
<option value="#800000"></option>
<option value="#8B0000"></option>
<option value="#A52A2A"></option>
<option value="#DC143C"></option>
</datalist>
Password type
The specification allows linking <datalist>
with a password type, but no browser supports it for security reasons.
<label for="pwd">Enter a password:</label>
<input type="password" list="randomPassword" id="pwd" />
<datalist id="randomPassword">
<option value="5Mg[_3DnkgSu@!q#"></option>
</datalist>
Technical summary
Content categories | Flow content, phrasing content. |
---|---|
Permitted content |
Either
phrasing content
or zero or more <option> elements.
|
Tag omission | None, both the starting and ending tag are mandatory. |
Permitted parents | Any element that accepts phrasing content. |
Implicit ARIA role | listbox |
Permitted ARIA roles | No role permitted |
DOM interface | HTMLDataListElement |
Specifications
Specification |
---|
HTML Standard # the-datalist-element |
Browser compatibility
BCD tables only load in the browser