Socket
Socket
Sign inDemoInstall

wdio-axe

Package Overview
Dependencies
2
Maintainers
2
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    wdio-axe

Module to inject and analyze web pages in webdriverio using aXe


Version published
Weekly downloads
755
decreased by-6.33%
Maintainers
2
Install size
4.04 MB
Created
Weekly downloads
 

Readme

Source

wdio-axe

aXe is the accessibility engine for automated testing of HTML-based user interfaces. These hints run the recommended set of WCAG 2.1 Level A and Level AA rules from axe-core.

This module uses axe-core API to inject, configure and analyze web pages rendered by wdio by providing sync bindings.

What does the wdio-axe check?

By default, wdio-axe runs against all the WCAG 2.1 Level A and Level AA rules included in axe-core with document as the target.

These rules are grouped based on their assigned category within axe-core.

Getting started

First download the package:

npm install wdio-axe --save-dev

Implementations

Get Violations

Here is an example script returns violations with tags "wcag2a", "wcag2aa"

let aXe = require('wdio-axe');

let result = aXe.getViolations();
console.log(result);

Best-Practice

Here is an example script returns best practice which can be adopted to provide better accessibility.

let aXe = require('wdio-axe');

let result = aXe.getBestPractice();
console.log(result);

Get-Rules

Here is an example script returns the list of all rules carried out for performing accessibility.

let aXe = require('wdio-axe');

let result = aXe.getRules();
console.log(result);

Here is an example script returns the list of rules based on tags.

let aXe = require('wdio-axe');

let result = aXe.getRules(["wcag2a", "wcag2aa"]);
console.log(result);

Configure Axe

Here is an example script to modify axe configuration.

let aXe = require('wdio-axe');

aXe.runConfig({
    reporter: { reporter: "v1" }
});

Reset Configuration

Here is an example script to reset all axe configuration to default.

let aXe = require('wdio-axe');

aXe.reset();

Analyze With Tag

Here is an example script to run axe with custom tag.

let aXe = require('wdio-axe');

let result = aXe.analyseWithTag(["best-practice"]);
console.log(result);

Analyze With Context

Here is an example script to run axe with context enabled.

let aXe = require('wdio-axe');

let result = aXe.analyseWithContext([{include: [['#iframe']]}]);
console.log(result);

Further Reading

Keywords

FAQs

Last updated on 23 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc