Listbox
A widget that allows the user to select one or more items from a list of choices.
🤖 AI Implementation GuideDemo
Single-Select (Default)
Selection follows focus. Use arrow keys to navigate and select.
- Apple
- Banana
- Cherry
- Date
- Elderberry
- Fig
- Grape
Selected: None
Multi-Select
Focus and selection are independent. Use Space to toggle, Shift+Arrow to extend selection.
- Red
- Orange
- Yellow
- Green
- Blue
- Indigo
- Purple
Selected: None
Tip: Use Space to toggle, Shift+Arrow to extend selection, Ctrl+A to select all
Horizontal Orientation
Use Left/Right arrow keys for navigation.
- Apple
- Banana
- Cherry
- Date
- Elderberry
Selected: None
Accessibility Features
WAI-ARIA Roles
| Role | Target Element | Description |
|---|---|---|
listbox | Container (<ul>) | Widget for selecting one or more items from a list |
option | Each item (<li>) | Selectable option within the listbox |
WAI-ARIA listbox role (opens in new tab)
WAI-ARIA Properties
| Attribute | Target | Values | Required | Description |
|---|---|---|---|---|
aria-label | listbox | String | Yes* | Accessible name for the listbox |
aria-labelledby | listbox | ID reference | Yes* | References the labeling element |
aria-multiselectable | listbox | true | No | Enables multi-select mode |
aria-orientation | listbox | "vertical" | "horizontal" | No | Navigation direction (default: vertical) |
* Either aria-label or aria-labelledby is required
WAI-ARIA States
aria-selected
Indicates whether an option is selected.
| Target | option |
| Values | true | false |
| Required | Yes |
| Change Trigger | Click, Arrow keys (single-select), Space (multi-select) |
| Reference | aria-selected (opens in new tab) |
aria-disabled
Indicates that an option is not selectable.
| Target | option |
| Values | true |
| Required | No (only when disabled) |
| Reference | aria-disabled (opens in new tab) |
Keyboard Support
Common Navigation
| Key | Action |
|---|---|
| Down Arrow / Up Arrow | Move focus (vertical orientation) |
| Right Arrow / Left Arrow | Move focus (horizontal orientation) |
| Home | Move focus to first option |
| End | Move focus to last option |
| Type character | Type-ahead: focus option starting with typed character(s) |
Single-Select (Selection Follows Focus)
| Key | Action |
|---|---|
| Arrow keys | Move focus and selection simultaneously |
| Space / Enter | Confirm current selection |
Multi-Select
| Key | Action |
|---|---|
| Arrow keys | Move focus only (selection unchanged) |
| Space | Toggle selection of focused option |
| Shift + Arrow | Move focus and extend selection range |
| Shift + Home | Select from anchor to first option |
| Shift + End | Select from anchor to last option |
| Ctrl + A | Select all options |
Focus Management
This component uses the Roving Tabindex pattern for focus management:
- Only one option has
tabindex="0"at a time - Other options have
tabindex="-1" - Arrow keys move focus between options
- Disabled options are skipped during navigation
- Focus does not wrap (stops at edges)
Selection Model
- Single-select: Selection follows focus (arrow keys change selection)
- Multi-select: Focus and selection are independent (Space toggles selection)
Source Code
<template>
<ul
ref="listboxRef"
role="listbox"
:aria-multiselectable="multiselectable || undefined"
:aria-orientation="orientation"
:aria-label="ariaLabel"
:aria-labelledby="ariaLabelledby"
:tabindex="listboxTabIndex"
:class="containerClass"
@keydown="handleKeyDown"
>
<li
v-for="option in options"
:key="option.id"
:ref="(el) => setOptionRef(option.id, el)"
role="option"
:id="getOptionId(option.id)"
:aria-selected="selectedIds.has(option.id)"
:aria-disabled="option.disabled || undefined"
:tabindex="getTabIndex(option)"
:class="getOptionClass(option)"
@click="!option.disabled && handleOptionClick(option.id)"
>
<span class="apg-listbox-option-icon" aria-hidden="true">
<svg viewBox="0 0 12 12" xmlns="http://www.w3.org/2000/svg">
<path
d="M10.28 2.28a.75.75 0 00-1.06-1.06L4.5 5.94 2.78 4.22a.75.75 0 00-1.06 1.06l2.25 2.25a.75.75 0 001.06 0l5.25-5.25z"
fill="currentColor"
/>
</svg>
</span>
{{ option.label }}
</li>
</ul>
</template>
<script setup lang="ts">
import { ref, computed, onMounted, nextTick } from 'vue';
export interface ListboxOption {
id: string;
label: string;
disabled?: boolean;
}
export interface ListboxProps {
options: ListboxOption[];
multiselectable?: boolean;
orientation?: 'vertical' | 'horizontal';
defaultSelectedIds?: string[];
ariaLabel?: string;
ariaLabelledby?: string;
typeAheadTimeout?: number;
}
const props = withDefaults(defineProps<ListboxProps>(), {
multiselectable: false,
orientation: 'vertical',
defaultSelectedIds: () => [],
typeAheadTimeout: 500,
});
const emit = defineEmits<{
selectionChange: [selectedIds: string[]];
}>();
const listboxRef = ref<HTMLElement>();
const optionRefs = ref<Record<string, HTMLLIElement>>({});
const instanceId = ref('');
const selectedIds = ref<Set<string>>(new Set());
const focusedIndex = ref(0);
const selectionAnchor = ref(0);
const typeAheadBuffer = ref('');
const typeAheadTimeoutId = ref<number | null>(null);
const availableOptions = computed(() => props.options.filter((opt) => !opt.disabled));
// Map of option id to index in availableOptions for O(1) lookup
const availableIndexMap = computed(() => {
const map = new Map<string, number>();
availableOptions.value.forEach(({ id }, index) => map.set(id, index));
return map;
});
onMounted(() => {
instanceId.value = `listbox-${Math.random().toString(36).slice(2, 11)}`;
// Initialize selection
if (props.defaultSelectedIds.length > 0) {
selectedIds.value = new Set(props.defaultSelectedIds);
} else if (availableOptions.value.length > 0) {
// Single-select mode: select first available option by default
if (!props.multiselectable) {
selectedIds.value = new Set([availableOptions.value[0].id]);
}
}
// Initialize focused index and sync anchor
const firstSelectedId = [...selectedIds.value][0];
if (firstSelectedId) {
const index = availableOptions.value.findIndex((opt) => opt.id === firstSelectedId);
if (index >= 0) {
focusedIndex.value = index;
selectionAnchor.value = index;
}
}
});
const setOptionRef = (id: string, el: unknown) => {
if (el instanceof HTMLLIElement) {
optionRefs.value[id] = el;
} else if (el === null) {
// Clean up ref when element is unmounted
delete optionRefs.value[id];
}
};
// If no available options, listbox itself needs tabIndex for keyboard access
const listboxTabIndex = computed(() => (availableOptions.value.length === 0 ? 0 : undefined));
const getOptionId = (optionId: string) => `${instanceId.value}-option-${optionId}`;
const containerClass = computed(() => {
const classes = ['apg-listbox'];
if (props.orientation === 'horizontal') {
classes.push('apg-listbox--horizontal');
}
return classes.join(' ');
});
const getOptionClass = (option: ListboxOption) => {
const classes = ['apg-listbox-option'];
if (selectedIds.value.has(option.id)) {
classes.push('apg-listbox-option--selected');
}
if (option.disabled) {
classes.push('apg-listbox-option--disabled');
}
return classes.join(' ');
};
const getTabIndex = (option: ListboxOption): number => {
if (option.disabled) return -1;
const availableIndex = availableIndexMap.value.get(option.id) ?? -1;
return availableIndex === focusedIndex.value ? 0 : -1;
};
const updateSelection = (newSelectedIds: Set<string>) => {
selectedIds.value = newSelectedIds;
emit('selectionChange', [...newSelectedIds]);
};
const focusOption = async (index: number) => {
const option = availableOptions.value[index];
if (option) {
focusedIndex.value = index;
await nextTick();
optionRefs.value[option.id]?.focus();
}
};
const selectOption = (optionId: string) => {
if (props.multiselectable) {
const newSelected = new Set(selectedIds.value);
if (newSelected.has(optionId)) {
newSelected.delete(optionId);
} else {
newSelected.add(optionId);
}
updateSelection(newSelected);
} else {
updateSelection(new Set([optionId]));
}
};
const selectRange = (fromIndex: number, toIndex: number) => {
const start = Math.min(fromIndex, toIndex);
const end = Math.max(fromIndex, toIndex);
const newSelected = new Set(selectedIds.value);
for (let i = start; i <= end; i++) {
const option = availableOptions.value[i];
if (option) {
newSelected.add(option.id);
}
}
updateSelection(newSelected);
};
const selectAll = () => {
const allIds = new Set(availableOptions.value.map((opt) => opt.id));
updateSelection(allIds);
};
const handleTypeAhead = (char: string) => {
// Guard: no options to search
if (availableOptions.value.length === 0) return;
if (typeAheadTimeoutId.value !== null) {
clearTimeout(typeAheadTimeoutId.value);
}
typeAheadBuffer.value += char.toLowerCase();
const buffer = typeAheadBuffer.value;
const isSameChar = buffer.length > 1 && buffer.split('').every((c) => c === buffer[0]);
let startIndex = focusedIndex.value;
if (isSameChar) {
typeAheadBuffer.value = buffer[0];
startIndex = (focusedIndex.value + 1) % availableOptions.value.length;
}
for (let i = 0; i < availableOptions.value.length; i++) {
const index = (startIndex + i) % availableOptions.value.length;
const option = availableOptions.value[index];
const searchStr = isSameChar ? buffer[0] : typeAheadBuffer.value;
if (option.label.toLowerCase().startsWith(searchStr)) {
focusOption(index);
// Update anchor for shift-selection
selectionAnchor.value = index;
if (!props.multiselectable) {
updateSelection(new Set([option.id]));
}
break;
}
}
typeAheadTimeoutId.value = window.setTimeout(() => {
typeAheadBuffer.value = '';
typeAheadTimeoutId.value = null;
}, props.typeAheadTimeout);
};
const handleOptionClick = (optionId: string) => {
const index = availableIndexMap.value.get(optionId) ?? -1;
focusOption(index);
selectOption(optionId);
selectionAnchor.value = index;
};
const handleKeyDown = async (event: KeyboardEvent) => {
// Guard: no options to navigate
if (availableOptions.value.length === 0) return;
const { key, shiftKey, ctrlKey, metaKey } = event;
const nextKey = props.orientation === 'vertical' ? 'ArrowDown' : 'ArrowRight';
const prevKey = props.orientation === 'vertical' ? 'ArrowUp' : 'ArrowLeft';
if (props.orientation === 'vertical' && (key === 'ArrowLeft' || key === 'ArrowRight')) {
return;
}
if (props.orientation === 'horizontal' && (key === 'ArrowUp' || key === 'ArrowDown')) {
return;
}
let newIndex = focusedIndex.value;
let shouldPreventDefault = false;
switch (key) {
case nextKey:
if (focusedIndex.value < availableOptions.value.length - 1) {
newIndex = focusedIndex.value + 1;
}
shouldPreventDefault = true;
if (props.multiselectable && shiftKey) {
await focusOption(newIndex);
selectRange(selectionAnchor.value, newIndex);
event.preventDefault();
return;
}
break;
case prevKey:
if (focusedIndex.value > 0) {
newIndex = focusedIndex.value - 1;
}
shouldPreventDefault = true;
if (props.multiselectable && shiftKey) {
await focusOption(newIndex);
selectRange(selectionAnchor.value, newIndex);
event.preventDefault();
return;
}
break;
case 'Home':
newIndex = 0;
shouldPreventDefault = true;
if (props.multiselectable && shiftKey) {
await focusOption(newIndex);
selectRange(selectionAnchor.value, newIndex);
event.preventDefault();
return;
}
break;
case 'End':
newIndex = availableOptions.value.length - 1;
shouldPreventDefault = true;
if (props.multiselectable && shiftKey) {
await focusOption(newIndex);
selectRange(selectionAnchor.value, newIndex);
event.preventDefault();
return;
}
break;
case ' ':
shouldPreventDefault = true;
if (props.multiselectable) {
const focusedOption = availableOptions.value[focusedIndex.value];
if (focusedOption) {
selectOption(focusedOption.id);
selectionAnchor.value = focusedIndex.value;
}
}
event.preventDefault();
return;
case 'Enter':
shouldPreventDefault = true;
event.preventDefault();
return;
case 'a':
case 'A':
if ((ctrlKey || metaKey) && props.multiselectable) {
shouldPreventDefault = true;
selectAll();
event.preventDefault();
return;
}
break;
}
if (shouldPreventDefault) {
event.preventDefault();
if (newIndex !== focusedIndex.value) {
await focusOption(newIndex);
if (!props.multiselectable) {
const newOption = availableOptions.value[newIndex];
if (newOption) {
updateSelection(new Set([newOption.id]));
}
} else {
selectionAnchor.value = newIndex;
}
}
return;
}
if (key.length === 1 && !ctrlKey && !metaKey) {
event.preventDefault();
handleTypeAhead(key);
}
};
</script> Usage
<script setup>
import Listbox from './Listbox.vue';
const options = [
{ id: 'apple', label: 'Apple' },
{ id: 'banana', label: 'Banana' },
{ id: 'cherry', label: 'Cherry' },
];
const handleSelectionChange = (ids) => {
console.log('Selected:', ids);
};
</script>
<template>
<!-- Single-select -->
<Listbox
:options="options"
aria-label="Choose a fruit"
@selection-change="handleSelectionChange"
/>
<!-- Multi-select -->
<Listbox
:options="options"
multiselectable
aria-label="Choose fruits"
@selection-change="handleSelectionChange"
/>
</template> API
Props
| Prop | Type | Default | Description |
|---|---|---|---|
options | ListboxOption[] | required | Array of options |
multiselectable | boolean | false | Enable multi-select mode |
orientation | 'vertical' | 'horizontal' | 'vertical' | Listbox orientation |
defaultSelectedIds | string[] | [] | Initially selected option IDs |
Events
| Event | Payload | Description |
|---|---|---|
selection-change | string[] | Emitted when selection changes |
Testing
Tests verify APG compliance across keyboard interaction, ARIA attributes, and accessibility requirements.
Test Categories
High Priority: APG Keyboard Interaction
| Test | Description |
|---|---|
ArrowDown/Up | Moves focus between options (vertical orientation) |
ArrowRight/Left | Moves focus between options (horizontal orientation) |
Home/End | Moves focus to first/last option |
Disabled skip | Skips disabled options during navigation |
Selection follows focus | Single-select: arrow keys change selection |
Space toggle | Multi-select: Space toggles option selection |
Shift+Arrow | Multi-select: extends selection range |
Shift+Home/End | Multi-select: selects from anchor to first/last |
Ctrl+A | Multi-select: selects all options |
Type-ahead | Character input focuses matching option |
Type-ahead cycle | Repeated same character cycles through matches |
High Priority: APG ARIA Attributes
| Test | Description |
|---|---|
role="listbox" | Container has listbox role |
role="option" | Each option has option role |
aria-selected | Selected options have aria-selected="true" |
aria-multiselectable | Listbox has attribute when multi-select enabled |
aria-orientation | Reflects horizontal/vertical orientation |
aria-disabled | Disabled options have aria-disabled="true" |
aria-label/labelledby | Listbox has accessible name |
High Priority: Focus Management (Roving Tabindex)
| Test | Description |
|---|---|
tabIndex=0 | Focused option has tabIndex=0 |
tabIndex=-1 | Non-focused options have tabIndex=-1 |
Disabled tabIndex | Disabled options have tabIndex=-1 |
Focus restoration | Focus returns to correct option on re-entry |
Medium Priority: Accessibility
| Test | Description |
|---|---|
axe violations | No WCAG 2.1 AA violations (via jest-axe) |
Testing Tools
- Vitest (opens in new tab) - Test runner
- Testing Library (opens in new tab) - Framework-specific testing utilities
- jest-axe (opens in new tab) - Automated accessibility testing
See testing-strategy.md (opens in new tab) for full documentation.
Resources
- WAI-ARIA APG: Listbox Pattern (opens in new tab)
- AI Implementation Guide (llm.md) (opens in new tab) - ARIA specs, keyboard support, test checklist