@wally-ax/wax-dev-react

WAX Dev Testing Framework

Description

A lightweight and extensive automated accessibility testing framework

As a part of the WallyAX ecosystem accessibility tools, this package helps run accessibility tests on React App.

Installation

Install the package using npm:

npm install @wally-ax/wax-dev-react

Or using yarn:

yarn add @wally-ax/wax-dev-react

Dependencies

Install the React Dom package using npm:

npm install react-dom

Or using yarn:

yarn add react-dom

Usage

Configuration

In your React Application, in the main entry file (typically App.js):

import the ReactDOM and runWax Module

import ReactDOM from 'react-dom';
import runWax from '@wally-ax/wax-dev-react';

const waxConfig = {
    rules: [],
    apiKey: "YOUR_WALLY_DEVELOPER_API_KEY",
  };
runWax(React, ReactDOM, waxConfig);

Here’s how the setup of your application should be structured, as shown below.

App.js

import React from "react";
import ReactDOM from 'react-dom';
import runWax from '@wally-ax/wax-dev-react';
import './App.css';
import Form from './Form';

function App() {
  const waxConfig = {
    rules: [],
    apiKey: "API KEY",
  };
  runWax(React, ReactDOM, waxConfig);
  return (
    <div className="App">
      <p>
        Wally Dev React
      </p>
      <Form />

    </div>
  );
}
export default App;

rules: An array of strings representing rule definitions. Available rules can be found here. An empty array will include all rules.

apiKey: A string required for the wax-dev-react to work. You can get the api key from WallyAX Developer Portal

Results

The results will be displayed in your browser's Developer console.

If there is no accessibility issues, it will say No issues found

License

Mozilla Public License Version 2.0 (see license.txt)

WAX Dev React is licensed as Mozilla Public License Version 2.0 and the copyright is owned by Wally Solutions Pvt Ltd and Contributors.

By contributing to WAX Dev React, you agree that your contributions will be licensed under its Mozilla Public License Version 2.0.