docs: add better docs and console errors for data router features #9311
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
🦋 Changeset detectedLatest commit: 3a07532 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Note to self- let's make the error message a bit clearer with a |
brophdawg11
force-pushed
the
brophdawg11/scroll-restoration-docs
branch
from
e6a5b31
to
7f68b82
Compare
brophdawg11
changed the title
brophdawg11
commented
Sep 22, 2022
| enum DataRouterStateHook { | ||
| UseFetchers = "useFetchers", | ||
| UseScrollRestoration = "useScrollRestoration", | ||
| } |
There was a problem hiding this comment.
Enums to represent the hooks that require a data router
brophdawg11
commented
Sep 22, 2022
Comment on lines
+662
to
+672
| function useDataRouterContext(hookName: DataRouterHook) { | ||
| let ctx = React.useContext(DataRouterContext); | ||
| invariant(ctx, getDataRouterConsoleError(hookName)); | ||
| return ctx; | ||
| } | ||
|
|
||
| function useDataRouterState(hookName: DataRouterStateHook) { | ||
| let state = React.useContext(DataRouterStateContext); | ||
| invariant(state, getDataRouterConsoleError(hookName)); | ||
| return state; | ||
| } |
There was a problem hiding this comment.
All hooks should use the internal hooks to get access to the contexts, so that we get consistent error messaging across the board
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.
A few folks have messaged in discord trying to use
ScrollRestorationand other data-router-only hooks insideBrowserRouterso I went though the new hooks and added the<docs-warning>to them with a link to "Picking a Router".I left out a few hooks like
useLoaderData,useActionDatasince they seemed self-explanatory?I also updated the implementation to leverage internal private
useDataRouterContextanduseDataRouterStatehooks that will print a better error message if called inBrowserRouter:For example: