Skip to main content
The CdkListbox provides behavior for accessible listbox patterns.

Installation

npm install @angular/cdk
import {CdkListboxModule} from '@angular/cdk/listbox';

Basic Usage

<div cdkListbox [(cdkListboxValue)]="selectedValue">
  <div cdkOption="1">Option 1</div>
  <div cdkOption="2">Option 2</div>
  <div cdkOption="3">Option 3</div>
</div>

Multi-Selection

<div cdkListbox [cdkListboxMultiple]="true" [(cdkListboxValue)]="selectedValues">
  <div cdkOption="apple">Apple</div>
  <div cdkOption="banana">Banana</div>
  <div cdkOption="orange">Orange</div>
</div>

API Reference

cdkListbox

InputTypeDescription
cdkListboxValueanySelected value(s)
cdkListboxMultiplebooleanAllow multiple selection
cdkListboxDisabledbooleanDisable listbox
OutputTypeDescription
cdkListboxValueChangeanyValue change event

cdkOption

InputTypeDescription
cdkOptionanyOption value
cdkOptionDisabledbooleanDisable option

See Also

Build docs developers (and LLMs) love