# ammarahamed/cocoon-a11y architecture

> Architecture diagram of the GitHub repository ammarahamed/cocoon-a11y, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ammarahamed/cocoon-a11y
- Repository: https://github.com/ammarahamed/cocoon-a11y

## Overview

Cocoon A11y is a client-side accessibility widget embedded in a host website. A visitor opens its panel, selects individual adaptations or a quick profile, and the widget applies them to the page; settings can persist across pages. The single runtime file owns the UI, feature behavior, and browser API use. The README documents broader capabilities than the excerpts expose, so those branches are included with README evidence; no separate runtime modules or storage service are shown.

Main entry points: [`a11y.js`](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js) (Accessible panel)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Embedding and UI"]
  node_widget["Widget runtime<br/>[a11y.js]"]
  node_panel["Accessible panel<br/>[a11y.js]"]
  node_profiles["Quick profiles<br/>[a11y.js]"]
end

subgraph group_adapt["Page Adaptations"]
  node_vision["Vision controls<br/>[a11y.js]"]
  node_reading["Reading controls<br/>[a11y.js]"]
  node_navigation["Navigation aids<br/>[a11y.js]"]
end

subgraph group_assist["Reading and Motor"]
  node_speech["Read aloud<br/>[a11y.js]"]
  node_motor["Motor controls<br/>[a11y.js]"]
  node_page["Host page content"]
end

subgraph group_platform["Browser Services"]
  node_browser["Browser APIs"]
  node_dyslexia["OpenDyslexic font"]
end

node_visitor(("Site visitor"))
node_website["Host website"]

node_website -->|"embeds script"| node_widget
node_widget -->|"creates UI"| node_panel
node_visitor -->|"uses controls"| node_panel
node_panel -->|"selects profile"| node_profiles
node_panel -->|"toggles features"| node_vision
node_panel -->|"toggles features"| node_reading
node_panel -->|"toggles features"| node_navigation
node_panel -->|"starts reading"| node_speech
node_panel -->|"toggles features"| node_motor
node_vision -->|"adapts appearance"| node_page
node_reading -->|"adapts text"| node_page
node_navigation -->|"navigates content"| node_page
node_speech -->|"reads content"| node_page
node_motor -->|"assists interaction"| node_page
node_speech -->|"uses speech API"| node_browser
node_profiles -->|"applies settings"| node_vision
node_profiles -->|"applies settings"| node_reading
node_profiles -->|"applies settings"| node_navigation
node_profiles -->|"applies settings"| node_motor
node_reading -.->|"loads font"| node_dyslexia
node_widget -.->|"persists settings"| node_browser

click node_widget "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_panel "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_profiles "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_vision "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_reading "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_navigation "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_speech "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"
click node_motor "https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_widget,node_panel,node_profiles toneBlue
class node_vision,node_reading,node_navigation toneAmber
class node_speech,node_motor,node_page toneMint
class node_browser,node_dyslexia toneRose
class node_visitor,node_website toneIndigo
```

## Components

### Embedding and UI

- [Widget runtime](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- [Accessible panel](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- [Quick profiles](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`

### Page Adaptations

- [Vision controls](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- [Reading controls](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- [Navigation aids](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`

### Reading and Motor

- [Read aloud](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- [Motor controls](https://github.com/ammarahamed/cocoon-a11y/blob/master/a11y.js): `a11y.js`
- **Host page content**

### Browser Services

- **Browser APIs**
- **OpenDyslexic font**

### Other components

- **Site visitor**
- **Host website**

## Connections

- Host website → Widget runtime: embeds script (evidence: `README.md`)
- Widget runtime → Accessible panel: creates UI (evidence: `a11y.js`)
- Site visitor → Accessible panel: uses controls (evidence: `README.md`)
- Accessible panel → Quick profiles: selects profile (evidence: `a11y.js`)
- Accessible panel → Vision controls: toggles features (evidence: `README.md`)
- Accessible panel → Reading controls: toggles features (evidence: `README.md`)
- Accessible panel → Navigation aids: toggles features (evidence: `README.md`)
- Accessible panel → Read aloud: starts reading (evidence: `a11y.js`)
- Accessible panel → Motor controls: toggles features (evidence: `README.md`)
- Vision controls → Host page content: adapts appearance (evidence: `README.md`)
- Reading controls → Host page content: adapts text (evidence: `README.md`)
- Navigation aids → Host page content: navigates content (evidence: `README.md`)
- Read aloud → Host page content: reads content (evidence: `a11y.js`)
- Motor controls → Host page content: assists interaction (evidence: `README.md`)
- Read aloud → Browser APIs: uses speech API (evidence: `README.md`)
- Quick profiles → Vision controls: applies settings (evidence: `a11y.js`)
- Quick profiles → Reading controls: applies settings (evidence: `a11y.js`)
- Quick profiles → Navigation aids: applies settings (evidence: `a11y.js`)
- Quick profiles → Motor controls: applies settings (evidence: `a11y.js`)
- Reading controls → OpenDyslexic font: loads font (evidence: `README.md`)
- Widget runtime → Browser APIs: persists settings (evidence: `README.md`)
