1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
next.js/examples/with-data-prefetch
James Hegedus f2e56609cd Examples: stabalise README format and create-next-app usage (#4009)
* Examples: clarify language around Yarn create & npx

* add missing READMEs and create-next-app usage

* suggest people tag jthegedus in firebase related issues

* add yarn alt instructions

* cerebraljs example readme & fixes
2018-04-03 14:19:05 +02:00
..
components Extend with-data-prefetch to handle advanced use cases (#3525) 2018-01-26 17:07:17 +01:00
pages Extend with-data-prefetch to handle advanced use cases (#3525) 2018-01-26 17:07:17 +01:00
package.json Update Next.js version on examples 2018-01-30 21:46:15 +01:00
README.md Examples: stabalise README format and create-next-app usage (#4009) 2018-04-03 14:19:05 +02:00

Deploy to now

Example app with prefetching data

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-data-prefetch with-data-prefetch-app
# or
yarn create next-app --example with-data-prefetch with-data-prefetch-app

Download manually

Download the example or clone the repo:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-data-prefetch
cd with-data-prefetch

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with now (download)

now

The idea behind the example

Next.js lets you prefetch the JS code of another page just adding the prefetch prop to next/link. This can help you avoid the download time a new page you know beforehand the user is most probably going to visit.

In the example we'll extend the Link component to also run the getInitialProps (if it's defined) of the new page and save the resulting props on cache. When the user visits the page it will load the props from cache and avoid any request.

It uses sessionStorage as cache but it could be replaced with any other more specialized system. Like IndexedDB or just an in-memory API with a better cache strategy to prune old cache and force new fetching.

This example is based on the ScaleAPI article explaining this same technique.

Note: it only works in production environment. In development Next.js just avoid doing the prefetch.