NavigatorScreen: satisfy exhaustive-deps eslint rule#45648
Merged
ciampo merged 2 commits intoWordPress:trunkfrom Nov 9, 2022
Merged
Conversation
|
|
44 tasks
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
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?
Ensure
NavigatorScreensatisfy theexhaustive-depseslint ruleWhy?
Part of the effort in #41166 to apply the
exhaustive-depseslint rule to the components packageHow?
In the
useEffectcall we're manipulating thelocationobject (stored in context) by settinghasRestoredFocusto a boolean value. Due to that assignment the exlint rule expects the wholelocationobject to be a dependency of theuseEffectcall which isn't what we want. Therefore we use a workaround by storing thelocationobject in reflocationRefand access/write to it that way.Testing Instructions
npx eslint --rule 'react-hooks/exhaustive-deps: warn' packages/components/src/navigatior/navigator-screennavigatorunit tests still passNavigatorcomponent stories and/or docs still work as expectedScreenshots or screencast