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.

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

[example] Progressive rendered application #998

Merged
merged 8 commits into from
Feb 5, 2017
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
36 changes: 36 additions & 0 deletions examples/progressive-render/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Example app implementing progressive server-side render

## 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/progressive-render
cd progressive-render
```

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 you want to **not** server render some parts of your application. That can be third party components without server render compatibility, components that depends on `window` and other only browsers APIs or just because that content isn't enough important for the user (eg. below the fold content).
Copy link
Member

Choose a reason for hiding this comment

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

without server render capabilities

browser only

important enough

Sorry for being such a frustrating reviewer 😅 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@timneutkens hahaha don't worry, thanks for the review 👍


In that case you can wrap the component in `react-no-ssr` which will only render the component client-side.

This example features:

* An app with a component that must only be rendered in the client
* A loading component that will be displayed before rendering the client-only component

**Example**: https://progressive-render-raceuevkqw.now.sh/
15 changes: 15 additions & 0 deletions examples/progressive-render/components/Loading.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import React from 'react'

export default () => (
<div>
<h3>Loading...</h3>
<style jsx>{`
div {
align-items: center;
display: flex;
height: 50vh;
justify-content: center;
}
`}</style>
</div>
)
12 changes: 12 additions & 0 deletions examples/progressive-render/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "progressive-render",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "latest",
"react-no-ssr": "1.1.0"
Copy link
Member

Choose a reason for hiding this comment

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

maybe use "latest" here

Copy link
Member

@timneutkens timneutkens Feb 5, 2017

Choose a reason for hiding this comment

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

Actually, ^1.1.0 for react-no-ssr (looking at the other examples)

}
}
30 changes: 30 additions & 0 deletions examples/progressive-render/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import React from 'react'
import NoSSR from 'react-no-ssr'
import Loading from '../components/Loading'

export default () => (
<main>
<section>
<h1>
This section is server-side rendered.
</h1>
</section>

<NoSSR onSSR={<Loading />}>
<section>
<h2>
This section is <em>only</em> client-side rendered.
</h2>
</section>
</NoSSR>

<style jsx>{`
section {
align-items: center;
display: flex;
height: 50vh;
justify-content: center;
}
`}</style>
</main>
)