feat(v2): Error when hooks depends on context is used outside of Layout #2974
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
|
Deploy preview for docusaurus-2 ready! Built with commit 289875d |
slorber
requested changes
Jun 22, 2020
| setLightTheme: () => {}, | ||
| setDarkTheme: () => {}, | ||
| setLightTheme: 'UNINITIALIZED', | ||
| setDarkTheme: 'UNINITIALIZED', |
There was a problem hiding this comment.
Not very fan of using fn: 'UNINITIALIZED' this way.
It's more common in React to have a context being initialized to undefined/null by default, and have a hook to read that context doing the null-check.
Can be seen here:
https://kentcdodds.com/blog/how-to-use-react-context-effectively#typescript--flow
https://medium.com/@dai_shi/a-thought-on-react-context-default-value-fb3283cb5788
|
LGTM 👍 |
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.
Motivation
Close #2912 to give user a clear direction.
I didn't create a docs pointer for the
useUserPreferencesContexthook since it's more internal and unlike to be used by pages in top level.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Try to add
useThemeHookuseUserPreferencesContexttowebsite/src/pages/index.jsand see it crash.Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)