heatedtowel / A11yBookmarklets

A collection of useful Bookmarklets for checking common a11y issues.
2 stars 0 forks source link

Contributors Forks Stargazers Issues MIT License LinkedIn

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This is a collection of bookmarklets for quickly identifing accessibility issues. I am constantly going through markup that I have never seen before and having to decipher what is being generated and what elements the attributes I am looking for are associated with (if there are any). So I thought why not start creating bookmarklets to check for the thigs I do on a daily basis.

I indent this to be open source and would like feedback and inputs on what you would like to see. Or if you have built one that you think would be useful here feel free to create a pull request. I would like this to become a robust set of tools that you can use both when debugging and creating components to ensure we make them accessible for all users.

Active development is currently on the image query bookmarklet. While the other bookmarklets are completed and working. They are not as fleshed out at the moment as the image search.

(back to top)

Built With

(back to top)

Getting Started

Follow the quick and easy steps to get your bookmarklets going.

Prerequisites

Installation

  1. Choose the JS file you would like to use
  2. Copy all of the contents of the JS file
  3. Right click on your browser bookmarkbar
  4. Click 'add page'
  5. Choose an appropriate name for the bookmarklet
  6. Paste the copied code into the URL (Note: javascript: has to prefact all of the code or the bookmark will not save)
  7. Save the bookmark
  8. Click on the bookmark in your toolbar to run it.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

Contact

Jesse Monks - heateddiv@gmail.com

Project Link: https://github.com/heatedtowel/A11yBookmarklets

(back to top)