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
Member

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 primer/ds-core Feb 13, 2019
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 left a comment

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

This comment has been minimized.

Copy link
Contributor

shawnbot commented Feb 19, 2019

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

@shawnbot shawnbot changed the base branch from master to release-12.0.2 Feb 21, 2019
@shawnbot shawnbot merged commit 91649d4 into release-12.0.2 Feb 21, 2019
6 checks passed
6 checks passed
deploy deploy
Details
install install
Details
lint lint
Details
publish publish
Details
publish @primer/css 0.0.0-3dd48ca
Details
test test
Details
@shawnbot shawnbot deleted the tooltip branch Feb 21, 2019
@shawnbot shawnbot mentioned this pull request Feb 21, 2019
9 of 12 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.