(Deprecated) Collapsible Dropdown Listbox Example

Read This First

The code in this example is not intended for production environments. Before using it for any purpose, read this to understand why.

This is an illustrative example of one way of using ARIA that conforms with the ARIA specification.

There may be support gaps in some browser and assistive technology combinations, especially for mobile/touch devices. Testing code based on this example with assistive technologies is essential before considering use in production systems.
The ARIA and Assistive Technologies Project is developing measurements of assistive technology support for APG examples.
Robust accessibility can be further optimized by choosing implementation patterns that maximize use of semantic HTML and heeding the warning that No ARIA is better than Bad ARIA.

About This Example

Deprecation Warning

This pattern has been deprecated, and will be removed in a future version of the ARIA Authoring Practices. The select-only combobox should be used as an alternative to this pattern.

The following example implementation of the Listbox Pattern demonstrates a collapsible single-select listbox widget that is functionally similar to an HTML select input with the attribute size="1". The widget consists of a button that triggers the display of a listbox. In its default state, the widget is collapsed (the listbox is not visible) and the button label shows the currently selected option from the listbox. When the button is activated, the listbox is displayed and the current option is focused and selected.

Similar examples include:

Select-Only Combobox: A single-select combobox with no text input that is functionally similar to an HTML select element.
Scrollable Listbox Example: Single-select listbox that scrolls to reveal more options, similar to HTML select with size attribute greater than one.
Example Listboxes with Rearrangeable Options: Examples of both single-select and multi-select listboxes with accompanying toolbars where options can be added, moved, and removed.
Listbox Example with Grouped Options: Single-select listbox with grouped options, similar to an HTML select with optgroup children.

Example

Choose your favorite transuranic element (actinide or transactinide).

Notes

This listbox is scrollable; it has more options than its height can accommodate.

Scrolling only works as expected if the listbox is the options' offsetParent. The example uses position: relative on the listbox to that effect.
When an option is focused that isn't (fully) visible, the listbox's scroll position is updated:
1. If Up Arrow or Down Arrow is pressed, the previous or next option is scrolled into view.
2. If Home or End is pressed, the listbox scrolls all the way to the top or to the bottom.
3. If focusItem is called, the focused option will be scrolled to the top of the view if it was located above it or to the bottom if it was below it.
4. If the mouse is clicked on a partially visible option, it will be scrolled fully into view.
When a fully visible option is focused in any way, no scrolling occurs.

Keyboard Support

The example listbox on this page implements the following keyboard interface. Other variations and options for the keyboard interface are described in the Keyboard Interaction section of the Listbox Pattern.

Key	Function
`Enter`	If the focus is on the button, expands the listbox and places focus on the currently selected option in the list. If focus is in the listbox , collapses the listbox and keeps the currently selected option as the button label.
`Escape`	If the listbox is displayed, collapses the listbox and moves focus to the button.
`Down Arrow`	Moves focus to and selects the next option. If the listbox is collapsed, also expands the list.
`Up Arrow`	Moves focus to and selects the previous option. If the listbox is collapsed, also expands the list.
`Home`	If the listbox is displayed, moves focus to and selects the first option.
`End`	If the listbox is displayed, moves focus to and selects the last option.
Printable Characters	Type a character: focus moves to the next item with a name that starts with the typed character. Type multiple characters in rapid succession: focus moves to the next item with a name that starts with the string of characters typed.

Role, Property, State, and Tabindex Attributes

The example listbox on this page implements the following ARIA roles, states, and properties. Information about other ways of applying ARIA roles, states, and properties is available in the Roles, States, and Properties section of the Listbox Pattern.

Role	Attribute	Element	Usage
	`aria-labelledby="ID_REF1 ID_REF2"`	`button`	References the two elements whose labels are concatenated by the browser to label the button. The first element is a span containing text Choose an element: . The second element is the button itself; the button text is set to the name of the currently chosen element.
	`aria-haspopup="listbox"`	`button`	Indicates that activating the button displays a listbox.
	`aria-expanded="true"`	`button`	Set by the JavaScript when the listbox is displayed. Otherwise, is not present.
`listbox`		`ul`	Identifies the focusable element that has listbox behaviors and contains the listbox options.
	`aria-labelledby="ID_REF"`	`ul`	Refers to the element containing the listbox label.
	`tabindex="-1"`	`ul`	Makes the listbox focusable. The JavaScript sets focus on the listbox when it is displayed.
	`aria-activedescendant="ID_REF"`	`ul`	Set by the JavaScript when it displays and sets focus on the listbox; otherwise is not present. Refers to the option in the listbox that is visually indicated as having keyboard focus. When navigation keys, such as `Down Arrow`, are pressed, the JavaScript changes the value. Enables assistive technologies to know which element the application regards as focused while DOM focus remains on the `ul` element. For more information about this focus management technique, see Managing Focus in Composites Using aria-activedescendant.
`option`		`li`	Identifies each selectable element containing the name of an option.
	`aria-selected="true"`	`li`	Indicates that the option is selected. Applied to the element with role option that is visually styled as selected. The option with this attribute is always the same as the option that is referenced by aria-activedescendant because it is a single-select listbox where selection follows focus.

JavaScript and CSS Source Code

CSS: listbox.css
Javascript: listbox.js, listbox-collapsible.js, utils.js