accessibility-insights-report
Accessibility Insights Report
Last updated 5 hours ago by accessibility-insights-team .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install accessibility-insights-report 
SYNC missed versions from official npm registry.

accessibility-insights-report

Publish axe-core accessibility scan results as self-contained HTML files in the same format as accessibility-insights-web.

Usage

Before using accessibility-insights-report, you will need to run an axe accessibility scan to produce some axe results to convert. Typically, you would do this by using an axe integration library for your favorite browser automation tool (axe-puppeteer, axe-webdriverjs, cypress-axe).

accessibility-insights-report exports a factory that can be used to create a report object and output its results as HTML.

Use it like this:

import * as Axe from 'axe';
import * as AxePuppeteer from 'axe-puppeteer';
import * as fs from 'fs';
import * as Puppeteer from 'puppeteer'
import * as util from 'util';

import { reporterFactory } from "accessibility-insights-report";

test('my accessibility test', async () => {
    // This example uses axe-puppeteer, but you can use any axe-based library
    // that outputs axe scan results in the default axe output format
    const testPage: Playwright.Page = /* ... set up your test page ... */;
    const axeResults: Axe.AxeResults = await new AxePuppeteer(testPage).analyze();

    // Construct the reporter object from the factory
    const reporter = reporterFactory();

    // Perform the conversion
    const html = reporter.fromAxeResult(axeResults).asHTML();

    // Output the HTML file for offline viewing in any modern browser
    await util.promisify(fs.writeFile)(
        './test-results/my-accessibility-test.html',
        JSON.stringify(html),
        { encoding: 'utf8' });
}

Contributing

To contribute, please visit accessibility-insights-web for more information.

Contributor License Agreement

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Current Tags

  • 2.1.2                                ...           latest (5 hours ago)

11 Versions

  • 2.1.2                                ...           5 hours ago
  • 2.1.1                                ...           4 days ago
  • 2.1.0                                ...           11 days ago
  • 2.0.0                                ...           a month ago
  • 1.0.3                                ...           4 months ago
  • 1.0.2                                ...           7 months ago
  • 1.0.1                                ...           7 months ago
  • 1.0.0                                ...           8 months ago
  • 0.1.0                                ...           10 months ago
  • 0.0.2                                ...           10 months ago
  • 0.0.1                                ...           10 months ago
Downloads
Today 6
This Week 6
This Month 23
Last Day 0
Last Week 7
Last Month 12
Dependencies (9)
Dev Dependencies (0)
None

Copyright 2014 - 2017 © taobao.org |