https://github.com/qavajs/steps-accessibility

Steps to perform accessibility checks using axe library.
https://github.com/qavajs/steps-accessibility

qa test-automation testing

Last synced: 2 months ago
JSON representation

Steps to perform accessibility checks using axe library.

• Host: GitHub
• URL: https://github.com/qavajs/steps-accessibility
• Owner: qavajs
• License: mit
• Created: 2022-12-26T06:49:02.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:45:30.000Z (3 months ago)
• Last Synced: 2024-10-29T13:28:39.309Z (3 months ago)
• Topics: qa, test-automation, testing
• Language: TypeScript
• Size: 689 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @qavajs/steps-accessibility

Steps to perform accessibility checks using axe library.

Library can work on top of playwright and webdriverio drivers

## Installation

`npm install @qavajs/steps-accessibility`

## Configuration

```javascript

module.exports = {

    default: {

        require: [

            'node_modules/@qavajs/steps-wdio/index.js', //corresponding driver library should be imported first

            'node_modules/@qavajs/steps-accessibility/index.js'

        ],

        // to customize axe instance define axe property which is a function that accepts AxeBuilder instance

        // more info: 

        // https://www.npmjs.com/package/@axe-core/webdriverio

        // https://www.npmjs.com/package/@axe-core/playwright

        axe: function (axe) {

            return axe.withTags('wcag2a')

        },

        format: [

            '@qavajs/html-formatter:report.html'

        ],

    }

}

```

## Usage

Lib provides `I perform accessibility check` step that creates axe instance, performs checks and attach html report in base 64 format

```gherkin

Feature: Accessibility

  Scenario: perform accessibility check

    When I open 'https://qavajs.github.io/' url

    And I perform accessibility check

```