Skip to content

JavaScript SDK

Coming soon
npm package coming soon — use the script tag today. @incluxa/a11y-sdk is not published to npm yet, so the install commands and imports on this page show the planned API and will not work until it is released. To add the widget today, paste the script tag before </body> (see the script tag guide):
index.html
<script
  src="https://cdn.angstroma.com/widget-v1e53f7da.js"
  integrity="sha384-HlP32lTm2OI1Il1KqCoQLgaPFlF6jpiSY43JpewsQOOmml95m0VMl4vnQxAP+XMi"
  crossorigin="anonymous"
  data-key="inc_live_YOUR_KEY"
  async
></script>

The @incluxa/a11y-sdk npm package (coming soon) will give you programmatic control over every accessibility feature — profiles, presets, AI transforms, and usage analytics — from any JavaScript environment.

When to use the SDK vs script tag

The script tag is the fastest path to adding the INCLUXA accessibility toolbar to any site. No build step required.

The npm SDK is for teams who need deeper integration: building custom UI, programmatically applying presets per student, using AI content transforms in your own components, or building headless (no toolbar) implementations.

Script tag
Drop-in toolbar widget. No build step. Best for static sites, CMS platforms, and quick installs.
React SDK
A11yProvider + useA11y() hook. Context-driven, React 18+ compatible.
Vanilla JS SDK
IncluxaA11y class. Works in any framework or plain HTML. No React dependency.

Installation (coming soon)

Once the package is published, install it from npm:

npm install @incluxa/a11y-sdk

What's included

ExportDescription
A11yProviderReact context provider — wraps your app, loads profile automatically
useA11y()React hook — access enable/disable/toggle/applyPreset from any component
A11yToolbarPre-built React toolbar component
A11yReaderText-to-speech reader component
A11yQuizToolbarAccessibility toolbar optimised for quiz/assessment UIs
A11yPresetBarHorizontal preset picker component
IncluxaA11yVanilla JS class — full SDK without React dependency
A11yClientLow-level HTTP client (X-Api-Key auth)
generateAltText()AI: generate alt text from image URL
simplify()AI: simplify text to target reading level
rephrase()AI: rephrase question/answer pair
getHints()AI: get scaffolded hints for a question
extractVocabulary()AI: extract vocabulary words from text

API base URL

All SDK methods send requests to https://api.incluxa.com/api/v1 by default. Override with the apiUrl config option for self-hosted or staging environments.