Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More documentation in the README #6

Open
mgifford opened this issue Mar 23, 2021 · 1 comment
Open

More documentation in the README #6

mgifford opened this issue Mar 23, 2021 · 1 comment

Comments

@mgifford
Copy link

Can you add more information about how Jasmine-axe is used to find common accessibility errors?

I'm very familiar with axe, but I understand that this has some aggregation function that comes with Jasmine.

Also, this is really only useful for Angular projects, right?

@em-vo
Copy link
Contributor

em-vo commented Jul 5, 2021

This is a custom matcher for Jasmine.
The goal is to make it super easy for developers to add automatic accessibility checks, even if they're not really familiar with accessibility, and aXe.
The matcher is just a way to encapsulate what we're testing: we're able to use the comparison we want and add a specific error message in case the check fails.
Here, we're just checking that we have 0 errors (if we use toHaveNoViolations), and if we have some, we display the results we got from axe.

I guess it should work with other frameworks if you use Jasmine for testing.
I'm used to testing with Jest for React apps, but I think we could use Jasmine too, and use this lib to check accessibility issues.

I'll add all this in the README :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants