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

Explain why .tooltipped should be used sparingly #676

Merged
merged 3 commits into from
Feb 21, 2019
Merged

Conversation

muan
Copy link
Contributor

@muan muan commented Feb 13, 2019

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

@muan muan requested a review from a team February 13, 2019 19:36
modules/primer-tooltips/README.md Outdated Show resolved Hide resolved
modules/primer-tooltips/README.md Outdated Show resolved Hide resolved
modules/primer-tooltips/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@emplums emplums left a comment

Choose a reason for hiding this comment

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

Yessssss, thanks for writing this up @muan! I am personally excited about a tooltip counter/lint in .com! Tooltips are such a pain when it comes to accessibility!

Co-Authored-By: muan <muan@github.com>
@shawnbot
Copy link
Contributor

FYI @muan, the merge conflict here stems from the reorganization in #671, and should merge cleanly locally.

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.

4 participants