Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update shallow routing docs #11616

Merged
merged 3 commits into from
Apr 14, 2020
Merged

Update shallow routing docs #11616

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3919d84
Updated shallow routing docs
Apr 2, 2020
e89e9a4
Include getStaticProps
Apr 3, 2020
4d0366c
Merge branch 'canary' into docs/shallow-routing
Apr 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/routing/shallow-routing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: You can use shallow routing to change the URL without triggering a
</ul>
</details>

Shallow routing allows you to change the URL without running [`getInitialProps`](/docs/api-reference/data-fetching/getInitialProps.md).
Shallow routing allows you to change the URL without running data fetching methods again, that includes [`getServerSideProps`](/docs/basic-features/data-fetching.md#getserversideprops-server-side-rendering), [`getStaticProps`](/docs/basic-features/data-fetching.md#getstaticprops-static-generation), and [`getInitialProps`](/docs/api-reference/data-fetching/getInitialProps.md).

You'll receive the updated `pathname` and the `query` via the [`router` object](/docs/api-reference/next/router.md#router-object) (added by [`useRouter`](/docs/api-reference/next/router.md#useRouter) or [`withRouter`](/docs/api-reference/next/router.md#withRouter)), without losing state.

Expand Down Expand Up @@ -68,4 +68,4 @@ Shallow routing **only** works for same page URL changes. For example, let's ass
Router.push('/?counter=10', '/about?counter=10', { shallow: true })
```

Since that's a new page, it'll unload the current page, load the new one and call `getInitialProps` even though we asked to do shallow routing.
Since that's a new page, it'll unload the current page, load the new one and wait for data fetching even though we asked to do shallow routing.