https://github.com/edenspiekermann/a11y-toggle
A tiny script for accessible content toggles.
https://github.com/edenspiekermann/a11y-toggle
a11y accessibility toggle
Last synced: 4 months ago
JSON representation
A tiny script for accessible content toggles.
- Host: GitHub
- URL: https://github.com/edenspiekermann/a11y-toggle
- Owner: edenspiekermann
- License: mit
- Created: 2016-03-07T09:47:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-09-09T06:41:19.000Z (almost 4 years ago)
- Last Synced: 2024-10-20T09:45:33.038Z (8 months ago)
- Topics: a11y, accessibility, toggle
- Language: HTML
- Homepage: https://edenspiekermann.github.io/a11y-toggle/
- Size: 207 KB
- Stars: 304
- Watchers: 14
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A11y Toggle
A tiny script (less than 0.6Kb gzipped) to build accessible content toggles. You can try the [live demo which also acts as a documentation](http://edenspiekermann.github.io/a11y-toggle/).
a11y-toggle uses relatively modern JavaScript API (namely `reduce`, `addEventListener`, etc.) therefore will not work in Internet Explorer 8 and below. All the other browsers, including mobile ones should work fine.
## Install
```sh
npm install --save a11y-toggle
```
```sh
bower install a11y-toggle
```
## Tests
[Mocha](https://mochajs.org/) and [expect.js](https://github.com/Automattic/expect.js) are used to run browser tests.
```
npm test
```
## Deploy example
The [example page](http://edenspiekermann.github.io/a11y-toggle/) is deployed through [GitHub Pages](https://pages.github.com/).
```
npm run deploy
```