Components: refactor Snackbar to pass exhaustive-deps
#44934
Merged
Conversation
This file contains hidden or 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
chad1008
added
[Type] Code Quality
44 tasks
|
Size Change: +1 B (0%) Total Size: 1.28 MB
ℹ️ View Unchanged
|
chad1008
force-pushed
the
refactor/Snackbar-exhaustive-deps
branch
from
7b2ce8e to
507dddb
Compare
Contributor
Author
|
Thanks @mirka! |
chad1008
force-pushed
the
refactor/Snackbar-exhaustive-deps
branch
from
629251a to
d7fecdd
Compare
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.
What?
Updates the
Snackbarcomponent to satisfy theexhaustive-depseslint ruleWhy?
Part of the effort in #41166 to apply
exhuastive-depsto the Components packageHow?
Adds a single missing dependency (
explicitDismiss) to the relevant dependency array.Testing Instructions
npx eslint --rule 'react-hooks/exhaustive-deps: warn' packages/components/src/snackbarSnackbardoesn't have any real interaction in Storybook. The stories all lack anonRemoveprop to handle the dismissal, presumably to keep the notices visible. They wouldn't be very good examples if they disappeared and left a blank screen 😉. We may want to consider including two matching (and clearly labeled) notifications in each story, keeping one visible (current behavior) and using the second to demonstrate what dismissing the notice does/looks like... but that would be for another PR.Another relevant detail (also for another PR to address) is that the two "with
explicitDismiss" stories are currently bugged in Storybook. This is because the stories aren't rendered by aSnackbarListcomponent, so they don't have alistRefprop. The dismissal methoddismissMetries to use that prop to shift focus when the notice is dismissed, but currently the ref isundefinedin Storybook, so we get a type error.So... to actually test the interaction of the
explicitDismiss, a few temporary changes are needed to make the actions of theSnackbarvisible. Sorry, this is a bit of a pain.snackbar/index.js
NOTICE_TIMEOUTvalue to1000. Ten seconds is an eternity to test with.snackbar/stories.js
onRemovefunction to theonRemoveprop for each of the five stories in the file.Now, to test the interactions:
Snackbarautomatically still works as expected.explicitDismissstories, confirm that the log does not automatically appear, confirming that theseSnackbars will persist until dismissed.explicitDismissstories, confirming our log message appears when clicked, which simulates a successful manual dismissal.