next.js/examples/with-loading/README.md

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-loading)
# Example app with page loading indicator

## How to use

Download the example [or clone the repo](https://github.com/zeit/next.js):

```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/with-loading
cd with-loading
```

Install it and run:

```bash
npm install
npm run dev
```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))

```bash
now
```

## The idea behind the example

Sometimes when switching between pages, Next.js needs to download pages(chunks) from the server before rendering the page. And it may also need to wait for the data. So while doing these tasks, browser might be non responsive.

We can simply fix this issue by showing a loading indicator. That's what this examples shows.

It features:

* An app with two pages which uses a common [Header](./components/Header.js) component for navigation links.
* Using `next/router` to identify different router events
* Uses [nprogress](https://github.com/rstacruz/nprogress) as the loading indicator.
Add deploy now button to the top of all example READMEs (#1763) * Add deploy now button to the top of all example READMEs * Remove unnecessary whitespace changes 2017-04-22 12:51:51 +00:00			`[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-loading)`
Implement Router Events (#511) * Move route loading logic to a common place. * Add router events. * Add EventEmitter's core API methods. * Add example app for loading events and docs. * Fix some typos. * Get rid of Router.ready() * Remove events package. It's already shipping with webpack. * Handling aborting properly. * Expose simple attribute based events listener API. Removed the proposed event listener API from the public API. * Remove error logged when there's an abort error. There are many other ways to capture this error. So, it doesn't look nice to print this always. * Change router events to pass only the current URL as arguments. * Add a section about Cancelled Routes to README. 2016-12-31 01:15:22 +00:00			`# Example app with page loading indicator`

			`## How to use`

Fix link (#789) * Fix link * Fix links 2017-01-16 21:23:24 +00:00			`Download the example [or clone the repo](https://github.com/zeit/next.js):`
Implement Router Events (#511) * Move route loading logic to a common place. * Add router events. * Add EventEmitter's core API methods. * Add example app for loading events and docs. * Fix some typos. * Get rid of Router.ready() * Remove events package. It's already shipping with webpack. * Handling aborting properly. * Expose simple attribute based events listener API. Removed the proposed event listener API from the public API. * Remove error logged when there's an abort error. There are many other ways to capture this error. So, it doesn't look nice to print this always. * Change router events to pass only the current URL as arguments. * Add a section about Cancelled Routes to README. 2016-12-31 01:15:22 +00:00
			```bash
			`curl https://codeload.github.com/zeit/next.js/tar.gz/master \| tar -xz --strip=2 next.js-master/examples/with-loading`
			`cd with-loading`
			```

			`Install it and run:`

			```bash
			`npm install`
			`npm run dev`
			```

			`Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))`

			```bash
			`now`
			```

			`## The idea behind the example`

			`Sometimes when switching between pages, Next.js needs to download pages(chunks) from the server before rendering the page. And it may also need to wait for the data. So while doing these tasks, browser might be non responsive.`

			`We can simply fix this issue by showing a loading indicator. That's what this examples shows.`

			`It features:`

			`* An app with two pages which uses a common [Header](./components/Header.js) component for navigation links.`
			* Using `next/router` to identify different router events
			`* Uses [nprogress](https://github.com/rstacruz/nprogress) as the loading indicator.`