Explain why .tooltipped should be used sparingly #676
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a note on why the tooltip pattern should be used carefully and sparingly.
Our team is planning to add a linting counter for
.tooltipped
usage to discourage it, and we would like to point people to this documentation.We now have over 700 tooltips in
github/github
. There has been many cases where tooltips negatively affect accessibility by either overriding existing content or adding extraneous information that a screen reader user would have to listen to.The counter we plan to add will not ban additional
.tooltipped
instances; it would link people to this doc and simply ask them to consider, and increment the tooltip counter if necessary, for the linter to pass./cc @primer/ds-core
/cc @dgraham