Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 3.1 KB

README.md

File metadata and controls

97 lines (60 loc) · 3.1 KB
Raw

What is Accessible Reset?

Accessible Reset is a css reset library with a hint of js that makes your webapps more accessible with only 1 line of code. The goal of accessible-reset is NOT to be a replacement of other libraries like normailze.css, but to add accessible features to them instead. The bundle file that includes both the css and js is under 6kb in size and if you choose to include the css and js separately, the total size comes in under 2kb.


What does it do?

There are very few things you need to think about when using Accessible Reset, but here are a few things Accessible Reset does that is worth knowing about:

  • Preventing the page-width from jumping when moving from a non-scrollable page to a scrollable one. This issue mostly affects windows users.
  • Enhances the behaviour when tabbing through a site. Automatically applies outline to focused elements when tabbing without disturbing the usual behaviour when clicking around on the webpage.
  • Sets the value 1rem = 10px without disturbing the accessability features of the user agent stylesheet. This enables developers to calculate relative font-sizes much easier. (1.8rem = 18px etc...)

For more information, look at the fully commented style.css file in the src foler of this repository.


Installation


Accessible Reset can be used on static and dynamic pages. You can either import the css and js separately, or just include the js bundle that also includes the styles.


❗ Note: Accessible Reset works with normalize.css, but include normalize.css first for the best results.


With npm:

Install the package:

npm install accessible-reset --save

Import the package:

import 'accessible-reset';

If you want to minimize the file footprint (2kb instead of 6kb), you can include the js and css separately:

import 'accessible-reset/accessible-reset.css';
import 'accessible-reset/accessible-reset.js';

❗ Note: Your build process needs to accept css files for you to be able to import css files directly.


Include locally:

Download accessible-reset.bundle.js from the root of this repository.

Link to the file locally in the head of your index.html file:

<head>
    ...

    <script src="./path/to/accessible-reset.bundle.js"></script>
    
    ...
</head>

❗ Note: You can optionally download and include the stylesheet accessible-reset.css in the head of your index.html and include the accessible-reset.js file to the bottom of the <body> tag if you have problems with flashes of unstyled content or want a smaller file footprint (2kb instead of 6kb). By default, the stylesheet is included in the script tag.

<head>
    ...
    
    <link rel="stylesheet" href="./path/to/accessible-reset.css">
    
    ...
</head>
<body>
    ...

    <script src="./path/to/accessible-reset.js"></script>
</body>