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

Add docs for Router.back and Router.reload #12396

Merged
merged 1 commit into from
May 2, 2020
Merged

Add docs for Router.back and Router.reload #12396

merged 1 commit into from
May 2, 2020

Conversation

lfades
Copy link
Member

@lfades lfades commented May 1, 2020

No description provided.

@lfades lfades requested a review from Timer as a code owner May 1, 2020 20:04
@lfades lfades requested a review from chibicode May 1, 2020 20:04
@ijjk
Copy link
Member

ijjk commented May 1, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
zeit/next.js canary lfades/next.js docs/router-back-reload Change
buildDuration 10.6s 10.5s -127ms
nodeModulesSize 56.3 MB 56.3 MB ✓
Page Load Tests Overall increase ✓
zeit/next.js canary lfades/next.js docs/router-back-reload Change
/ failed reqs 0 0 ✓
/ total time (seconds) 1.827 1.771 -0.06
/ avg req/sec 1368.47 1411.39 ⚠️ +42.92
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 0.896 0.885 -0.01
/error-in-render avg req/sec 2791.48 2824.13 ⚠️ +32.65
Client Bundles (main, webpack, commons)
zeit/next.js canary lfades/next.js docs/router-back-reload Change
main-HASH.js gzip 6.28 kB 6.28 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..5232.js gzip 10.3 kB 10.3 kB ✓
framework.a1..NSE.txt gzip 220 B 220 B ✓
framework.a1..NSE.txt gzip 220 B 220 B ✓
framework.HASH.js gzip 39.2 kB 39.2 kB ✓
Overall change 57 kB 57 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary lfades/next.js docs/router-back-reload Change
main-HASH.module.js gzip 4.82 kB 4.82 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.88 kB 6.88 kB ✓
framework.HA..dule.js gzip 39.2 kB 39.2 kB ✓
Overall change 51.7 kB 51.7 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary lfades/next.js docs/router-back-reload Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_app.js gzip 1.23 kB 1.23 kB ✓
_error.js gzip 3.13 kB 3.13 kB ✓
hooks.js gzip 663 B 663 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 280 B 280 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.86 kB 7.86 kB ✓
Client Pages Modern
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_app.module.js gzip 598 B 598 B ✓
_error.module.js gzip 2.09 kB 2.09 kB ✓
hooks.module.js gzip 383 B 383 B ✓
index.module.js gzip 223 B 223 B ✓
link.module.js gzip 1.52 kB 1.52 kB ✓
routerDirect..dule.js gzip 279 B 279 B ✓
withRouter.m..dule.js gzip 278 B 278 B ✓
Overall change 5.37 kB 5.37 kB ✓
Client Build Manifests
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Rendered Page Sizes
zeit/next.js canary lfades/next.js docs/router-back-reload Change
index.html gzip 926 B 926 B ✓
link.html gzip 936 B 936 B ✓
withRouter.html gzip 924 B 924 B ✓
Overall change 2.79 kB 2.79 kB ✓
Serverless Mode
General
zeit/next.js canary lfades/next.js docs/router-back-reload Change
buildDuration 11.2s 11.6s ⚠️ +360ms
nodeModulesSize 56.3 MB 56.3 MB ✓
Client Bundles (main, webpack, commons)
zeit/next.js canary lfades/next.js docs/router-back-reload Change
main-HASH.js gzip 6.28 kB 6.28 kB ✓
webpack-HASH.js gzip 746 B 746 B ✓
de003c3a9d30..5232.js gzip 10.3 kB 10.3 kB ✓
framework.a1..NSE.txt gzip 220 B 220 B ✓
framework.a1..NSE.txt gzip 220 B 220 B ✓
framework.HASH.js gzip 39.2 kB 39.2 kB ✓
Overall change 57 kB 57 kB ✓
Client Bundles (main, webpack, commons) Modern
zeit/next.js canary lfades/next.js docs/router-back-reload Change
main-HASH.module.js gzip 4.82 kB 4.82 kB ✓
webpack-HASH..dule.js gzip 746 B 746 B ✓
de003c3a9d30..dule.js gzip 6.88 kB 6.88 kB ✓
framework.HA..dule.js gzip 39.2 kB 39.2 kB ✓
Overall change 51.7 kB 51.7 kB ✓
Legacy Client Bundles (polyfills)
zeit/next.js canary lfades/next.js docs/router-back-reload Change
polyfills-HASH.js gzip 26.3 kB 26.3 kB ✓
Overall change 26.3 kB 26.3 kB ✓
Client Pages
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_app.js gzip 1.23 kB 1.23 kB ✓
_error.js gzip 3.13 kB 3.13 kB ✓
hooks.js gzip 663 B 663 B ✓
index.js gzip 222 B 222 B ✓
link.js gzip 2.06 kB 2.06 kB ✓
routerDirect.js gzip 280 B 280 B ✓
withRouter.js gzip 278 B 278 B ✓
Overall change 7.86 kB 7.86 kB ✓
Client Pages Modern
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_app.module.js gzip 598 B 598 B ✓
_error.module.js gzip 2.09 kB 2.09 kB ✓
hooks.module.js gzip 383 B 383 B ✓
index.module.js gzip 223 B 223 B ✓
link.module.js gzip 1.52 kB 1.52 kB ✓
routerDirect..dule.js gzip 279 B 279 B ✓
withRouter.m..dule.js gzip 278 B 278 B ✓
Overall change 5.37 kB 5.37 kB ✓
Client Build Manifests
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_buildManifest.js gzip 61 B 61 B ✓
_buildManife..dule.js gzip 61 B 61 B ✓
Overall change 122 B 122 B ✓
Serverless bundles
zeit/next.js canary lfades/next.js docs/router-back-reload Change
_error.js 853 kB 853 kB ✓
404.html 4.18 kB 4.18 kB ✓
hooks.html 3.81 kB 3.81 kB ✓
index.js 853 kB 853 kB ✓
link.js 891 kB 891 kB ✓
routerDirect.js 883 kB 883 kB ✓
withRouter.js 883 kB 883 kB ✓
Overall change 4.37 MB 4.37 MB ✓

