Testland
Browse all skills & agents

aria-authoring-patterns

Reference for the W3C ARIA Authoring Practices Guide (APG) - covers the 31 canonical interactive-widget patterns (Combobox, Dialog, Menu, Tabs, Tree, etc.), their required ARIA roles and states, the keyboard-interaction model per pattern, and the canonical-violations to watch for. Use when authoring a custom interactive widget that doesn't have a native HTML equivalent, or when reviewing one for ARIA correctness.

aria-authoring-patterns

Overview

The W3C ARIA Authoring Practices Guide (APG) is the canonical reference for how to build accessible custom widgets - patterns where native HTML doesn't have a single matching element (apg-patterns).

The APG documents 31 patterns; each one specifies:

  • The required role attribute.
  • Required and optional aria-* states (e.g. aria-expanded, aria-selected, aria-current).
  • The full keyboard-interaction model (Tab / Arrow keys / Enter / Escape / Home / End / Type-ahead).
  • DOM structure conventions.
  • Common pitfalls.

When to use

  • Authoring a custom widget (Combobox, Tabs, Tree, Carousel, etc.).
  • Reviewing a third-party UI library's component for ARIA correctness.
  • Adding ARIA to an existing widget that was hand-rolled without it.
  • Configuring assertions in axe-a11y / pa11y-a11y to enforce per-pattern conventions.

The first rule of ARIA

The APG (and WAI more broadly) consistently emphasizes:

No ARIA is better than bad ARIA. Native HTML elements with built-in semantics are preferred over custom widgets whenever possible.

In practice:

Native elementDon't replace with
<button><div role="button"> - same semantics, more code, easier to break.
<input type="checkbox">Custom checkbox unless visual constraints demand it.
<a href><div onclick="navigate(...)">.
<select>Custom listbox UNLESS multi-select with rich content per option.
<input type="radio">Custom radio group.

When the visual design demands a custom widget, follow the matching APG pattern exactly.

Canonical patterns (APG)

The 31 patterns documented per apg-patterns:

Form controls

PatternWhen to useNative fallback
ButtonTrigger an action.<button> - almost always.
CheckboxTwo-state binary; or three-state (mixed).<input type="checkbox">.
ComboboxSearchable / filterable select with autocomplete.<select> for plain selection only.
DisclosureShow/hide content; one-way reveal.<details> / <summary>.
ListboxMulti-select OR rich-content single-select.<select> for plain.
Menu / MenubarApplication menus (File / Edit / View bar).(No native; APG required.)
Menu ButtonButton that opens a menu.(No native; APG required.)
Radio GroupMutually-exclusive option set.<input type="radio" name="x">.
SliderSingle-value within a range.<input type="range">.
Slider (Multi-Thumb)Range selection.(No native; APG required.)
SpinbuttonNumeric input with increment/decrement controls.<input type="number">.
SwitchOn/off toggle, semantically distinct from checkbox.(No native; APG required.)

Containers / navigation

PatternWhen to use
AccordionVertically-stacked list of headers; each expands.
BreadcrumbHierarchical-location indicator.
CarouselCycle through groups of equivalent content.
Dialog (Modal)Overlay requiring user interaction. (See wcag-focus-trap.)
Alert DialogModal that interrupts to convey urgency.
TabsSwitch between sibling content sections.
ToolbarGroup of controls (buttons, dropdowns).
Tree ViewHierarchical navigation.
TreegridHierarchical data grid (table rows that expand).
Window SplitterResize between two panes.

Feedback / indicators

PatternWhen to use
AlertImportant programmatically-determined message.
FeedDynamic stream of articles.
Grid2D widget for navigating tabular UI elements.
MeterScalar measurement within a known range.
TooltipBrief contextual hint on hover/focus.

Content

PatternWhen to use
LandmarksNavigation regions (<nav>, <main>, etc.).
LinkNavigation to a different resource.
TableTabular data (use <table>).

Per-pattern essentials

The APG's per-pattern documentation is detailed; for each pattern this skill highlights the load-bearing essentials.

Combobox

<label for="combo">Choose a fruit</label>
<input
  id="combo"
  role="combobox"
  aria-expanded="false"
  aria-controls="combo-listbox"
  aria-autocomplete="list"
  aria-activedescendant=""
/>
<ul id="combo-listbox" role="listbox" hidden>
  <li id="opt-1" role="option" aria-selected="false">Apple</li>
  <li id="opt-2" role="option" aria-selected="false">Banana</li>
