estimtest-cli
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

Estimtest, experiment your website accessibility


Estimtest

Estimtest is an experimentation tool that simulates accessibility concerns. Accessibility is crucial, but unexpectedly, difficult to test.

Usage

Feel free to checkout the examples, or open an issue for support.

  • Apply the component as a sibling or child of a container. For example, as a child of <body></body>.
  • The estimtest-core element should cover up the entire screen in absolute position.

CLI (Preferred)

Install Estimtest locally

npm install --save-dev estimtest-cli

Activate the server using the server provided by estimtest-cli

estimtest-cli start

Configuration

Use a file named estimtest.config.js to modify props.

/** @type {import('estimtest-utils/config').EstimtestConfig} */
const config = {
  experiments: [
    {
      name: 'Hello World',
      description: 'Hello World This is a full description',
      fontSize: 24,
    }
  ],
  webPort: 5173,
}

export default config;

active boolean - Whether to activate the Estimtest prompt. Having this as false still imports the library but does not use it. Look at the examples for sloppy implementations of fully removing Estimtest in production.

experiments { name: string, description: string, fontSize?: number, colorBlind?: ColorBlind, keyboardOnly?: boolean }[] - The experiments to be performed on the app. This is set by default to perform multiple standard tests of common accessibility problems. This field accepts an array of objects each with the properties:

  • name A quick ~15 letters title summarizing the test.
  • description A description explaining the test and why it's important. Supports Markdown (Commonmark-compliant).
  • fontSize The font size to set the page. Many users have difficulty reading text at the default font size, users fix this by increasing the default font size.
  • colorBlind A change of colors on the page reflecting what colorblind users may see.
  • keyboardOnly Many users may use keyboard navigation for a variety of reasons such as: Motor impairment, saving time, and more.

moveSelector string - An element selector containing the parent of where the element should be at. You could use this property in the event that your code does not permit you to place the element there.

webPort string - The port of the website you want to test with Estimtest. Estimtest will proxy this url, and add modify the HTML to support Estimtest.

estimtestPort string - The port of that Estimtest will use to start the server.

Contributing

If you have suggestions, feedback, issues, or bugs, please open an issue.

If are willing to contribute to Estimtest, please open a pull request.

Package Sidebar

Install

npm i estimtest-cli

Weekly Downloads

1

Version

1.1.1

License

MIT

Unpacked Size

184 kB

Total Files

22

Last publish

Collaborators

  • kylesmith0905