docs: Add useRouter Documentation #325
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
|
A couple of things I noticed:
Should I change these here, or file a separate PR? |
apps/documentation/src/routes/documentation/hooks/use-router.mdx
Outdated
Show resolved
Hide resolved
apps/documentation/src/routes/documentation/hooks/use-router.mdx
Outdated
Show resolved
Hide resolved
apps/documentation/src/routes/documentation/hooks/use-router.mdx
Outdated
Show resolved
Hide resolved
apps/documentation/src/routes/documentation/hooks/use-router.mdx
Outdated
Show resolved
Hide resolved
|
Thanks for your comments, I've implemented them, and they've let me make that example much simpler! |
|
Thanks for addressing this! |
|
Regarding #325 (comment)
pathname is the standard name so it should remain the same.
You can submit a separate PR for addressing this type refine. Thanks! |
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.
Context & Description
See this discord thread. This PR adds documentation for the
useRouterhook, including an example, documentation for the returned router object, and all methods returned (so far only router.push).I like to rebase and squash PRs into one commit because I think it keeps history cleaner, so it might be a bit messy until I do that :)