Developer Setup Guide
Get up and running with the A11yEngine browser extension. Learn how to load the plugin, save your credentials, and run scans in under 5 minutes.
01
Load the Unpacked Browser Extension
During the Beta release period, A11yEngine is distributed as a zipped developer bundle. Follow these steps to load it into Chromium-based browsers (Chrome, Edge, Arc):
- Download the beta extension zip file from your registration email and extract the contents to a local folder (e.g.
/documents/a11y-engine-plugin). - Open your browser and navigate to the extensions control panel by entering
chrome://extensionsin your URL bar. - In the top right-hand corner, toggle the Developer Mode switch to ON.
- In the top left, click the Load Unpacked button.
- Select the extracted directory containing the
manifest.jsonfile. The extension is now active in your toolbar.
02
Zero-Configuration AI Remediation
A11yEngine provides a seamless 1-click auto-fix experience out of the box. You do not need to register for, enter, or manage private API keys:
- Click the A11yEngine puzzle icon in your browser toolbar to open the Sidepanel.
- Click **Scan Page** at the top of the panel. The extension will parse the DOM and run custom heuristics.
- Select any violation from the dashboard list. A11yEngine automatically routes the element snippet through our secure Vercel proxy to query Google's **Gemini-3.6-Flash** model.
- The structured accessible fix appears instantly in the **React**, **Tailwind CSS**, or **Vue** tab, ready to copy and paste.
03
Running Scans & Generating Fixes
Once configured, navigate to any local development URL (e.g. localhost:3000) or public website:
- Click **Scan Page** at the top of the side panel. The extension will parse the DOM and run custom heuristics.
- Toggle **Overlays** on to see bounding boxes drawn directly around elements with accessibility violations. Hovering highlights the rule, while clicking selects the rule details in the sidebar.
- Inspect the **Code Remediation** tab to copy clean, compliant components formatted for **React**, **Tailwind**, or **Vue 3**.
- Click the download button to export a fully-styled offline HTML Audit Report, or click copy to copy a pre-formatted Markdown summary for Jira or GitHub tickets.
🔧 Extension Config Properties
All settings are persisted locally in chrome.storage.local:
| Storage Key | Default | Description |
|---|---|---|
| showOverlays | true | Controls viewport outline overlay visibility state. |
| isPro | false | License state flag. Set to true once verified. |
| aiViewsCount | 0 | Tracks free-tier AI fix views locally. |