@a11y-pulse/skip-link-audit 0.1.1 → 0.1.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 +13 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -51,6 +51,17 @@ await browser.close();
|
|
|
51
51
|
|
|
52
52
|
See [`examples/puppeteer`](./examples/puppeteer) for a complete, runnable example.
|
|
53
53
|
|
|
54
|
+
## Browser support
|
|
55
|
+
|
|
56
|
+
| Adaptor | Browser | Supported |
|
|
57
|
+
| --- | --- | --- |
|
|
58
|
+
| Puppeteer | Chrome | Yes |
|
|
59
|
+
| Playwright | Chromium | Yes |
|
|
60
|
+
| Playwright | WebKit | **No.** WebKit does not move focus to links when Tab is pressed, and a skip link is a link, so the audit finds nothing. |
|
|
61
|
+
| Playwright | Firefox | Yes |
|
|
62
|
+
|
|
63
|
+
Verified by this repo's integration suites, which run every audit against each of these engines. Unsupported and partial cases are skipped there with the reason printed alongside them.
|
|
64
|
+
|
|
54
65
|
## Options
|
|
55
66
|
|
|
56
67
|
The following options can be passed to `runSkipLinkAudit` as `SkipLinkOptions`:
|
|
@@ -97,7 +108,7 @@ Activation uses a real Enter keypress rather than a synthetic click, so the keyb
|
|
|
97
108
|
|
|
98
109
|
The audit itself is framework-agnostic: it drives a page through an **adaptor**, a small interface of primitives (evaluate JS in the page, press Tab, press Enter) that the audit calls without knowing which browser automation library is behind it.
|
|
99
110
|
|
|
100
|
-
|
|
111
|
+
[`@a11y-pulse/browser-adaptor`](../browser-adaptor) ships two implementations, `PuppeteerAdaptor` and `PlaywrightAdaptor`. Other environments (Selenium, WebDriver) can be supported by implementing the same interface, exported as `SkipLinkAuditAdaptor` (aliased as `BrowserAdaptor` from the package root).
|
|
101
112
|
|
|
102
113
|
### `SkipLinkAuditAdaptor` / `BrowserAdaptor`
|
|
103
114
|
|
|
@@ -123,7 +134,7 @@ class MyFrameworkAdaptor implements SkipLinkAuditAdaptor {
|
|
|
123
134
|
}
|
|
124
135
|
```
|
|
125
136
|
|
|
126
|
-
Use [`src/adaptors/puppeteer.ts`](
|
|
137
|
+
Use [`@a11y-pulse/browser-adaptor`'s `src/adaptors/puppeteer.ts`](../browser-adaptor/src/adaptors/puppeteer.ts) as a reference implementation. It is a small, self-contained example of every method the audit needs.
|
|
127
138
|
|
|
128
139
|
## Limitations
|
|
129
140
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@a11y-pulse/skip-link-audit",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "WCAG 2.4.1 Bypass Blocks audit that finds skip-link-like in-page anchors in the first tab stops and verifies that activating them moves keyboard focus.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -55,6 +55,6 @@
|
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"happy-dom": "^20.12.0",
|
|
58
|
-
"puppeteer": "^25.
|
|
58
|
+
"puppeteer": "^25.10.0"
|
|
59
59
|
}
|
|
60
60
|
}
|