@pigmilcom/a11y 1.0.1 → 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.
Potentially problematic release.
This version of @pigmilcom/a11y might be problematic. Click here for more details.
- package/README.md +41 -1
- package/dist/a11y.cdn.js +8 -224
- package/dist/index.css +4 -0
- package/dist/index.min.css +1 -0
- package/dist/index.min.js +1 -0
- package/dist/index.min.mjs +1 -0
- package/package.json +4 -2
- package/src/cdn.jsx +11 -11
package/README.md
CHANGED
|
@@ -6,7 +6,31 @@ WCAG 2.1 accessibility widget. Drop in one `<script>` tag **or** install via npm
|
|
|
6
6
|
|
|
7
7
|
## CDN — Plug & Play
|
|
8
8
|
|
|
9
|
-
No React, no npm, no build step.
|
|
9
|
+
No React, no npm, no build step. Add one tag to your `<head>`.
|
|
10
|
+
|
|
11
|
+
### jsDelivr (recommended)
|
|
12
|
+
|
|
13
|
+
Served from the npm registry via jsDelivr's global edge network — always the latest published version:
|
|
14
|
+
|
|
15
|
+
```html
|
|
16
|
+
<script
|
|
17
|
+
src="https://cdn.jsdelivr.net/npm/@pigmilcom/a11y/dist/a11y.cdn.js"
|
|
18
|
+
data-position="bottom-right"
|
|
19
|
+
></script>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Pin to a specific version:
|
|
23
|
+
|
|
24
|
+
```html
|
|
25
|
+
<script
|
|
26
|
+
src="https://cdn.jsdelivr.net/npm/@pigmilcom/a11y@1.0.1/dist/a11y.cdn.js"
|
|
27
|
+
data-position="bottom-right"
|
|
28
|
+
></script>
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Self-hosted (pigmil CDN)
|
|
32
|
+
|
|
33
|
+
Use your own CDN endpoint for full control over deployment:
|
|
10
34
|
|
|
11
35
|
```html
|
|
12
36
|
<script
|
|
@@ -54,6 +78,22 @@ PigmilA11y.unmount(); // remove the widget and clean up
|
|
|
54
78
|
|
|
55
79
|
---
|
|
56
80
|
|
|
81
|
+
## Dist files
|
|
82
|
+
|
|
83
|
+
Every build outputs these files to `dist/`:
|
|
84
|
+
|
|
85
|
+
| File | Format | Description |
|
|
86
|
+
| ------------------- | ------ | --------------------------------------------- |
|
|
87
|
+
| `index.js` | CJS | npm (unminified, for bundlers) |
|
|
88
|
+
| `index.mjs` | ESM | npm (unminified, for bundlers) |
|
|
89
|
+
| `index.min.js` | CJS | npm (minified) |
|
|
90
|
+
| `index.min.mjs` | ESM | npm (minified) |
|
|
91
|
+
| `index.css` | CSS | Stylesheet import (`@pigmilcom/a11y/styles`) |
|
|
92
|
+
| `index.min.css` | CSS | Minified stylesheet |
|
|
93
|
+
| `a11y.cdn.js` | IIFE | CDN bundle — React bundled, CSS inlined, minified |
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
57
97
|
## npm Installation
|
|
58
98
|
|
|
59
99
|
```bash
|