node package manager

@bcoe/next

screen shot 2016-10-25 at 2 37 27 pm

Build Status Coverage Status Slack Channel

Next.js is a minimalistic framework for server-rendered React applications.

**NOTE! the README on the master branch might not match that of the latest stable release! **

How to use

Install it:

$ npm install next --save

and add a script to your package.json like this:

{
  "scripts": {
    "dev": "next"
  }
}

After that, the file-system is the main API. Every .js file becomes a route that gets automatically processed and rendered.

Populate ./pages/index.js inside your project:

export default () => (
  <div>Welcome to next.js!</div>
)

and then just run npm run dev and go to http://localhost:3000

So far, we get:

  • Automatic transpilation and bundling (with webpack and babel)
  • Hot code reloading
  • Server rendering and indexing of ./pages
  • Static file serving. ./static/ is mapped to /static/

To see how simple this is, check out the sample app - nextgram

Automatic code splitting

Every import you declare gets bundled and served with each page. That means pages never load unnecessary code!

import cowsay from 'cowsay-browser'
export default () => (
  <pre>{ cowsay.say({ text: 'hi there!' }) }</pre>
)

CSS

Built-in CSS support

We bundle styled-jsx to provide support for isolated scoped CSS. The aim is to support "shadow CSS" resembling of Web Components, which unfortunately do not support server-rendering and are JS-only.

export default () => (
  <div>
    Hello world
    <p>scoped!</p>
    <style jsx>{`
      p {
        color: blue;
      }
      div {
        background: red;
      }
      @media (max-width: 600px) {
        div {
          background: blue;
        }
      }
    `}</style>
  </div>
)

CSS-in-JS

It's possible to use any existing CSS-in-JS solution. The simplest one is inline styles:

export default () => (
  <p style={{ color: red }}>hi there</p>
)

To use more sophisticated CSS-in-JS solutions, you typically have to implement style flushing for server-side rendering. We enable this by allowing you to define your own custom <Document> component that wraps each page

The following wiki pages provide examples for some popular styling solutions:

  • glamor (formerly next/css)
  • styled-components
  • styletron
  • fela

Static file serving (e.g.: images)

Create a folder called static in your project root directory. From your code you can then reference those files with /static/ URLs:

export default () => (
  <img src="/static/my-image.png" />
)

Populating <head>

We expose a built-in component for appending elements to the <head> of the page.

import Head from 'next/head'
export default () => (
  <div>
    <Head>
      <title>My page title</title>
      <meta name="viewport" content="initial-scale=1.0, width=device-width" />
    </Head>
    <p>Hello world!</p>
  </div>
)

Note: The contents of <head> get cleared upon unmounting the component, so make sure each page completely defines what it needs in <head>, without making assumptions about what other pages added

Fetching data and component lifecycle

When you need state, lifecycle hooks or initial data population you can export a React.Component (instead of a stateless function, like shown above):

import React from 'react'
export default class extends React.Component {
  static async getInitialProps ({ req }) {
    return req
      ? { userAgent: req.headers['user-agent'] }
      : { userAgent: navigator.userAgent }
  }
  render () {
    return <div>
      Hello World {this.props.userAgent}
    </div>
  }
}

Notice that to load data when the page loads, we use getInitialProps which is an async static method. It can asynchronously fetch anything that resolves to a JavaScript plain Object, which populates props.

For the initial page load, getInitialProps will execute on the server only. getInitialProps will only be executed on the client when navigating to a different route via the Link component or using the routing APIs.

getInitialProps receives a context object with the following properties:

  • pathname - path section of URL
  • query - query string section of URL parsed as an object
  • req - HTTP request object (server only)
  • res - HTTP response object (server only)
  • xhr - XMLHttpRequest object (client only)
  • err - Error object if any error is encountered during the rendering

Routing

With <Link>

Client-side transitions between routes can be enabled via a <Link> component. Consider these two pages:

// pages/index.js
import Link from 'next/link'
export default () => (
  <div>Click <Link href="/about"><a>here</a></Link> to read more</div>
)
// pages/about.js
export default () => (
  <p>Welcome to About!</p>
)

Client-side routing behaves exactly like the browser:

  1. The component is fetched
  2. If it defines getInitialProps, data is fetched. If an error occurs, _error.js is rendered
  3. After 1 and 2 complete, pushState is performed and the new component rendered

Each top-level component receives a url property with the following API:

  • pathname - String of the current path excluding the query string
  • query - Object with the parsed query string. Defaults to {}
  • push(url, as=url) - performs a pushState call with the given url
  • replace(url, as=url) - performs a replaceState call with the given url

The second as parameter for push and replace is an optional decoration of the URL. Useful if you configured custom routes on the server.

Imperatively

You can also do client-side page transitions using the next/router

import Router from 'next/router'
 
