a11y-string's Introduction

a11y String

This is a simple, fast module that allows you to run a range of accessibility tests against a string of HTML.

Installation

  npm install a11y-string

Example

const a11y = require('a11y-string')

a11y('<html><head><title>Test title</title></head><body><img src="foo.jpg" /></body></html>')
// Throws Error: All images must have an alt attribute

Reasoning

There are a lot of great a11y tools that exist today but all of them require an external URL or are framework specific. This project aims to be a lightweight alternative for people who need to run accessibility tests against just a string of HTML.

a11y-string's People

Contributors

Stargazers

Watchers

a11y-string's Issues

Remove isPartial in favor of more complex logic

Instead of checking isPartial which adds another parameter to all calls, we could check to see if tag exists and <title> tag does not.

Move assertions to their own file

It would be a lot more readable if all assertions lived in their own file so the AST code was alone in index.js

What is the best approach for walking this DOM?

Currently we just take the string passed in and send it to htmlparser2. Right now we're using htmlparser's event system but that's just not going to look nice. Currently the code looks like:

  var parser = new htmlparser.Parser({
    onopentag: function(name, attributes){
      if (name === 'img' && attributes.alt === undefined)
        throw new Error('All images must have an alt attribute')

      tags.push({name: name, attributes: attributes})
    }
  }, {decodeEntities: true});

but we'll want a cleaner way to execute a bunch of a11y checks. Additionally we'll need some sort of tree because for things like form labels we'll need to walk form elements backwards to see if they have a label.

I think it's probably best to use https://github.com/fb55/domhandler. Anyone else have thoughts?

Recommend Projects