Home

Awesome

stylelint-a11y

NPM version npm PRs Welcome Build Status

Installation and usage

yarn add --dev stylelint stylelint-a11y

Create the .stylelintrc.json config file (or open the existing one), add stylelint-a11y to the plugins array and the rules you need to the rules list. All rules from stylelint-a11y need to be namespaced with a11y.

Please refer to stylelint docs for the detailed info on using this linter.

Rules

Rule IDDescription
content-property-no-static-valueDisallow unaccessible CSS generated content in pseudo-elements
font-size-is-readableDisallow font sizes less than 15px
line-height-is-vertical-rhythmedDisallow not vertical rhythmed line-height
⭐️✒️media-prefers-reduced-motionRequire certain styles if the animation or transition in media features
media-prefers-color-schemeRequire implementation of certain styles for selectors with colors.
no-display-noneDisallow content hiding with display: none property
no-obsolete-attributeDisallow obsolete attribute using
no-obsolete-elementDisallow obsolete selectors using
no-spread-textRequire width of text in a comfortable range
⭐️no-outline-noneDisallow outline clearing
no-text-align-justifyDisallow content with text-align: justify
⭐️✒️selector-pseudo-class-focusRequire or disallow a pseudo-element to the selectors with :hover

Recommended config

Add recommended configuration by simply adding the following to extends in your stylelint configuration:

stylelint-a11y/recommended

This shareable config contains the following:

{
  "plugins": ["stylelint-a11y"],
  "rules": {
    "a11y/media-prefers-reduced-motion": true,
    "a11y/no-outline-none": true,
    "a11y/selector-pseudo-class-focus": true
  }
}

Since it adds stylelint-a11y to plugins, you don't have to do this yourself when extending this config.

Help out

There work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out in any of these (the plugin follows stylelint guidelines so most part of this is based on its docs):

We communicate via issues and pull requests.

There is also stackoverflow, which would be the preferred QA forum.