accessibility-plugin-react 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +224 -44
- package/docs/DEVELOPMENT.md +1 -1
- package/docs/HANDOVER.md +4 -4
- package/docs/INSTALLATION.md +6 -2
- package/docs/PROJECT_STATUS.md +19 -8
- package/docs/RELEASE.md +52 -11
- package/docs/ROADMAP.md +17 -15
- package/docs/TROUBLESHOOTING.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
|
-
#
|
|
1
|
+
# accessibility-plugin-react
|
|
2
2
|
|
|
3
|
-
Composable React controls for
|
|
3
|
+
Composable React controls for display preferences and reading assistance. Choose
|
|
4
|
+
the controls in JSX, keep the widget outside your application layout, and let
|
|
5
|
+
the provider own state, persistence, effects, focus behavior, and cleanup.
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
The `2.0.1` patch release updates the published v2 documentation without
|
|
8
|
+
changing the runtime API. It supports React 18.3.1 and React 19.x, ships ESM,
|
|
9
|
+
CommonJS, TypeScript declarations, and scoped plain CSS, and has no runtime
|
|
10
|
+
dependency other than React and React DOM.
|
|
6
11
|
|
|
7
|
-
|
|
12
|
+
> This library improves the presentation of your content. It cannot repair
|
|
13
|
+
> inaccessible application markup or certify WCAG conformance. Human
|
|
14
|
+
> screen-reader, physical-device, actual-zoom, forced-colors, and host
|
|
15
|
+
> integration checks remain part of your application's accessibility process.
|
|
8
16
|
|
|
9
|
-
|
|
17
|
+

