https://github.com/westbrook/testing-a11y

Exploring techniques for testing the accessibility of HTML user interfaces.
https://github.com/westbrook/testing-a11y

accessibility-testing custom-elements open-wc shadow-dom

Last synced: 3 months ago
JSON representation

Exploring techniques for testing the accessibility of HTML user interfaces.

README

# \

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

## Installation

```bash
npm i testing-a11y
```

## Usage

```html

import 'testing-a11y/testing-a11y.js';

```

## Linting and formatting

To scan the project for linting and formatting errors, run

```bash
npm run lint
```

To automatically fix linting and formatting errors, run

```bash
npm run format
```

## Testing with Web Test Runner

To execute a single test run:

```bash
npm run test
```

To run the tests in interactive watch mode run:

```bash
npm run test:watch
```

## Demoing with Storybook

To run a local instance of Storybook for your component, run

```bash
npm run storybook
```

To build a production version of Storybook, run

```bash
npm run storybook:build
```

## Tooling configs

For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

## Local Demo with `web-dev-server`

```bash
npm start
```

To run a local development server that serves the basic demo located in `demo/index.html`