@angular/aria/listbox

Listbox

Class

A listbox container.

API

    
      class Listbox<V> {}

id

any

A unique identifier for the listbox.

textDirection

any

A signal wrapper for directionality.

items

any

The Option UIPatterns of the child Options.

orientation

any

Whether the list is vertically or horizontally oriented.

multi

any

Whether multiple items in the list can be selected at once.

wrap

any

Whether focus should wrap when navigating.

skipDisabled

any

Whether disabled items in the list should be skipped when navigating.

focusMode

any

The focus strategy used by the list.

selectionMode

any

The selection strategy used by the list.

typeaheadDelay

any

The amount of time before the typeahead search is reset.

disabled

any

Whether the listbox is disabled.

readonly

any

Whether the listbox is readonly.

value

any

The values of the current selected items.

onFocus

void

@returnsvoid

scrollActiveItemIntoView

void

@paramoptionsScrollIntoViewOptions

@returnsvoid

Description

A listbox container.

Listboxes are used to display a list of items for a user to select from. The Listbox is meant to be used in conjunction with Option as follows:

<ul ngListbox>  <li [value]="1" ngOption>Item 1</li>  <li [value]="2" ngOption>Item 2</li>  <li [value]="3" ngOption>Item 3</li></ul>