</ul>
Required ARIAWhy
role="combobox"Identifies the input as a combobox.
aria-expandedTracks open/closed state.
aria-controlsLinks to the listbox ID.
aria-autocompletenone / inline / list / both.
aria-activedescendantTracks the focused option without moving DOM focus.

Tabs

<div role="tablist" aria-label="Settings sections">
  <button role="tab" id="tab-1" aria-selected="true" aria-controls="panel-1" tabindex="0">General</button>
  <button role="tab" id="tab-2" aria-selected="false" aria-controls="panel-2" tabindex="-1">Privacy</button>
</div>
<div role="tabpanel" id="panel-1" aria-labelledby="tab-1">...</div>
<div role="tabpanel" id="panel-2" aria-labelledby="tab-2" hidden>...</div>
KeyboardBehavior
TabOne tabstop for the whole tablist (only the active tab is tabindex="0").
Left/Right arrowNavigate between tabs.
Home / EndFirst / last tab.
Enter / SpaceActivate (or auto on focus per implementation).

Disclosure (Show/Hide)

<button aria-expanded="false" aria-controls="disclosure-1">More details</button>
<div id="disclosure-1" hidden>... content ...</div>

The simplest pattern; canonical native equivalent is <details> / <summary> - use that unless the visual design demands the button form.

Tooltip (per SC 1.4.13)

<button aria-describedby="tt-1">Save</button>
<div id="tt-1" role="tooltip" hidden>Save the current document</div>
Behavior
Show on hover OR focus.
Dismissable via Esc (per SC 1.4.13).
Hoverable - user can move pointer to tooltip text.
Persistent until pointer / focus leaves OR Esc dismisses.

(See wcag-color-contrast SC 1.4.13 for the three conditions.)

ARIA states reference

The most-used aria-* states across patterns:

StateUse
aria-expandedDisclosure / Accordion / Combobox / Menu Button.
aria-selectedListbox / Tab.
aria-checkedCheckbox / Radio.
aria-pressedToggle button.
aria-currentCurrent item in a set (page in pagination, item in breadcrumb).
aria-controlsElement that this trigger controls.
aria-labelledbyReference to the labelling element.
aria-describedbyReference to a description element (tooltip, hint).
aria-liveLive region; polite / assertive / off.
aria-invalidForm field validation state.
aria-requiredForm field required (with native required for forms).
aria-disabledFunctionally disabled but in tab order (vs. disabled attribute which removes from tab order).
aria-modalDialog modal flag; see wcag-focus-trap.

Common ARIA failures

FailureWhyFix
<div role="button"> without keyboard handlersCustom button needs tabindex="0" AND Enter/Space handlers.Use <button> OR add both.
aria-label on a <div> that has visible text labelRedundant; aria-label overrides the visible text for screen readers (becomes confusing).Use aria-labelledby referencing the visible text element.
aria-hidden="true" on a focusable elementElement is hidden from screen readers but still in tab order - broken state.If you want to hide, also remove from tab order.
Forgetting role="tab" / role="tabpanel" pairsScreen reader doesn't announce the relationship.Pair every tab with a panel via aria-controls / aria-labelledby.
Hand-rolled combobox without aria-activedescendantArrow keys don't announce options.Implement aria-activedescendant or move actual DOM focus.
role="presentation" on a meaningful containerRemoves semantics; sometimes used to "fix" a layout issue but breaks structure.Don't override structure to fix layout; fix layout.

Anti-patterns

Anti-patternWhy it failsFix
Inventing a custom pattern not in the APGNo screen-reader convention; users can't form expectations.Match an APG pattern exactly OR fall back to native HTML.
Mixing native and ARIA semantics (<button role="link">)Confusing - element behaves like a button but says it's a link.One or the other; native is preferred.
tabindex="3" to control sequencePositive tabindex creates fragile order.DOM order + tabindex="0" for custom focusables.
Adding aria-label to every element "for accessibility"If the element has a visible label, aria-label overrides it. Many elements don't need a label at all.Only add aria-label when there's no visible text label AND the element is interactive.

References

  • apg-patterns - W3C ARIA Authoring Practices Guide (canonical patterns).
  • WAI-ARIA 1.2 Spec - https://www.w3.org/TR/wai-aria-1.2/
  • wcag-focus-trap - Dialog pattern's focus-management deep dive.
  • wcag-keyboard-navigation - Keyboard-interaction conformance underlying every APG pattern.
  • axe-a11y, pa11y-a11y - runners that detect ARIA misuse programmatically.