@angular/aria/combobox

Combobox

directive

The container element that wraps a combobox input and popup, and orchestrates its behavior.

API

    
      class Combobox extends DeferredContentAware implements OnInit {}

element

HTMLElement

A reference to the input element.

disabled

InputSignalWithTransform<boolean, unknown>

Whether the combobox is disabled.

softDisabled

InputSignalWithTransform<boolean, unknown>

Whether the combobox is soft disabled (remains focusable).

alwaysExpanded

InputSignalWithTransform<boolean, unknown>

Whether the combobox should always remain expanded.

tabIndex

InputSignalWithTransform<number | undefined, string | number | undefined>

The tabindex of the combobox.

expanded

ModelSignal<boolean>

Whether the combobox is expanded.

value

ModelSignal<string>

The value of the combobox input.

inlineSuggestion

InputSignal<string | undefined>

An inline suggestion to be displayed in the input.

ngOnInit

void

@returnsvoid

contentVisible

WritableSignal<boolean>

preserveContent

ModelSignal<boolean>

Description

The container element that wraps a combobox input and popup, and orchestrates its behavior.

The ngCombobox directive is the main entry point for creating a combobox and customizing its behavior. It coordinates the interactions between the input and the popup.

<div ngCombobox [(expanded)]="expanded">
  <input ngComboboxInput />

  <ng-template ngComboboxPopup>
    <div ngComboboxWidget>
      <!-- ... options ... -->
    </div>
  </ng-template>
</div>