export default () => (
  <div>Click <span onClick={() => Router.push('/about')}>here</span> to read more</div>
)

Above Router object comes with the following API:

  • route - String of the current route
  • pathname - String of the current path excluding the query string
  • query - Object with the parsed query string. Defaults to {}
  • push(url, as=url) - performs a pushState call with the given url
  • replace(url, as=url) - performs a replaceState call with the given url

The second as parameter for push and replace is an optional decoration of the URL. Useful if you configured custom routes on the server.

Note: in order to programmatically change the route without triggering navigation and component-fetching, use props.url.push and props.url.replace withing a component

Prefetching Pages

Next.js exposes a module that configures a ServiceWorker automatically to prefetch pages: next/prefetch.

Since Next.js server-renders your pages, this allows all the future interaction paths of your app to be instant. Effectively Next.js gives you the great initial download performance of a website, with the ahead-of-time download capabilities of an app. Read more.

With <Link>

You can substitute your usage of <Link> with the default export of next/prefetch. For example:

import Link from 'next/prefetch'
// example header component
export default () => (
  <nav>
    <ul>
      <li><Link href='/'><a>Home</a></Link></li>
      <li><Link href='/about'><a>About</a></Link></li>
      <li><Link href='/contact'><a>Contact</a></Link></li>
    </ul>
  </nav>
)

When this higher-level <Link> component is first used, the ServiceWorker gets installed. To turn off prefetching on a per-<Link> basis, you can use the prefetch attribute:

<Link href='/contact' prefetch={false}>Home</Link>

Imperatively

Most needs are addressed by <Link />, but we also expose an imperative API for advanced usage:

import { prefetch } from 'next/prefetch'
export default ({ url }) => (
  <a onClick={ () => setTimeout(() => url.pushTo('/dynamic'), 100) }>
    A route transition will happen after 100ms
  </a>
  {
    // but we can prefetch it!
    prefetch('/dynamic')
  }
)

Custom <Document>

Pages in Next.js skip the definition of the surrounding document's markup. For example, you never include <html>, <body>, etc. But we still make it possible to override that:

import Document, { Head, Main, NextScript } from `next/document`
 
export default class MyDocument extends Document {
  static async getInitialProps (ctx) {
    const props = await Document.getInitialProps(ctx)
    return { ...props, customValue: 'hi there!' }
  }
 
  render () {
    return (
     <html>
       <Head>
         <style>{`body { margin: 0 } /* custom! */`}</style>
       </Head>
       <body className="custom_class">
         {this.props.customValue}
         <Main />
         <NextScript />
       </body>
     </html>
    )
  }
}

The ctx object is equivalent to the one received in all getInitialProps hooks, with one addition:

  • renderPage (Function) a callback that executes the actual React rendering logic (synchronously). It's useful to decorate this function in order to support server-rendering wrappers like Aphrodite's renderStatic

Custom error handling

404 or 500 errors are handled both client and server side by a default component error.js. If you wish to override it, define a _error.js:

import React from 'react'
export default class Error extends React.Component {
  static getInitialProps ({ res, xhr }) {
    const statusCode = res ? res.statusCode : (xhr ? xhr.status : null)
    return { statusCode }
  }
 
  render () {
    return (
      <p>{
        this.props.statusCode
        ? `An error ${this.props.statusCode} occurred on server`
        : 'An error occurred on client'
      }</p>
    )
  }
}

Custom configuration

For custom advanced behavior of Next.js, you can create a next.config.js in the root of your project directory (next to pages/ and package.json).

Note: next.config.js is a regular Node.js module, not a JSON file. It gets used by the Next server and build phases, and not included in the browser build.

// next.config.js 
module.exports = {
  /* config options here */
}

Customizing webpack config

In order to extend our usage of webpack, you can define a function that extends its config via next.config.js.

The following example shows how you can use react-svg-loader to easily import any .svg file as a React component, without modification.

module.exports = {
  webpack: (cfg, { dev }) => {
    cfg.module.rules.push({ test: /\.svg$/, loader: 'babel!react-svg' })
    return cfg
  }
}

Production deployment

To deploy, instead of running next, you probably want to build ahead of time. Therefore, building and starting are separate commands:

next build
next start

For example, to deploy with now a package.json like follows is recommended:

{
  "name": "my-app",
  "dependencies": {
    "next": "latest"
  },
  "scripts": {
    "dev": "next",
    "build": "next build",
    "start": "next start"
  }
}

Then run now and enjoy!

Note: we recommend putting .next in .npmignore or .gitignore. Otherwise, use files or now.files to opt-into a whitelist of files you want to deploy (and obviously exclude .next)

FAQ

Is this production ready? Next.js has been powering `https://zeit.co` since its inception.

We’re ecstatic about both the developer experience and end-user performance, so we decided to share it with the community.

