Releases: a11ywatch/kayle
Releases · a11ywatch/kayle
v0.8.55
v0.8.22
What's Changed
- fix 'it' base locales htmlcs
- add 'ar' locales htmlcs
- add 'ko' locales htmlcs
Full Changelog: v0.7.12...v0.8.22
v0.8.17
What's Changed
This release we bring to you kayle as a CLI!
npm install puppeteer kayle_cli -g
# view options
kayle_cli -help
# audit a website
kayle_cli https://www.somewebsite.com
Full Changelog: v0.7.12...v0.8.17
v0.7.12
Whats Changed
New runner added IBM-Ace
import { kayle } from "kayle";
const { issues, pageUrl, documentTitle, meta, automateable } = await kayle({
page,
browser,
runners: ["ace"],
origin: "https://www.drake.com",
});
// example results for an issue
// {
// context: '<a id="cta_button_5479613_5d5e3141-f749-4fa7-b734-25667e531cfe" class="cta_button " href="https://www.drake.com/cs/c/?cta_guid=5d5e3141-f749-4fa7-b734-25667e531cfe&signature=AAH58kHo1qzsXaPOT8WcWuRYgZglZwRuZw&pageId=8839032963&placement_gu...',
// selector: '#cta_button_5479613_5d5e3141-f749-4fa7-b734-25667e531cfe',
// code: 'WCAG2AA.Principle1.Guideline1_4.1_4_3.G18.Alpha',
// type: 'warning',
// typeCode: 2,
// message: "This element's text or background contains transparency. Ensure the contrast ratio between the text and background are at least 4.5:1.",
// runner: 'ace',
// recurrence: 0
// }
Full Changelog: v0.4.55...v0.7.12
v0.4.55
Whats Changed
- major performance changes and flake fixes from microTask sort switch to in place sort algorithm.
- fix table header testing htmlcs.
Full Changelog: v0.3.45...v0.4.51
v0.4.32
Whats Changed
- Compiled kayle browser extension
--
Use the command yarn build:extension
to compile the scripts into a valid chrome extension.
Here is a an example locally
import puppeteer from "puppeteer";
import { kayle } from "kayle";
import { join } from "path";
import { cwd } from "process";
(async () => {
// project root directory loading extension
const ext = join(cwd(), "chrome-extension");
const browser = await puppeteer.launch({
headless: "new",
dumpio: true,
ignoreDefaultArgs: ["--disable-extensions"],
args: [
`--load-extension=${ext}`, // <- runs on every page with extensions on chrome urls
"--extensions-on-chrome-urls",
],
});
const page = await browser.newPage();
const data = await kayle(
{
page,
browser,
runners: ["htmlcs", "axe"],
includeWarnings: true,
origin: "https://a11ywatch.com",
_browserExtension: true, // enable the extension
},
true // prevent closing the page on finish
);
console.log(data);
await browser.close();
})();
v0.4.23
Whats Changed
- Add brave browser adblock support.
- Major performance improvements and bug fixes.
- Fix htmlcs table testing index crash.
In order to enable set the env var KAYLE_ADBLOCK=true
and install adblock-rs with npm i adblock-rs
.
Full Changelog: v0.3.45...v0.4.23
v0.3.65
Whats Changed
- feat(navigation): add navigation with html or a url.
Example playwright
import { kayle } from "kayle";
import { chromium } from "playwright";
const browser = await chromium.launch({ headless: "new" });
const page = await browser.newPage();
const results = await kayle({
page,
browser,
runners: ["htmlcs", "axe"],
includeWarnings: true,
origin: "https://a11ywatch.com",
});
Puppeteer
import { kayle } from "kayle";
import { launch } from "puppeteer";
const browser = await launch({ headless: "new" });
const page = await browser.newPage();
const results = await kayle({
page,
browser,
runners: ["htmlcs", "axe"],
includeWarnings: true,
origin: "https://a11ywatch.com",
});
v0.3.45
Major Release
- base release for puppeteer or playwright universal compatibility
Full Changelog: https://github.com/a11ywatch/a11y/commits/v0.3.38