chibicode
chibicode reviewed May 1, 2020
View reviewed changes
docs/api-reference/next/router.md
@@ -184,6 +184,26 @@ Router.beforePopState(({ url, as, options }) => {

If the function you pass into `beforePopState` returns `false`, `Router` will not handle `popstate` and you'll be responsible for handling it, in that case. See [Disabling file-system routing](/docs/advanced-features/custom-server.md#disabling-file-system-routing).

### Router.back

Navigate back in history, equivalent to clicking the back button. It executes `window.history.back()`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Navigate back in history, equivalent to clicking the back button. It executes `window.history.back()`.
Navigate back in history. Equivalent to clicking the browser’s back button. It executes `window.history.back()`.

chibicode
chibicode reviewed May 1, 2020
View reviewed changes
docs/api-reference/next/router.md

### Router.reload

Reload the current URL, equivalent to clicking the refresh button. It executes `window.location.reload()`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Reload the current URL, equivalent to clicking the refresh button. It executes `window.location.reload()`.
Reload the current URL. Equivalent to clicking the browser’s refresh button. It executes `window.location.reload()`.

@Timer Timer added this to the 9.3.7 milestone May 2, 2020
Timer
Timer approved these changes May 2, 2020
View reviewed changes
Copy link
Member

@Timer Timer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Landing without edits because PR edits were not enabled.

@Timer Timer merged commit 960c18d into vercel:canary May 2, 2020
@chibicode chibicode mentioned this pull request May 2, 2020
Merged
@Timer Timer modified the milestones: 9.3.7, 9.4 May 11, 2020
rokinsky pushed a commit to rokinsky/next.js that referenced this pull request Jul 11, 2020
@rokinsky
Add docs for Router.back and Router.reload (vercel#12396)
4bec502
@vercel vercel locked as resolved and limited conversation to collaborators Jan 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@chibicode chibicode chibicode left review comments

@Timer Timer Timer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
9.4
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@lfades @ijjk @Timer @chibicode