Listbox Example with Grouped Options

The following example implementation of the 설계 패턴 for listbox demonstrates a single-select listbox widget with grouped options. This widget is functionally similar to an HTML select element with size greater than 1 and options grouped into categories with labeled optgroup elements.

유사한 예는 다음과 같습니다:

Example

Choose your animal sidekick
  • Cat
  • Dog
  • Tiger
  • Reindeer
  • Raccoon
  • Dolphin
  • Flounder
  • Eel
  • Falcon
  • Winged Horse
  • Owl

Notes

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

  1. Scrolling only works as expected if the listbox is the options' offsetParent. The example uses position: relative on the listbox to that effect.
  2. 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.
  3. When a fully visible option is focused in any way, no scrolling occurs.
  4. Normal scrolling through any scrolling mechanism (including Page Up and Page Down) works as expected. The scroll position will jump as described for focusItem if a means other than a mouse click is used to change focus after scrolling.

키보드 지원

The example listboxes on this page implement the following keyboard interface. Other variations and options for the keyboard interface are described in the Keyboard Interaction section of the Listbox 설계 패턴.

키 기능
Down Arrow Moves focus to and selects the next option.
Up Arrow Moves focus to and selects the previous option.
Home Moves focus to and selects the first option.
End Moves focus to and selects the last option.

Role, Property, State, Tabindex 어트리뷰트

The example listboxes on this page implement 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 설계 패턴.

역할(role) 어트리뷰트 엘리먼트 사용법
listbox div Identifies the focusable element that has listbox behaviors and contains the listbox options.
aria-labelledby="ID_REF" div Refers to the element containing the listbox label.
tabindex="0" div Includes the listbox in the page tab sequence.
aria-activedescendant="ID_REF" div
  • Tells assistive technologies which of the options, if any, is visually indicated as having keyboard focus.
  • DOM focus remains on the ul element and the idref specified for aria-activedescendant refers to the li element that is visually styled as focused.
  • When navigation keys, such as Down Arrow, are pressed, the JavaScript changes the value.
group ul Identifies a group of related options
aria-labelledby="ID_REF" ul Refers to the element containing the option group label.
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와 CSS 소스 코드

HTML Source Code