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

[docs] update a11y docs with new warning and tweak wording #6487

Merged
merged 1 commit into from
Jul 2, 2021

Conversation

geoffrich
Copy link
Member

This PR adds a missing warning to the a11y docs and tweaks some of the wording. It also adds a disclaimer that Svelte won't catch all issues and further action by the developer is needed.

  • Add disclaimer that Svelte won't catch all a11y issues
  • Correct aria-hidden syntax
  • Screenreader -> screen reader for consistency
  • Add more details around some of the checks
  • Add docs on a11y-mouse-events-have-key-events (check if mouse events are accompanied by key events #5938)
  • Other wording tweaks

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with [feat], [fix], [chore], or [docs].
  • This message body should clearly illustrate what problems it solves.
  • [ ] Ideally, include a test that fails without this PR but passes with it.

Tests

  • [ ] Run the tests with npm test and lint the project with npm run lint

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Thanks!

@dummdidumm dummdidumm merged commit a35506b into sveltejs:master Jul 2, 2021
@geoffrich geoffrich deleted the a11-docs branch July 2, 2021 17:01
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.

2 participants