ally-widget 1.0.3 → 1.0.4
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 +13 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -93,6 +93,7 @@ widget.startAccessibleWebWidget();
|
|
|
93
93
|
| `lang` | `string` | browser lang | `'en'` or `'ne'` |
|
|
94
94
|
| `storageKey` | `string` | `'ally-wgt'` | localStorage key — change to avoid collisions when multiple instances share a domain |
|
|
95
95
|
| `keyboardShortcut` | `boolean` | `true` | `Alt+A` toggles the panel. Set `false` to disable |
|
|
96
|
+
| `showViolationBubble` | `boolean` | `true` | Red badge on the toggle button showing the axe-core violation count. Set `false` to hide it |
|
|
96
97
|
| `icon` | `string` | `'default'` | Built-in variant name or a raw SVG string for the toggle button icon |
|
|
97
98
|
| `icons` | `object` | — | Override any icon in the full icon set (see [Icon Keys](#icon-keys)) |
|
|
98
99
|
| `poweredByText` | `string` | `'Ally Widget'` | Footer link label |
|
|
@@ -855,6 +856,18 @@ Append `?ally-dev=true` to any URL to enable the Annotations and Accessibility R
|
|
|
855
856
|
https://yoursite.com/page?ally-dev=true
|
|
856
857
|
```
|
|
857
858
|
|
|
859
|
+
The axe-core library is loaded on demand in dev mode only — zero weight in production.
|
|
860
|
+
|
|
861
|
+
### Hiding the violation badge
|
|
862
|
+
|
|
863
|
+
When violations are found, a red number badge appears on the toggle button. To hide it:
|
|
864
|
+
|
|
865
|
+
```js
|
|
866
|
+
AllyWidget.init({
|
|
867
|
+
showViolationBubble: false
|
|
868
|
+
});
|
|
869
|
+
```
|
|
870
|
+
|
|
858
871
|
---
|
|
859
872
|
|
|
860
873
|
## Keyboard Shortcut
|
package/package.json
CHANGED