|
|
10
18
|
|
|
11
|
-
##
|
|
12
|
-
|
|
13
|
-
This update continues the owner’s existing npm package, `accessibility-plugin-react`, as a new major version. The registry currently serves 1.0.0; version 2.0.0 introduces the new design and compound API. See [migration guidance](docs/MIGRATION.md) before upgrading. To evaluate these changes, install the local tarball:
|
|
19
|
+
## Installation
|
|
14
20
|
|
|
15
21
|
```sh
|
|
16
|
-
npm
|
|
17
|
-
npm run build
|
|
18
|
-
npm pack
|
|
19
|
-
# In your React application, use the actual archive path:
|
|
20
|
-
npm install /absolute/path/to/accessibility-plugin-react-2.0.0.tgz
|
|
22
|
+
npm install accessibility-plugin-react
|
|
21
23
|
```
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
React and React DOM are peer dependencies and must use the same major/minor
|
|
26
|
+
line. The package requires Node.js 22.13 or newer for development and builds.
|
|
27
|
+
The widget itself does not require an API key, backend, environment variable,
|
|
28
|
+
Tailwind, Motion, or an icon library.
|
|
29
|
+
|
|
30
|
+
## Quick start
|
|
31
|
+
|
|
32
|
+
Import the stylesheet once and mount one provider per document, preferably
|
|
33
|
+
above route changes or in the persistent application layout:
|
|
24
34
|
|
|
25
35
|
```tsx
|
|
26
36
|
import {
|
|
@@ -34,68 +44,238 @@ import {
|
|
|
34
44
|
} from "accessibility-plugin-react";
|
|
35
45
|
import "accessibility-plugin-react/style.css";
|
|
36
46
|
|
|
37
|
-
export
|
|
47
|
+
export function AccessibilitySettings() {
|
|
48
|
+
return (
|
|
49
|
+
<AccessibilityPlugin position="right">
|
|
50
|
+
<AccessibilityButton description="Adjust display preferences" />
|
|
51
|
+
<AccessibilityList>
|
|
52
|
+
<FontSizeController />
|
|
53
|
+
<ContrastController />
|
|
54
|
+
<GrayscaleController />
|
|
55
|
+
<ResetController />
|
|
56
|
+
</AccessibilityList>
|
|
57
|
+
</AccessibilityPlugin>
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The button and panel are non-modal body portals. The application remains
|
|
63
|
+
interactive while the panel is open. Opening moves focus to the named region;
|
|
64
|
+
Escape and Close return focus to the trigger. Focus is not trapped.
|
|
65
|
+
|
|
66
|
+
`AccessibilityPlugin` can be rendered next to application content:
|
|
67
|
+
|
|
68
|
+
```tsx
|
|
69
|
+
export function App() {
|
|
38
70
|
return (
|
|
39
71
|
<>
|
|
40
|
-
<main>
|
|
41
|
-
|
|
42
|
-
<p>Your application goes here.</p>
|
|
43
|
-
</main>
|
|
44
|
-
<AccessibilityPlugin position="right">
|
|
45
|
-
<AccessibilityButton description="Adjust display preferences" />
|
|
46
|
-
<AccessibilityList>
|
|
47
|
-
<FontSizeController />
|
|
48
|
-
<ContrastController />
|
|
49
|
-
<GrayscaleController />
|
|
50
|
-
<ResetController />
|
|
51
|
-
</AccessibilityList>
|
|
52
|
-
</AccessibilityPlugin>
|
|
72
|
+
<main>{/* application routes and content */}</main>
|
|
73
|
+
<AccessibilitySettings />
|
|
53
74
|
</>
|
|
54
75
|
);
|
|
55
76
|
}
|
|
56
77
|
```
|
|
57
78
|
|
|
58
|
-
|
|
79
|
+
## Built-in controllers
|
|
80
|
+
|
|
81
|
+
Every controller is opt-in. Add only the controls that make sense for your
|
|
82
|
+
site, and choose their order in JSX.
|
|
83
|
+
|
|
84
|
+
| Controller | Effect |
|
|
85
|
+
| ------------------------- | --------------------------------------------------------------------------------- |
|
|
86
|
+
| `FontSizeController` | Scales eligible HTML text from 50% to 200%. |
|
|
87
|
+
| `LineHeightController` | Scales computed line height from 50% to 200%. |
|
|
88
|
+
| `LetterSpacingController` | Applies 0–10px letter spacing. |
|
|
89
|
+
| `ContrastController` | Turns contrast off, reduces it, increases it, or selects a named palette. |
|
|
90
|
+
| `SaturationController` | Reduces or increases saturation. |
|
|
91
|
+
| `InvertColorsController` | Inverts eligible page content. |
|
|
92
|
+
| `GrayscaleController` | Removes color while preserving the selected saturation value for later. |
|
|
93
|
+
| `LinkHighlightController` | Highlights links or selects a link palette. |
|
|
94
|
+
| `TextAlignController` | Restores the host alignment or forces left, center, right, or justified text. |
|
|
95
|
+
| `HideImagesController` | Hides images and CSS background images while retaining layout. |
|
|
96
|
+
| `HideVideosController` | Hides video elements and recognized YouTube/Vimeo embeds visually. |
|
|
97
|
+
| `BigCursorController` | Applies a larger high-contrast cursor where supported. |
|
|
98
|
+
| `ReadingMaskController` | Dims the page around a transparent reading window. |
|
|
99
|
+
| `ReadingGuideController` | Follows pointer/focus with a reading guide line. |
|
|
100
|
+
| `ResetController` | Resets display features and custom registered features without moving the widget. |
|
|
101
|
+
|
|
102
|
+
Effects compose where appropriate. For example, contrast, saturation, invert,
|
|
103
|
+
and grayscale are applied in a deterministic order. Defaults leave host styles
|
|
104
|
+
unchanged, and the provider restores host inline values and priorities when an
|
|
105
|
+
effect is disabled or the provider is removed.
|
|
59
106
|
|
|
60
107
|
## Custom features
|
|
61
108
|
|
|
62
|
-
|
|
109
|
+
Use the two-argument hook for simple state, or provide validation and a
|
|
110
|
+
provider-owned effect for a feature that changes the page:
|
|
63
111
|
|
|
64
112
|
```tsx
|
|
65
113
|
import { useAccessibility } from "accessibility-plugin-react";
|
|
66
114
|
|
|
67
115
|
export function OutlineFeature() {
|
|
68
|
-
const { value, setValue } = useAccessibility("
|
|
116
|
+
const { value, setValue } = useAccessibility("site:outline", false, {
|
|
69
117
|
apply(enabled) {
|
|
70
118
|
if (!enabled) return;
|
|
119
|
+
|
|
71
120
|
const previous = document.body.style.outline;
|
|
72
|
-
document.body.style.outline = "3px solid
|
|
121
|
+
document.body.style.outline = "3px solid #1e40af";
|
|
73
122
|
return () => {
|
|
74
123
|
document.body.style.outline = previous;
|
|
75
124
|
};
|
|
76
125
|
},
|
|
77
126
|
});
|
|
127
|
+
|
|
78
128
|
return (
|
|
79
129
|
<button type="button" aria-pressed={value} onClick={() => setValue(!value)}>
|
|
80
|
-
|
|
130
|
+
Outline page
|
|
81
131
|
</button>
|
|
82
132
|
);
|
|
83
133
|
}
|
|
84
134
|
```
|
|
85
135
|
|
|
86
|
-
Place
|
|
136
|
+
Place the feature inside `AccessibilityList`:
|
|
137
|
+
|
|
138
|
+
```tsx
|
|
139
|
+
<AccessibilityList>
|
|
140
|
+
<FontSizeController />
|
|
141
|
+
<OutlineFeature />
|
|
142
|
+
<ResetController />
|
|
143
|
+
</AccessibilityList>
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
The provider owns the effect lifetime, so it continues when the panel closes or
|
|
147
|
+
the control temporarily unmounts. Cleanup runs before reapplication and when
|
|
148
|
+
the provider unmounts. Custom state is JSON-compatible; supply `validate` for
|
|
149
|
+
arrays and objects. Feature keys must be stable and cannot use reserved
|
|
150
|
+
prototype names or built-in keys. See [custom feature details](docs/CUSTOM_FEATURES.md).
|
|
151
|
+
|
|
152
|
+
## Persistence and movement
|
|
153
|
+
|
|
154
|
+
Preferences are stored in a versioned local-storage record under
|
|
155
|
+
`react-accessibility-plugin:state` by default. Writes are debounced and flushed
|
|
156
|
+
when the page is hidden or the provider is removed. Invalid saved values fall
|
|
157
|
+
back to defaults; storage failures do not make the widget unusable.
|
|
158
|
+
|
|
159
|
+
```tsx
|
|
160
|
+
<AccessibilityPlugin
|
|
161
|
+
persistenceKey="my-site:accessibility"
|
|
162
|
+
persist={true}
|
|
163
|
+
position="left"
|
|
164
|
+
>
|
|
165
|
+
{/* button, list, and selected controllers */}
|
|
166
|
+
</AccessibilityPlugin>
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
Persistence options are fixed for the provider lifetime. Remount with a React
|
|
170
|
+
`key` when changing the storage identity. Use one provider per document.
|
|
171
|
+
|
|
172
|
+
The trigger is draggable by default. Movement also works with Alt+Arrow keys
|
|
173
|
+
and the panel's explicit corner and arrow controls. Drag activation has an
|
|
174
|
+
8px threshold, cancelled drags do not open the panel, and placement is clamped
|
|
175
|
+
on resize. `ResetController` preserves placement; the panel's separate
|
|
176
|
+
position reset removes it. Set `draggable={false}` when only the non-drag
|
|
177
|
+
controls should be available.
|
|
87
178
|
|
|
88
|
-
##
|
|
179
|
+
## Styling and framework integration
|
|
89
180
|
|
|
181
|
+
The stylesheet is scoped to `.arap-root` and does not add a global reset,
|
|
182
|
+
Tailwind preflight, or host theme variables. Load it once, then put consumer
|
|
183
|
+
overrides after it:
|
|
184
|
+
|
|
185
|
+
```css
|
|
186
|
+
.arap-root {
|
|
187
|
+
--arap-accent: #1e40af;
|
|
188
|
+
--arap-accent-hover: #1e3a8a;
|
|
189
|
+
--arap-selected: #eff6ff;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
.arap-root .my-trigger {
|
|
193
|
+
border-radius: 999px;
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
Use `className`, `style`, `title`, `description`, and `closeLabel` to adapt
|
|
198
|
+
the widget to your product language and layout. Preserve visible focus,
|
|
199
|
+
pressed states, contrast, and the library's 44px minimum interactive targets
|
|
200
|
+
when overriding styles.
|
|
201
|
+
|
|
202
|
+
For Next.js App Router, put the provider and custom controls in a Client
|
|
203
|
+
Component, import the CSS from the root layout, and render the provider in the
|
|
204
|
+
persistent layout rather than once per route:
|
|
205
|
+
|
|
206
|
+
```tsx
|
|
207
|
+
// app/accessibility-settings.tsx
|
|
208
|
+
"use client";
|
|
209
|
+
|
|
210
|
+
import {
|
|
211
|
+
AccessibilityPlugin,
|
|
212
|
+
AccessibilityButton,
|
|
213
|
+
AccessibilityList,
|
|
214
|
+
FontSizeController,
|
|
215
|
+
ResetController,
|
|
216
|
+
} from "accessibility-plugin-react";
|
|
217
|
+
|
|
218
|
+
export function AccessibilitySettings() {
|
|
219
|
+
return (
|
|
220
|
+
<AccessibilityPlugin>
|
|
221
|
+
<AccessibilityButton />
|
|
222
|
+
<AccessibilityList>
|
|
223
|
+
<FontSizeController />
|
|
224
|
+
<ResetController />
|
|
225
|
+
</AccessibilityList>
|
|
226
|
+
</AccessibilityPlugin>
|
|
227
|
+
);
|
|
228
|
+
}
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
See [installation and Next.js](docs/INSTALLATION.md) for App Router and Pages
|
|
232
|
+
Router examples.
|
|
233
|
+
|
|
234
|
+
## API and limitations
|
|
235
|
+
|
|
236
|
+
- Public components, props, exported types, placement, persistence, custom
|
|
237
|
+
features, and CSS variables are documented in [API.md](docs/API.md).
|
|
238
|
+
- Detailed per-feature defaults, bounds, and host behavior are in
|
|
239
|
+
[FEATURES.md](docs/FEATURES.md).
|
|
240
|
+
- Filters can create stacking contexts and containing blocks for fixed host
|
|
241
|
+
descendants. Test sticky headers, overlays, and third-party widgets in the
|
|
242
|
+
real application.
|
|
243
|
+
- Text measurement covers the current document's eligible HTML elements.
|
|
244
|
+
Shadow DOM, iframe interiors, SVG/canvas text, pseudo-elements, and raw text
|
|
245
|
+
nodes directly under `body` are outside scope.
|
|
246
|
+
- Image/video hiding is visual; video playback is not paused or muted.
|
|
247
|
+
- Reading aids are pointer-transparent overlays and do not replace semantic
|
|
248
|
+
reading structure.
|
|
249
|
+
- There is no live cross-tab synchronization or server-side preference sync.
|
|
250
|
+
- `persist={false}` disables both display and placement persistence.
|
|
251
|
+
|
|
252
|
+
See [troubleshooting](docs/TROUBLESHOOTING.md) before filing an issue.
|
|
253
|
+
|
|
254
|
+
## Documentation and examples
|
|
255
|
+
|
|
256
|
+
- [API reference](docs/API.md)
|
|
257
|
+
- [Feature behavior and bounds](docs/FEATURES.md)
|
|
90
258
|
- [Installation and Next.js](docs/INSTALLATION.md)
|
|
91
|
-
- [
|
|
92
|
-
- [
|
|
93
|
-
- [Architecture and decisions](docs/ARCHITECTURE.md)
|
|
94
|
-
- [Development
|
|
95
|
-
- [
|
|
96
|
-
- [
|
|
97
|
-
- [
|
|
259
|
+
- [Custom features](docs/CUSTOM_FEATURES.md)
|
|
260
|
+
- [Migration from v1 and development baselines](docs/MIGRATION.md)
|
|
261
|
+
- [Architecture and lifecycle decisions](docs/ARCHITECTURE.md)
|
|
262
|
+
- [Development and testing](docs/DEVELOPMENT.md)
|
|
263
|
+
- [Design foundation](docs/DESIGN.md)
|
|
264
|
+
- [Troubleshooting](docs/TROUBLESHOOTING.md)
|
|
265
|
+
- [Project status and verification evidence](docs/PROJECT_STATUS.md)
|
|
266
|
+
- [Release procedure](docs/RELEASE.md)
|
|
267
|
+
- [Changelog](CHANGELOG.md)
|
|
268
|
+
|
|
269
|
+
Runnable package-consumer examples are in [`examples/`](examples/):
|
|
270
|
+
|
|
271
|
+
```sh
|
|
272
|
+
npm ci
|
|
273
|
+
npm run build
|
|
274
|
+
npm run example
|
|
275
|
+
```
|
|
98
276
|
|
|
99
|
-
|
|
277
|
+
## License
|
|
100
278
|
|
|
101
|
-
|
|
279
|
+
This package is available under the [ISC license](LICENSE). The original
|
|
280
|
+
vanilla JavaScript project is maintained separately at
|
|
281
|
+
[prabothcharith/accessibility-plugin](https://github.com/prabothcharith/accessibility-plugin).
|
package/docs/DEVELOPMENT.md
CHANGED
|
@@ -18,7 +18,7 @@ npm run test:browser
|
|
|
18
18
|
|
|
19
19
|
For a PR under review, check out its head branch instead and record the tested commit. Main contains the merged stabilization and Clean light foundation; PR #17 adds movement and fixed actions.
|
|
20
20
|
|
|
21
|
-
`validate` runs typecheck, lint, unit tests and JS/declaration/CSS build. `test:consumers` builds, packs and installs the archive in `.consumers/react18`, `.consumers/react19` and `.consumers/next`, checks ESM/CJS and declarations/SSR, and produces application production builds. Consumers use explicitly selected framework versions; generated install locks reside in disposable `.consumers`. Network access is required for installation, not widget runtime. Browser tests start local ports
|
|
21
|
+
`validate` runs typecheck, lint, unit tests and JS/declaration/CSS build. `test:consumers` builds, packs and installs the archive in `.consumers/react18`, `.consumers/react19` and `.consumers/next`, checks ESM/CJS and declarations/SSR, and produces application production builds. Consumers use explicitly selected framework versions; generated install locks reside in disposable `.consumers`. Network access is required for installation, not widget runtime. Browser tests start local ports 7311/7312/7313 and close their servers afterward. Avoid using these ports for unrelated processes. `CI` disables server reuse and is a test-runner environment flag, not a library setting.
|
|
22
22
|
|
|
23
23
|
`npm run example` serves the two built-package examples through Vite after `npm run build`. `npm run dev` watches the library JS bundle; run build:css after editing CSS. `npm run test:watch` is useful locally. `npm pack` produces the actual package archive. Never validate only source imports and call it release-ready.
|
|
24
24
|
|
package/docs/HANDOVER.md
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Executive summary
|
|
4
4
|
|
|
5
|
-
Stabilized the existing compound-component library rather than rebuilding from the empty default branch. All fifteen built-ins and the generic custom-feature hook remain. Effects now belong to the provider and survive closing/unmounting controls; reset/cleanup/persistence are coordinated. Built distribution has been exercised in independent React and Next applications. Stabilization
|
|
5
|
+
Stabilized the existing compound-component library rather than rebuilding from the empty default branch. All fifteen built-ins and the generic custom-feature hook remain. Effects now belong to the provider and survive closing/unmounting controls; reset/cleanup/persistence are coordinated. Built distribution has been exercised in independent React and Next applications. Stabilization, Clean light, remembered movement/fixed actions and the version 2 release workflow are merged into main. `accessibility-plugin-react@2.0.0` is published under `latest`; automated and registry-consumer checks do not constitute accessibility certification.
|
|
6
6
|
|
|
7
7
|
## Repository and baseline
|
|
8
8
|
|
|
9
|
-
Repository: prabothcharith/accessibility-react. Historical stabilization branch: codex/stabilize-accessibility from origin/new-development (6dfbd44). Stabilization reached main through PR #3 at 2893b6c; Clean light reached main through PR #16 at 15e9465. Current
|
|
9
|
+
Repository: prabothcharith/accessibility-react. Historical stabilization branch: codex/stabilize-accessibility from origin/new-development (6dfbd44). Stabilization reached main through PR #3 at 2893b6c; Clean light reached main through PR #16 at 15e9465. Current main includes movement through PR #17 at aa72aa5 and the npm identity/ISC/version 2 workflow through PR #18 at 1d4ab1c. Original checkout development (7aef17c) was clean. Compared main, development, new-development, merged PR #1 and vanilla plugin at 47f44c5. Read the historical specification and commit summary; their unsupported current-completion claims are now marked historical. Baseline and parity evidence are in BASELINE.md and FEATURES.md.
|
|
10
10
|
|
|
11
11
|
Baseline defects included controller-owned lifetime, overwriting filters, fixed invisible hit areas, shared debounce/reset races, false modal semantics, unnamed toggles, global Tailwind resets, ineffective custom DOM examples, missing shipped client directive and incorrect repository metadata. Initial lint failed seven checks; nominal 24 tests did not await three persistence assertions; audit reported 15 findings.
|
|
12
12
|
|
|
@@ -38,11 +38,11 @@ Created AGENTS.md, LICENSE, CHANGELOG.md and maintained docs: ARCHITECTURE, FEAT
|
|
|
38
38
|
|
|
39
39
|
## Remaining work and authorization
|
|
40
40
|
|
|
41
|
-
P1:
|
|
41
|
+
P1: complete human accessibility and representative host-integration acceptance, then decide separately whether to create a Git tag/GitHub release. npm publication and clean registry-consumer verification are complete. Track the remaining release work in [Project #18](https://github.com/users/prabothcharith/projects/18) and [release tracker #15](https://github.com/prabothcharith/accessibility-react/issues/15). P2: profile large dynamic hosts, improve style/font-change refresh and explicit scopes, then localization/cross-tab work.
|
|
42
42
|
|
|
43
43
|
Current limits include one provider/document, host filter containing-block behavior, no Shadow DOM/iframe interior/pseudo-element effects, no auto-pause for hidden video and CSP considerations. These are documented implementation boundaries, not hidden workarounds.
|
|
44
44
|
|
|
45
|
-
[PR #2](https://github.com/prabothcharith/accessibility-react/pull/2) merged into new-development and [PR #3](https://github.com/prabothcharith/accessibility-react/pull/3) merged stabilization into main. [Final stabilization validation](https://github.com/prabothcharith/accessibility-react/actions/runs/38328538388) on a020352 passed hosted Node22/24 with 61 unit tests, all packed consumers and the full browser matrix (37 passed, five intentional skips). [PR #16](https://github.com/prabothcharith/accessibility-react/pull/16)
|
|
45
|
+
[PR #2](https://github.com/prabothcharith/accessibility-react/pull/2) merged into new-development and [PR #3](https://github.com/prabothcharith/accessibility-react/pull/3) merged stabilization into main. [Final stabilization validation](https://github.com/prabothcharith/accessibility-react/actions/runs/38328538388) on a020352 passed hosted Node22/24 with 61 unit tests, all packed consumers and the full browser matrix (37 passed, five intentional skips). [PR #16](https://github.com/prabothcharith/accessibility-react/pull/16) merged the Clean light foundation. PR #17 merged movement and fixed actions; PR #18 merged npm version 2 and the publishing workflow. Version 2 is published; human acceptance and any Git release/tag remain open.
|
|
46
46
|
|
|
47
47
|
## Historical stabilization file inventory
|
|
48
48
|
|
package/docs/INSTALLATION.md
CHANGED
|
@@ -4,14 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Development: Node.js 22.13 or newer, npm, Git. Library peers: React/React DOM 18.3.1 or 19.x. Keep React and React DOM on the same version. There are no application environment variables, API keys, backend services or mandatory network access at runtime. Storage is optional (`persist={false}`).
|
|
6
6
|
|
|
7
|
-
The
|
|
7
|
+
The package identity is `accessibility-plugin-react`. Version 2 is the current
|
|
8
|
+
major line and `latest` is the stable distribution tag. The API changes from
|
|
9
|
+
the historical 1.x package require migration (see MIGRATION.md). Install the
|
|
10
|
+
current release with `npm install accessibility-plugin-react`, or pin the
|
|
11
|
+
major line with `npm install accessibility-plugin-react@2`. For this checkout:
|
|
8
12
|
|
|
9
13
|
```sh
|
|
10
14
|
npm ci
|
|
11
15
|
npm run build
|
|
12
16
|
npm pack
|
|
13
17
|
# From an independent application:
|
|
14
|
-
npm install /absolute/path/to/accessibility-plugin-react-2.0.
|
|
18
|
+
npm install /absolute/path/to/accessibility-plugin-react-2.0.1.tgz
|
|
15
19
|
```
|
|
16
20
|
|
|
17
21
|
Import `accessibility-plugin-react/style.css` once near the app entry. Do not add the library to a Tailwind content scan. No shadcn, icon or Motion dependency is needed. See README for complete React/Vite JSX.
|
package/docs/PROJECT_STATUS.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
|
-
# Project status — 2026-10-
|
|
1
|
+
# Project status — 2026-10-20
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**Version 2 is published; human accessibility acceptance remains pending.** The
|
|
4
|
+
tested archive from `1d4ab1c` is published as `accessibility-plugin-react@2.0.0`
|
|
5
|
+
under `latest`. The repository now prepares `2.0.1` as a documentation-only
|
|
6
|
+
patch; npm publication remains pending registry authentication and the exact
|
|
7
|
+
release workflow run. The v2.0.0 Git tag exists; no GitHub release has been
|
|
8
|
+
created.
|
|
4
9
|
|
|
5
10
|
## Status categories
|
|
6
11
|
|
|
@@ -9,9 +14,9 @@
|
|
|
9
14
|
| Implemented and verified | Provider-owned built-in/custom effects; reset cancellation; validated restoration; all fifteen controllers; combined filters; host style cleanup; dynamic child content; non-modal focus; portal layout; scoped CSS; React18/19 packed consumers; Next App/Pages and direct Server Component imports |
|
|
10
15
|
| Implemented but unverified | Broader React19 patch versions, physical devices, assistive technologies and browser versions outside the executed matrix |
|
|
11
16
|
| Partially implemented | Broad accessibility acceptance: automated keyboard/axe/reflow checks passed, real screen-reader/physical-device/actual zoom review remains. Host-wide integration: known filter/CSP/Shadow DOM/attribute-change limits remain. |
|
|
12
|
-
| In progress |
|
|
17
|
+
| In progress | Manual screen-reader, physical-device, actual-zoom, forced-colors and representative host acceptance remains pending. |
|
|
13
18
|
| Planned | Large-DOM profiling, attribute/font-load refresh, explicit effect scopes and richer localization |
|
|
14
|
-
| Blocked | Local macOS Firefox launch only (Linux coverage passed);
|
|
19
|
+
| Blocked | Local macOS Firefox launch only (Linux coverage passed); stable human acceptance remains pending |
|
|
15
20
|
| Deferred | Multi-provider arbitration and live cross-tab sync |
|
|
16
21
|
| Completed | Investigation/baseline, local P0 stabilization, feature regression suite, packed consumer/build verification, documentation, local example verification and full hosted CI meet their stated local acceptance criteria |
|
|
17
22
|
|
|
@@ -44,7 +49,7 @@ Expected error-path unit tests deliberately trigger missing-provider and duplica
|
|
|
44
49
|
|
|
45
50
|
## Merge and review state
|
|
46
51
|
|
|
47
|
-
[PR #2](https://github.com/prabothcharith/accessibility-react/pull/2) merged stabilization into `new-development`; [PR #3](https://github.com/prabothcharith/accessibility-react/pull/3) merged the complete implementation into `main`. [Merged-main validation](https://github.com/prabothcharith/accessibility-react/actions/runs/38345207412) passed all jobs. PR #16 merged Clean light into main at `15e9465`; [that main run](https://github.com/prabothcharith/accessibility-react/actions/runs/38353340223) also passed all jobs. PR #17 is the
|
|
52
|
+
[PR #2](https://github.com/prabothcharith/accessibility-react/pull/2) merged stabilization into `new-development`; [PR #3](https://github.com/prabothcharith/accessibility-react/pull/3) merged the complete implementation into `main`. [Merged-main validation](https://github.com/prabothcharith/accessibility-react/actions/runs/38345207412) passed all jobs. PR #16 merged Clean light into main at `15e9465`; [that main run](https://github.com/prabothcharith/accessibility-react/actions/runs/38353340223) also passed all jobs. PR #17 and PR #18 are merged. Version 2 is published from the reviewed main archive; no Git release tag has been created.
|
|
48
53
|
|
|
49
54
|
## Hosted validation
|
|
50
55
|
|
|
@@ -63,7 +68,7 @@ The local suite now passes 61 tests. Font enlargement scales fixed line heights
|
|
|
63
68
|
1. **Human accessibility testing pending:** VoiceOver/NVDA, physical touch devices, forced-colors visual review, browser zoom 200/400%. Automated axe and emulation do not establish WCAG conformance.
|
|
64
69
|
2. **Local Firefox remains unavailable on this Mac.** The complete Firefox browser scenarios passed on Linux, so the local launch issue does not block automated release verification.
|
|
65
70
|
3. **License resolved for this release:** on 2026-10-13 the owner confirmed authority to license all included code under ISC. LICENSE and package/lock metadata now agree on ISC. Historical GPL/ISC/MIT discrepancies remain recorded in baseline/migration evidence.
|
|
66
|
-
4. **Version 2 identity and channel
|
|
71
|
+
4. **Version 2 identity and channel:** `accessibility-plugin-react@2.0.0` is published under `latest`, superseding the unpublished beta candidate. Registry metadata, integrity, clean React/Next consumers and the browser matrix were verified after npm's publish-time scan completed; see RELEASE.md.
|
|
67
72
|
5. One provider per document, no live cross-tab sync, immutable definitions/storage configuration. Routes should share the provider.
|
|
68
73
|
6. Effects target current-document HTML only; no Shadow DOM, iframe interiors, pseudo-elements or SVG/canvas text. Color filters alter host containing blocks. Late fonts/attribute-only style changes need a preference refresh. Very large/changing DOMs need application-specific profiling.
|
|
69
74
|
7. Media hiding retains layout and does not stop playback. CSP may restrict inline styles/data cursors. No universal host compatibility claim.
|
|
@@ -76,11 +81,11 @@ The selected Clean light foundation adds scoped palette variables, decorative ic
|
|
|
76
81
|
|
|
77
82
|
## Movement and quick-action follow-up
|
|
78
83
|
|
|
79
|
-
|
|
84
|
+
Merged through PR #17 (movement source `d5e21df`), the trigger persists normalized drag/corner placement alongside display settings, with pointer-cancellation/activation guards and keyboard/click alternatives. Fixed header/footer controls and a keyboard action jump keep reset available without scrolling. Resetting display settings preserves placement; position reset is separate. Local validation: 66 unit tests and packed React18/React19/Next consumers passed; the final local browser matrix passed 46 tests with four intentional skips, including measured-size geometry, mouse/Chromium touch dragging, WebKit mobile taps, cancelled drags, 320px/short-screen fit, persistence and fixed-action checks. Hosted movement validation is tracked by PR #17 checks; it is separate from the earlier merged-main results. Human touch, screen-reader and actual zoom acceptance remains pending.
|
|
80
85
|
|
|
81
86
|
## Release tracking
|
|
82
87
|
|
|
83
|
-
[Project #18](https://github.com/users/prabothcharith/projects/18) and [tracker #15](https://github.com/prabothcharith/accessibility-react/issues/15)
|
|
88
|
+
[Project #18](https://github.com/users/prabothcharith/projects/18) and [tracker #15](https://github.com/prabothcharith/accessibility-react/issues/15) track the remaining release work. Owner licensing/identity decisions (#4/#5), documentation correction (#9), final automated candidate checks and npm publication are complete. Human acceptance (#6–#8) and any separately authorized Git tag/GitHub release remain outstanding.
|
|
84
89
|
|
|
85
90
|
## npm identity follow-up
|
|
86
91
|
|
|
@@ -93,3 +98,9 @@ Owner-approved ISC beta source `cf4348b` passed [full hosted validation](https:/
|
|
|
93
98
|
## Version 2 channel selection
|
|
94
99
|
|
|
95
100
|
The owner requested 2.0.0 without beta on 2026-10-13. Package/lock version and publishConfig now use 2.0.0/latest; README and migration instructions match. This is explicit publication authorization despite the remaining documented human acceptance checks. The earlier account suspension is a registry blocker independent of version choice. Publication results will be recorded after the retry.
|
|
101
|
+
|
|
102
|
+
## Published version 2
|
|
103
|
+
|
|
104
|
+
The owner authorized merging PR #17 and PR #18 and dispatching publication. Main commit `1d4ab1c` contains package version 2.0.0, ISC and latest publishConfig. [Pre-merge final validation](https://github.com/prabothcharith/accessibility-react/actions/runs/38359055736) passed all jobs. After the trusted-publisher connection was saved, the failed publish job in [Action 38359604307](https://github.com/prabothcharith/accessibility-react/actions/runs/38359604307) was rerun on 2026-10-16. npm accepted the checksum-verified archive through OIDC.
|
|
105
|
+
|
|
106
|
+
The action's immediate registry check raced npm's publish-time malware scan and therefore remained red even though upload succeeded. After the scan completed, registry metadata reported 2.0.0/latest with ISC and integrity `sha512-CQFzF0pNl/bb+YVauI35+GNK2PIgk4qoh8+PnEkj1HAeW2lLMM/LTV5fq0tigNRnmPVX0M7rpYR4XPo820CQWw==`. Clean public-registry React18, React19/Tailwind and Next16 consumers passed declarations, ESM/CJS, SSR and production builds. The registry-installed browser matrix passed 55 tests with five intentional Next-only skips across Chromium, Firefox, WebKit and mobile WebKit. Workflow follow-up adds propagation-aware verification; no Git release tag was created.
|
package/docs/RELEASE.md
CHANGED
|
@@ -1,11 +1,18 @@
|
|
|
1
|
-
# npm release
|
|
1
|
+
# npm release and verification — updated 2026-10-20
|
|
2
|
+
|
|
3
|
+
## 2.0.1 documentation patch
|
|
4
|
+
|
|
5
|
+
Version `2.0.1` is a patch release containing the completed consumer README,
|
|
6
|
+
installation guidance, troubleshooting correction, and synchronized release
|
|
7
|
+
metadata. It does not change the runtime API or implementation. The exact
|
|
8
|
+
archive must still pass the release workflow before it is published.
|
|
2
9
|
|
|
3
10
|
## Identity and current state
|
|
4
11
|
|
|
5
12
|
- Owner-selected package: `accessibility-plugin-react` (same existing npm package).
|
|
6
|
-
- Registry
|
|
7
|
-
-
|
|
8
|
-
-
|
|
13
|
+
- Registry state before this release: `latest=2.0.0`; published versions 1.0.0 and 2.0.0; maintainer `praboth`.
|
|
14
|
+
- Current candidate: `2.0.1`, npm tag `latest`. This is a documentation-only patch over the published v2 implementation.
|
|
15
|
+
- Published source for 2.0.0: main commit `1d4ab1c`, containing the merged movement/fixed-actions and version 2 release work. The v2.0.0 Git tag now exists; no GitHub release was created.
|
|
9
16
|
- ISC is owner-approved for all included code as of 2026-10-13; LICENSE and package/lock metadata agree. Published 1.0.0 metadata says ISC and its README says MIT; historical inconsistency is retained in migration evidence.
|
|
10
17
|
- npm CLI authentication as package maintainer `praboth` is verified. Credentials/2FA remain outside repository files and chat.
|
|
11
18
|
|
|
@@ -32,7 +39,7 @@ Build and inspect a reviewable archive outside the checkout:
|
|
|
32
39
|
```sh
|
|
33
40
|
npm run build
|
|
34
41
|
npm pack --pack-destination /tmp
|
|
35
|
-
npm publish /tmp/accessibility-plugin-react-2.0.
|
|
42
|
+
npm publish /tmp/accessibility-plugin-react-2.0.1.tgz --dry-run --tag latest --access public
|
|
36
43
|
```
|
|
37
44
|
|
|
38
45
|
## Executed candidate checks
|
|
@@ -53,10 +60,12 @@ npm whoami
|
|
|
53
60
|
The owner selected the candidate version/channel, resolved licensing and authorized version 2 publication on 2026-10-13. Upload the exact verified archive using:
|
|
54
61
|
|
|
55
62
|
```sh
|
|
56
|
-
npm publish /tmp/accessibility-plugin-react-2.0.
|
|
63
|
+
npm publish /tmp/accessibility-plugin-react-2.0.1.tgz --tag latest --access public
|
|
57
64
|
```
|
|
58
65
|
|
|
59
|
-
The package's approved publishConfig uses latest. Successful publication makes
|
|
66
|
+
The package's approved publishConfig uses latest. Successful publication makes
|
|
67
|
+
2.0.1 the default npm install target. Verify the registry package and clean
|
|
68
|
+
consumer installs before creating an authorized release tag.
|
|
60
69
|
|
|
61
70
|
After upload, verify registry name/version/license and latest tag, archive integrity, and clean registry installations in the React/Next consumers. Record the published version and source commit only after those checks succeed.
|
|
62
71
|
|
|
@@ -70,13 +79,13 @@ After npm browser authentication, publication was rejected with E403: the mainta
|
|
|
70
79
|
|
|
71
80
|
The owner subsequently selected 2.0.0 under latest. The registry account hold is independent of release version; record the version 2 retry result separately. The hold duration is unknown; no automatic retry is scheduled. License/identity issues #4 and #5 are resolved; publication and stable human acceptance remain open.
|
|
72
81
|
|
|
73
|
-
##
|
|
82
|
+
## Historical version 2 retry
|
|
74
83
|
|
|
75
84
|
The owner requested export/publication as 2.0.0 without beta on 2026-10-13. Package/lock metadata and publishConfig were changed to 2.0.0/latest, and a new archive is prepared for verification and upload. The earlier beta integrity above applies only to that unpublished beta artifact. Until successful registry verification, 2.0.0 is not claimed as published.
|
|
76
85
|
|
|
77
86
|
## GitHub Actions publication
|
|
78
87
|
|
|
79
|
-
The owner requested a GitHub Actions publishing route for 2.0.
|
|
88
|
+
The owner requested a GitHub Actions publishing route for 2.0.1/latest. `.github/workflows/publish.yml` is manually dispatched, defaults to dry-run, validates the exact committed name/version/ISC/latest metadata, runs source/packed-consumer/full Linux browser/audit checks, and uploads the tested archive with its SHA512 checksum. The publishing job downloads that archive and uses npm trusted publishing (OIDC), then verifies registry integrity/latest and clean React18/React19/Next registry consumers. No npm token or automatic push/tag publication is configured.
|
|
80
89
|
|
|
81
90
|
Configure npm’s trusted publisher for package accessibility-plugin-react:
|
|
82
91
|
|
|
@@ -97,11 +106,43 @@ Browser/2FA authorization may be required. Trusted publishing requires compatibl
|
|
|
97
106
|
GitHub requires workflow_dispatch workflows to exist on the default branch. PR #17 supplies movement and PR #18 supplies the npm identity/release workflow; merge #17, retarget #18 to main, and merge it after owner authorization. Then run:
|
|
98
107
|
|
|
99
108
|
```sh
|
|
100
|
-
gh workflow run publish.yml --ref main -f version=2.0.
|
|
109
|
+
gh workflow run publish.yml --ref main -f version=2.0.1 -f dry_run=true
|
|
101
110
|
# Authorized real publication:
|
|
102
|
-
gh workflow run publish.yml --ref main -f version=2.0.
|
|
111
|
+
gh workflow run publish.yml --ref main -f version=2.0.1 -f dry_run=false
|
|
103
112
|
```
|
|
104
113
|
|
|
105
114
|
References: [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/), [npm trust CLI](https://docs.npmjs.com/cli/v11/commands/npm-trust/), [GitHub manual workflow requirements](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow). Do not report successful publication until the registry and consumer steps succeed.
|
|
106
115
|
|
|
107
116
|
Local version 2 preparation checks passed: 66 unit tests, type/lint/format/build/archive validation, and packed React18/React19/Next consumer builds. The publication workflow passed actionlint 1.7.12; malformed registry-consumer versions are rejected before installation. The workflow itself has not been dispatched; main-branch availability and npm trusted-publisher setup are still required.
|
|
117
|
+
|
|
118
|
+
## GitHub Actions attempt — 2026-10-13
|
|
119
|
+
|
|
120
|
+
PR #17 and PR #18 were merged with owner authorization; main is 1d4ab1c. [Publication Action 38359604307](https://github.com/prabothcharith/accessibility-react/actions/runs/38359604307) ran with version=2.0.0 and dry_run=false. Its validate job passed, preserved the tested archive, and the publishing job verified the archive checksum. Upload then failed with npm E404/permission denial. The trusted-publisher connection had not been saved: both CLI and browser setup were rejected, with the browser explicitly showing the temporary account-suspension notice. Registry checks still found only 1.0.0/latest; version 2.0.0 is not published.
|
|
121
|
+
|
|
122
|
+
At the owner's request, a fresh GitHub trusted-publisher form was filled in Chrome with user prabothcharith, repository accessibility-react, workflow publish.yml, no environment and Allow npm publish enabled. It is awaiting the owner's Set up connection/security-key authorization. A filled form is not a saved trusted connection. Once the connection is successfully saved and npm permits publication, rerun the failed publishing job to reuse the validated artifact:
|
|
123
|
+
|
|
124
|
+
```sh
|
|
125
|
+
gh run rerun 38359604307 --failed
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Verify registry metadata/integrity/latest and registry consumers before reporting success. No further retry is automatic.
|
|
129
|
+
|
|
130
|
+
## Successful version 2 publication — 2026-10-16
|
|
131
|
+
|
|
132
|
+
The owner saved the npm trusted-publisher connection for `prabothcharith/accessibility-react` and `publish.yml`, then authorized the publication retry. The failed publish job in [Action 38359604307](https://github.com/prabothcharith/accessibility-react/actions/runs/38359604307) reused the archive previously validated from main commit `1d4ab1c`. Its SHA512 checksum check passed and npm accepted `accessibility-plugin-react@2.0.0` through OIDC under `latest`.
|
|
133
|
+
|
|
134
|
+
The workflow queried the registry immediately and received a temporary 404 while npm's publish-time malware scan was still processing the tarball. After the scan completed, independent checks confirmed version/latest/ISC metadata and integrity `sha512-CQFzF0pNl/bb+YVauI35+GNK2PIgk4qoh8+PnEkj1HAeW2lLMM/LTV5fq0tigNRnmPVX0M7rpYR4XPo820CQWw==`. Clean installs from the public registry passed React18, React19/Tailwind and Next16 declaration checks, ESM/CommonJS loading, SSR and production builds. The installed-package browser matrix passed 55 tests with five intentional Next-only skips across Chromium, Firefox, desktop WebKit and mobile WebKit.
|
|
135
|
+
|
|
136
|
+
The workflow follow-up retries registry verification for the expected npm scan delay and supports Windows validation. Human screen-reader, physical-device, actual-zoom, forced-colors and representative host acceptance remain pending. Publication did not authorize or create a Git tag/GitHub release.
|
|
137
|
+
|
|
138
|
+
## GitHub Packages and GitHub release
|
|
139
|
+
|
|
140
|
+
The public npm package remains `accessibility-plugin-react`. The same 2.0.0
|
|
141
|
+
archive is also published to GitHub Packages under the required scoped name
|
|
142
|
+
`@prabothcharith/accessibility-react` through
|
|
143
|
+
`.github/workflows/publish-github-package.yml`. The workflow creates a scoped
|
|
144
|
+
manifest only in its release staging directory, so the repository package name
|
|
145
|
+
and public npm package are unchanged.
|
|
146
|
+
|
|
147
|
+
The GitHub release is tagged `v2.0.0` from the validated `main` commit after
|
|
148
|
+
the GitHub Packages verification succeeds.
|
package/docs/ROADMAP.md
CHANGED
|
@@ -2,21 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
No deadlines or percentage-complete estimates. Status is based on current evidence in PROJECT_STATUS.md.
|
|
4
4
|
|
|
5
|
-
| Phase | Priority | Objective / tasks | Dependencies | Acceptance / deliverables | Risk / status
|
|
6
|
-
| --------------------------- | -------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- |
|
|
7
|
-
| Investigation | P0 | Compare vanilla/main/development/new-development, PR #1, history; baseline all checks | Git/registry access | Evidence-backed baseline and parity matrix | Completed locally
|
|
8
|
-
| Core stabilization | P0 | Provider effects, filter composition, independent storage, reset cancellation, no invisible hit area | Baseline | Close/reopen, reset race, restore, dynamic content and cleanup regressions | Implemented; local automated verification
|
|
9
|
-
| Features and extension | P1 | All fifteen controllers, missing original variants, safe custom apply contract | Core | Per-feature bounds/states and custom restore/reset/unmount tests; public examples | Implemented; host-specific effect limits documented
|
|
10
|
-
| Accessibility/UI | P1 | Non-modal semantics, names/focus, safe-area responsive CSS, motion preferences | Core | Keyboard/browser/axe checks plus human SR, actual zoom and device review | Automated checks implemented; human review remains
|
|
11
|
-
| Packaging/frameworks | P1 | Client boundary, ESM/CJS/types/CSS, React 18/19, Next App/Pages, built examples | Core + build | Clean tarball installs, production builds and runtime tests | Local and hosted consumer verification passed; complete Firefox coverage passed on Linux
|
|
12
|
-
| CI/release validation | P1 | Execute hosted matrix; fix Firefox launch environment; record results | Push/PR workflow and compatible runner | Passing Node22/24 jobs and full browser matrix on exact release commit | Completed: hosted Node22/24 and full Chromium/Firefox/WebKit/mobile matrix passed
|
|
13
|
-
| Clean light base design | P1 | Apply owner-selected light concept, icons, tokens and responsive rows | Stabilized core | Browser/axe/target-size checks, actual runtime screenshots and documented overrides | Merged through PR #16; local and hosted checks passed
|
|
14
|
-
| Movement and quick actions | P1 | Persist drag/corner placement, non-drag controls and fixed reset/footer | Clean light foundation | Drag/cancel/reload/resize and pinned-action browser regressions |
|
|
15
|
-
| Ownership/release | P1 | Continue confirmed npm identity; resolve license; choose version; approve merge/tag/publish | Owner decision + all gates | Traceable authorized release with clean registry install |
|
|
16
|
-
| Performance/dynamic styling | P2 | Benchmark large documents; incremental observation; attribute/font-load refresh | Real host profiles | Measured budgets, no redundant work, style-change regression tests | Planned; current child-list/resize path works
|
|
17
|
-
| Host effects hardening | P2 | Optional explicit effect scopes, CSP renderer, Shadow DOM strategy, fixed-descendant filter alternatives | API design and real use cases | Documented contract with package/browser tests | Planned; avoid universal-host compatibility claims
|
|
18
|
-
| UX enhancements | P2 | Richer per-control labels and localization polish | Stable core + accessibility review | Pointer/touch/keyboard equivalence, no activation regressions | Planned after current design/movement work
|
|
19
|
-
| Multi-instance/cross-tab | P2 | Decide if needed; deterministic arbitration/synchronization | Usage evidence | Isolated lifetime, persistence and interaction tests | Deferred; one provider/document enforced
|
|
5
|
+
| Phase | Priority | Objective / tasks | Dependencies | Acceptance / deliverables | Risk / status |
|
|
6
|
+
| --------------------------- | -------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
7
|
+
| Investigation | P0 | Compare vanilla/main/development/new-development, PR #1, history; baseline all checks | Git/registry access | Evidence-backed baseline and parity matrix | Completed locally |
|
|
8
|
+
| Core stabilization | P0 | Provider effects, filter composition, independent storage, reset cancellation, no invisible hit area | Baseline | Close/reopen, reset race, restore, dynamic content and cleanup regressions | Implemented; local automated verification |
|
|
9
|
+
| Features and extension | P1 | All fifteen controllers, missing original variants, safe custom apply contract | Core | Per-feature bounds/states and custom restore/reset/unmount tests; public examples | Implemented; host-specific effect limits documented |
|
|
10
|
+
| Accessibility/UI | P1 | Non-modal semantics, names/focus, safe-area responsive CSS, motion preferences | Core | Keyboard/browser/axe checks plus human SR, actual zoom and device review | Automated checks implemented; human review remains |
|
|
11
|
+
| Packaging/frameworks | P1 | Client boundary, ESM/CJS/types/CSS, React 18/19, Next App/Pages, built examples | Core + build | Clean tarball installs, production builds and runtime tests | Local and hosted consumer verification passed; complete Firefox coverage passed on Linux |
|
|
12
|
+
| CI/release validation | P1 | Execute hosted matrix; fix Firefox launch environment; record results | Push/PR workflow and compatible runner | Passing Node22/24 jobs and full browser matrix on exact release commit | Completed: hosted Node22/24 and full Chromium/Firefox/WebKit/mobile matrix passed |
|
|
13
|
+
| Clean light base design | P1 | Apply owner-selected light concept, icons, tokens and responsive rows | Stabilized core | Browser/axe/target-size checks, actual runtime screenshots and documented overrides | Merged through PR #16; local and hosted checks passed |
|
|
14
|
+
| Movement and quick actions | P1 | Persist drag/corner placement, non-drag controls and fixed reset/footer | Clean light foundation | Drag/cancel/reload/resize and pinned-action browser regressions | Merged through PR #17; local and full hosted checks passed |
|
|
15
|
+
| Ownership/release | P1 | Continue confirmed npm identity; resolve license; choose version; approve merge/tag/publish | Owner decision + all gates | Traceable authorized release with clean registry install | 2.0.0/latest published and registry consumers verified; Git tag and human acceptance remain separate |
|
|
16
|
+
| Performance/dynamic styling | P2 | Benchmark large documents; incremental observation; attribute/font-load refresh | Real host profiles | Measured budgets, no redundant work, style-change regression tests | Planned; current child-list/resize path works |
|
|
17
|
+
| Host effects hardening | P2 | Optional explicit effect scopes, CSP renderer, Shadow DOM strategy, fixed-descendant filter alternatives | API design and real use cases | Documented contract with package/browser tests | Planned; avoid universal-host compatibility claims |
|
|
18
|
+
| UX enhancements | P2 | Richer per-control labels and localization polish | Stable core + accessibility review | Pointer/touch/keyboard equivalence, no activation regressions | Planned after current design/movement work |
|
|
19
|
+
| Multi-instance/cross-tab | P2 | Decide if needed; deterministic arbitration/synchronization | Usage evidence | Isolated lifetime, persistence and interaction tests | Deferred; one provider/document enforced |
|
|
20
20
|
|
|
21
21
|
Release gates are not satisfied by checking in tests or CI configuration. Execute them on the final candidate. A local Chromium/WebKit pass is not a Firefox pass, and an axe pass is not screen-reader or WCAG certification.
|
|
22
22
|
|
|
@@ -27,3 +27,5 @@ The owner confirmed `accessibility-plugin-react` as the registry identity on 202
|
|
|
27
27
|
Final ISC beta source cf4348b passed the full hosted matrix. npm rejected the upload due to a temporary account suspension; 2.0.0-beta.1 is not published. Owner decision issues #4/#5 are closed; publication #11 and human stable-release acceptance remain open. See RELEASE.md.
|
|
28
28
|
|
|
29
29
|
The owner subsequently chose 2.0.0 under latest instead of beta. Current release preparation follows that instruction; human accessibility acceptance remains documented as pending. Earlier beta preparation/hold notes above are historical; see RELEASE.md for the current version and publication result.
|
|
30
|
+
|
|
31
|
+
PR #17/#18 are merged into main at `1d4ab1c`. The trusted GitHub publisher uploaded the reviewed archive as `accessibility-plugin-react@2.0.0` under `latest` on 2026-10-16, and clean registry consumers passed after npm's publish-time scan completed. No Git tag/GitHub release was authorized or created. See RELEASE.md for the exact evidence and the remaining human-acceptance work.
|
package/docs/TROUBLESHOOTING.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| “useAccessibility must be used within…” | Put custom control below AccessibilityPlugin and import from the same installed package copy. Check npm ls react/react-dom for duplication. |
|
|
7
7
|
| “Only one AccessibilityPlugin…” | Mount one provider at the persistent app/layout root; do not mount another in each route. Different persistence keys do not permit competing global effect owners. |
|
|
8
8
|
| Changing storage key throws | Remount with React `key`; persistence identity is intentionally immutable. |
|
|
9
|
-
| No effect after installing registry version |
|
|
9
|
+
| No effect after installing registry version | Confirm the installed version with `npm ls accessibility-plugin-react`, import `accessibility-plugin-react/style.css`, and verify the packed/registry archive rather than importing repository source. |
|
|
10
10
|
| Hydration warnings | Use the built distribution with preserved client directive. Put custom hooks/effect functions in a Client Component. Avoid conditional browser globals in render. Check host hydration independently. |
|
|
11
11
|
| Preference appears after first paint | Storage restores client-side after hydration. A brief default paint is expected; no flash-free SSR claim is made. |
|
|
12
12
|
| Gray makes saturation look ineffective | Grayscale is applied last. Turn it off to see retained saturation. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "accessibility-plugin-react",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "A composable React display-preference widget with a clean light design, persistent settings and movable accessible controls.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|