Enable tooltips to be used as accessible labels #211
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because we had two versions of @testing-library/dom in our dependency resolutions, @testing-library/user-event was failing to instrument fireEvent with act, causing tons of warnings and potentially broken test assertions.
Currently, the only use case that our tooltip component supports is to describe another element. But it's arguably far more common in our products to use tooltips as an accessible label for an icon. I propose we change the default behavior of <Tooltip label={...}> to be that of a persistent accessible label, and use <Tooltip description={...}> for descriptive tooltips.
I took the liberty of changing the tooltip tests to use targeted assertions rather than snapshots, because in theory this makes for a less noisy test suite that is also better at communicating what properties we actually expect tooltips to have.
Deploying compound-web with
|
| Latest commit: |
ed4b75f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3fc2e2df.compound-web.pages.dev |
| Branch Preview URL: | https://tooltip-labels.compound-web.pages.dev |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the only use case that our tooltip component supports is to describe another element. But it's arguably far more common in our products to use tooltips as an accessible label for an icon. I propose we change the default behavior of
<Tooltip label={...}>to be that of a persistent accessible label, and use<Tooltip description={...}>for descriptive tooltips.I took the liberty of changing the tooltip tests to use targeted assertions rather than snapshots, because in theory this makes for a less noisy test suite that is also better at communicating what properties we actually expect tooltips to have.
Closes element-hq/compound#322