Update router.prefetch documentation to include locale option#39442
Merged
ijjk merged 2 commits intovercel:canaryfrom Aug 10, 2022
Merged
Update router.prefetch documentation to include locale option#39442ijjk merged 2 commits intovercel:canaryfrom
router.prefetch documentation to include locale option#39442ijjk merged 2 commits intovercel:canaryfrom
Conversation
Include documentation for setting the locale as an option within `router.prefetch`.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Includes some basic documentation for setting the locale as an option within
router.prefetch. I was quite confused when I was looking to use this feature recently and couldn't see it in the docs.Wording is adapted from:
next.js/docs/api-reference/next/link.md
Line 64 in a6bc387
There is also an undocumented
priorityboolean option described in the typescript types however having just tested it, it doesn't seem to have any effect so perhaps it's not ready for documentation and I have left it out.Feature