@angular/aria/listbox

Option

directive

A selectable option in an ngListbox.

API

    
      class Option<V> implements OnInit ,OnDestroy {}

element

HTMLElement

A reference to the host element.

active

Signal<any>

Whether the option is currently active (focused).

id

InputSignal<any>

A unique identifier for the option.

value

InputSignal<V>

The value of the option.

disabled

InputSignalWithTransform<boolean, unknown>

Whether an item is disabled.

label

InputSignal<string | undefined>

The text used by the typeahead search.

selected

Signal<any>

Whether the option is selected.

This directive should be applied to an element (e.g., <li>, <div>) within an ngListbox. The value input is used to identify the option, and the label input provides the accessible name for the option.

<li ngOption value="item-id" label="Item Name">
  Item Name
</li>