Giter Club home page Giter Club logo

a11y.css's Introduction

a11y.css

Pronounced Alix. Because it’s simpler.

GitHub version Build Status

Introduction

Pronounced "Alix".

This CSS file intends to warn developers about possible risks and mistakes that exist in HTML code. It can also be used to roughly evaluate a site's quality by simply including it as an external stylesheet.

When activating the stylesheet, a tip should appear beside each incriminated elements, displaying what’s going on.

This file is not a replacement to a complete tool such as aXe, Tanaguru or Tenon. It only intends to show possible weaknesses. You should obviously do some manual check by hand to know whether the code should or should not be fixed.

How to use?

WebExtension

Either you're using Firefox or Chrome, you're invited to install and use a11y.css's webextension.

It provides some nice features not included in the main CSS file (for now), such as:

  • force focus visibility;
  • show lang attributes;
  • check images' alternatives by displaying them;
  • increase text spacings.

As a WebExtension, it also enables to:

  • toggle CSS and change level on the fly,
  • remember settings for each tab,
  • automatically update in the background.

Bookmarklet

You can also use the form on the left sidebar to define the minimum level and language, in order to generate a custom bookmarklet. Then simply drag the green button to your bookmarks, and you're done! You're now able to use a11y.css on every page you visit by simply clicking on this bookmark.

Bookmarklet's caveats

The main caveat consists of CSP HTTP headers blocking unsafe / external script — mostly due to browsers bugs and inconsistencies. But many CORS policies might prevent a bookmarklet from working…

But also note that the bookmarklet might take a couple of seconds to load since it basically injects the a11y.css stylesheet within the DOM of the page you're browsing. It might be a bit slow at first because it is being downloaded from GitHub, but it's the price to pay to keep it up-to-date.

Contribution & customisation

If you want to get involved in this project, be sure to take a look at its wiki (also available in French). I'll be pleased to read your issues or pull requests!

a11y.css's People

Contributors

ffoodd avatar notabene avatar kittygiraudel avatar wolf-legend avatar a5e avatar gaetanbt avatar mona1988 avatar lausselloic avatar dependabot[bot] avatar bartveneman avatar georgegkas avatar pd4d10 avatar aidanthreadgold avatar alex-sokolov avatar dzc34 avatar nico3333fr avatar yoshuawuyts avatar llune avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.