accessibility-plugin-react 2.0.1 → 2.0.2
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 +7 -7
- package/dist/index.js +25 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +25 -0
- package/dist/index.mjs.map +1 -1
- package/docs/API.md +2 -2
- package/docs/BUILD_AND_RELEASE_PLAN.md +456 -0
- package/docs/DEVELOPMENT.md +1 -1
- package/docs/INSTALLATION.md +1 -3
- package/docs/PROJECT_STATUS.md +3 -4
- package/docs/RELEASE.md +19 -14
- package/docs/TROUBLESHOOTING.md +21 -21
- package/package.json +1 -1
package/docs/TROUBLESHOOTING.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
# Troubleshooting
|
|
2
2
|
|
|
3
|
-
| Symptom | Check / resolution
|
|
4
|
-
| ------------------------------------------------------- |
|
|
5
|
-
| Widget unstyled |
|
|
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
|
-
| “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
|
-
| Changing storage key throws | Remount with React `key`; persistence identity is intentionally immutable.
|
|
9
|
-
| No effect after installing registry version | Confirm the installed version with `npm ls accessibility-plugin-react
|
|
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
|
-
| 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
|
-
| Gray makes saturation look ineffective | Grayscale is applied last. Turn it off to see retained saturation.
|
|
13
|
-
| Fixed host element moves when filters enabled | CSS filters create containing blocks/stacking contexts. Test your host's fixed descendants; this browser behavior is an integration limitation. The widget itself is portaled outside the filtered roots.
|
|
14
|
-
| Text fails to refresh after theme/font/style change | Child insertion and window resize are observed; pure class/style attribute changes and late font-load metrics are not. Toggle the preference to remeasure. Avoid multiple systems writing the same property.
|
|
15
|
-
| iframe/Shadow DOM content unchanged | Only HTML in the current document is processed. Shadow roots, iframe interiors, SVG/canvas text, pseudo-elements and raw text nodes directly under body are outside scope.
|
|
16
|
-
| Hidden video still audible | Visibility is not playback control. Pause/mute through your application's player. Only recognized video embeds are hidden; maps/documents remain.
|
|
17
|
-
| Custom reset changes UI but not page | Move DOM changes from event handlers to the hook's apply callback with cleanup. For ordinary React effects use value as a dependency and restore prior styles.
|
|
18
|
-
| Removed control's effect persists | Intentional provider ownership. Reset before removing a feature, or reset globally. Remount provider to change the feature set/definitions.
|
|
19
|
-
| Storage unavailable or full | Widget stays usable in memory. There is no server sync. Keep custom values small and JSON-compatible; set persist=false if needed.
|
|
20
|
-
| Preferences differ across tabs | No live cross-tab synchronization. The last write controls the next restoration.
|
|
21
|
-
| CSP blocks styling or cursor | Built-ins use inline style properties and an SVG data cursor. Test your actual CSP; there is no nonce-based stylesheet renderer in this release. Native cursor fallback remains.
|
|
22
|
-
| Extremely large/changing pages are slow | Active text/media effects traverse the document on relevant child mutations. Profile your real page; no universal large-DOM performance promise.
|
|
23
|
-
| Firefox Playwright launch fails before loading the page | On the validation Mac, Firefox 157 build 1555 exited “Could not find profile folder”, including with TMPDIR=/tmp. This is a local environment failure. Full Firefox integration passed on the Linux CI runner; the local launch issue remains reproducible.
|
|
3
|
+
| Symptom | Check / resolution |
|
|
4
|
+
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5
|
+
| Widget unstyled | Ensure the package is imported in the browser bundle. It automatically injects its scoped CSS; applications using an explicit CSS pipeline can load `accessibility-plugin-react/style.css`. Inspect packed CSS, not source Tailwind directives. No consumer Tailwind configuration is required. |
|
|
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
|
+
| “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
|
+
| Changing storage key throws | Remount with React `key`; persistence identity is intentionally immutable. |
|
|
9
|
+
| No effect after installing registry version | Confirm the installed version with `npm ls accessibility-plugin-react` and verify the packed/registry archive rather than importing repository source. Applications using an explicit CSS pipeline should also verify the `accessibility-plugin-react/style.css` load. |
|
|
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
|
+
| 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
|
+
| Gray makes saturation look ineffective | Grayscale is applied last. Turn it off to see retained saturation. |
|
|
13
|
+
| Fixed host element moves when filters enabled | CSS filters create containing blocks/stacking contexts. Test your host's fixed descendants; this browser behavior is an integration limitation. The widget itself is portaled outside the filtered roots. |
|
|
14
|
+
| Text fails to refresh after theme/font/style change | Child insertion and window resize are observed; pure class/style attribute changes and late font-load metrics are not. Toggle the preference to remeasure. Avoid multiple systems writing the same property. |
|
|
15
|
+
| iframe/Shadow DOM content unchanged | Only HTML in the current document is processed. Shadow roots, iframe interiors, SVG/canvas text, pseudo-elements and raw text nodes directly under body are outside scope. |
|
|
16
|
+
| Hidden video still audible | Visibility is not playback control. Pause/mute through your application's player. Only recognized video embeds are hidden; maps/documents remain. |
|
|
17
|
+
| Custom reset changes UI but not page | Move DOM changes from event handlers to the hook's apply callback with cleanup. For ordinary React effects use value as a dependency and restore prior styles. |
|
|
18
|
+
| Removed control's effect persists | Intentional provider ownership. Reset before removing a feature, or reset globally. Remount provider to change the feature set/definitions. |
|
|
19
|
+
| Storage unavailable or full | Widget stays usable in memory. There is no server sync. Keep custom values small and JSON-compatible; set persist=false if needed. |
|
|
20
|
+
| Preferences differ across tabs | No live cross-tab synchronization. The last write controls the next restoration. |
|
|
21
|
+
| CSP blocks styling or cursor | Built-ins use inline style properties and an SVG data cursor. Test your actual CSP; there is no nonce-based stylesheet renderer in this release. Native cursor fallback remains. |
|
|
22
|
+
| Extremely large/changing pages are slow | Active text/media effects traverse the document on relevant child mutations. Profile your real page; no universal large-DOM performance promise. |
|
|
23
|
+
| Firefox Playwright launch fails before loading the page | On the validation Mac, Firefox 157 build 1555 exited “Could not find profile folder”, including with TMPDIR=/tmp. This is a local environment failure. Full Firefox integration passed on the Linux CI runner; the local launch issue remains reproducible. |
|
|
24
24
|
|
|
25
25
|
For a bug report, include package/build SHA, React/framework/browser/OS versions, a small reproducible application, selected settings, host CSS and whether the actual tarball reproduces it. Do not include private stored preferences or credentials. See baseline and project status for known issues rather than relying on historical completion claims.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "accessibility-plugin-react",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
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",
|