Skip to content

[Docs] Suggest an alternative to @axe-core/react#1059

Open
pomerantsev wants to merge 2 commits intojsx-eslint:mainfrom
pomerantsev:accented
Open

[Docs] Suggest an alternative to @axe-core/react#1059
pomerantsev wants to merge 2 commits intojsx-eslint:mainfrom
pomerantsev:accented

Conversation

@pomerantsev
Copy link
Copy Markdown

Resolves #1058

Comment thread README.md
## Why?

This plugin does a static evaluation of the JSX to spot accessibility issues in React apps. Because it only catches errors in static code, use it in combination with [@axe-core/react](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/react) to test the accessibility of the rendered DOM. Consider these tools just as one step of a larger a11y testing process and always test your apps with assistive technology.
This plugin does a static evaluation of the JSX to spot accessibility issues in React apps. Because it only catches errors in static code, use it in combination with a tool that tests the accessibility of the rendered DOM, such as [Accented](https://accented.dev) or [@axe-core/react](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/react) (both based on the [axe-core](https://github.com/dequelabs/axe-core) engine). Consider these tools just as one step of a larger a11y testing process and always test your apps with assistive technology.
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ljharb while this is not merged, should we mention that this plugin is no longer just for React, but for any JSX code?

For example:

Suggested change
This plugin does a static evaluation of the JSX to spot accessibility issues in React apps. Because it only catches errors in static code, use it in combination with a tool that tests the accessibility of the rendered DOM, such as [Accented](https://accented.dev) or [@axe-core/react](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/react) (both based on the [axe-core](https://github.com/dequelabs/axe-core) engine). Consider these tools just as one step of a larger a11y testing process and always test your apps with assistive technology.
This plugin does a static evaluation of the JSX to spot accessibility issues in apps built on frameworks such as [React](https://react.dev/), [Preact](https://preactjs.com/), or [SolidJS](https://www.solidjs.com/).
Because it only catches errors in static code, use it in combination with a tool that tests the accessibility of the rendered DOM, such as [Accented](https://accented.dev) or [@axe-core/react](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/react) (both based on the [axe-core](https://github.com/dequelabs/axe-core) engine).
Consider these tools just as one step of a larger a11y testing process and always test your apps with assistive technology.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's still primarily for react, who invented and own JSX.

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

Successfully merging this pull request may close these issues.

Replace mention of @axe-core/react with a modern alternative

2 participants