How big is it?

The client side next bundle, which includes React and Glamor is 73kb gzipped.

The Next runtime (lazy loading, routing, <Head>) contributes around 15% to the size of that bundle.

The codebase is ~1500LOC (excluding CLI programs).

Is this like `create-react-app`?

Yes and No.

Yes in that both make your life easier.

No in that it enforces a structure so that we can do more advanced things like:

  • Server side rendering
  • Automatic code splitting

In addition, Next.js provides two built-in features that are critical for every single website:

  • Routing with lazy component loading: `

(by importingnext/link`)

  • A way for components to alter <head>: <Head> (by importing next/head)

If you want to create re-usable React components that you can embed in your Next.js app or other React applications, using create-react-app is a great idea. You can later import it and keep your codebase clean!

Why CSS-in-JS?

next/css is powered by Glamor. While it exposes a JavaScript API, it produces regular CSS and therefore important features like :hover, animations, media queries all work.

There’s no tradeoff in power. Instead, we gain the power of simpler composition and usage of JavaScript expressions.

Compiling regular CSS files would be counter-productive to some of our goals. Some of these are listed below.

Please note: we are very interested in supporting regular CSS, since it's so much easier to write and already familiar. To that end, we're currently exploring the possibility of leveraging Shadow DOM to avoid the entire CSS parsing and mangling step [#22]

Compilation performance

Parsing, prefixing, modularizing and hot-code-reloading CSS can be avoided by just using JavaScript.

This results in better compilation performance and less memory usage (especially for large projects). No cssom, postcss, cssnext or transformation plugins.

It also means fewer dependencies and fewer things for Next to do. Everything is Just JavaScript® (since JSX is completely optional)

Lifecycle performance

Since every class name is invoked with the css() helper, Next.js can intelligently add or remove <style> elements that are not being used.

This is important for server-side rendering, but also during the lifecycle of the page. Since Next.js enables pushState transitions that load components dynamically, unnecessary <style> elements would bring down performance over time.

This is a very significant benefit over approaches like require(‘xxxxx.css').

Correctness

Since the class names and styles are defined as JavaScript objects, a variety of aids for correctness are much more easily enabled:

  • Linting
  • Type checking
  • Autocompletion

While these are tractable for CSS itself, we don’t need to duplicate the efforts in tooling and libraries to accomplish them.

What syntactic features are transpiled? How do I change them?

We track V8. Since V8 has wide support for ES6 and async and await, we transpile those. Since V8 doesn’t support class decorators, we don’t transpile those.

See this and this

Why a new Router?

Next.js is special in that:

  • Routes don’t need to be known ahead of time
  • Routes are always lazy-loadable
  • Top-level components can define getInitialProps that should block the loading of the route (either when server-rendering or lazy-loading)

As a result, we were able to introduce a very simple approach to routing that consists of two pieces:

  • Every top level component receives a url object to inspect the url or perform modifications to the history
  • A <Link /> component is used to wrap elements like anchors (<a/>) to perform client-side transitions

We tested the flexibility of the routing with some interesting scenarios. For an example, check out nextgram.

How do I define a custom fancy route?

We’re adding the ability to map between an arbitrary URL and any component by supplying a request handler: #25

On the client side, we'll add a parameter to <Link> so that it decorates the URL differently from the URL it fetches.

How do I fetch data?

It’s up to you. getInitialProps is an async function (or a regular function that returns a Promise). It can retrieve data from anywhere.

Can I use it with Redux?

Yes! Here's an example

Why does it load the runtime from a CDN by default?

We intend for Next.js to be a great starting point for any website or app, no matter how small.

If you’re building a very small mostly-content website, you still want to benefit from features like lazy-loading, a component architecture and module bundling.

But in some cases, the size of React itself would far exceed the content of the page!

For this reason we want to promote a situation where users can share the cache for the basic runtime across internet properties. The application code continues to load from your server as usual.

We are committed to providing a great uptime and levels of security for our CDN. Even so, we also automatically fall back if the CDN script fails to load with a simple trick.

To turn the CDN off, just set module.exports = { cdn: false } in next.config.js.

What is this inspired by?

Many of the goals we set out to accomplish were the ones listed in The 7 principles of Rich Web Applications by Guillermo Rauch.

The ease-of-use of PHP is a great inspiration. We feel Next.js is a suitable replacement for many scenarios where you otherwise would use PHP to output HTML.

Unlike PHP, we benefit from the ES6 module system and every file exports a component or function that can be easily imported for lazy evaluation or testing.

As we were researching options for server-rendering React that didn’t involve a large number of steps, we came across react-page (now deprecated), a similar approach to Next.js by the creator of React Jordan Walke.

Roadmap

Our Roadmap towards 2.0.0 is public.

Authors