API overview
API reference
Package and symbol-level reference for every public generative-a11y runtime, browser, React, framework adapter, devtools, and testing contract.
Choose the packages you need
Start with core. Add DOM or React for browser updates, then add a framework adapter if your app uses that framework.
| Package | Primary exports | Use for |
|---|---|---|
| @generative-a11y/core | createGenerativeA11y, events, policy, scheduler | Framework-independent policy |
| @generative-a11y/dom | announcer, runtime binding, focus, attention, preferences | Browser updates and helpers |
| @generative-a11y/react | provider and hooks | React setup and element bindings |
| @generative-a11y/ai-sdk | observer, callbacks, React hooks | AI SDK useChat public state |
| @generative-a11y/assistant-ui | bindThreadRuntime | assistant-ui ThreadRuntime |
| @generative-a11y/ag-ui | bindAgent | AG-UI AgentSubscriber callbacks |
| @generative-a11y/devtools | createDevtoolsStore, overlay | Bounded redacted development traces |
| @generative-a11y/test | recordRuntime, replayEvents, matchers | Deterministic lifecycle tests |
How to read this reference
Each symbol page lists the import path, signature, parameters, return value, defaults, cleanup rules, and related APIs. Every example uses public exports from the installed packages.
- Method return values describe behavior the library can confirm.
- Cleanup notes list the timers, subscriptions, DOM nodes, or framework objects released by dispose().
- Test notes separate runtime and browser results from hands-on screen-reader tests.
- You can link to any API page from an issue or code review.