terribleplan/next.js
1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
Code Issues Releases Wiki Activity

Show that <Head /> is needed for custom document (#5376)

Browse source 
* Show that <Head /> is needed for custom document

* Add comment explaining required Document fields

* Update README.md
This commit is contained in:
Adam Stankiewicz 2018-10-10 12:00:02 +02:00 committed by Tim Neutkens
parent 61fe50a493
commit 299cc65d21
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/next/README.md
View file

@ -1120,6 +1120,8 @@ export default class MyDocument extends Document {
} }
``` ```
All of `<Head />`, `<Main />` and `<NextScript />` are required for page to be properly rendered.
The `ctx` object is equivalent to the one received in all [`getInitialProps`](#fetching-data-and-component-lifecycle) hooks, with one addition: The `ctx` object is equivalent to the one received in all [`getInitialProps`](#fetching-data-and-component-lifecycle) 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`](https://github.com/Khan/aphrodite#server-side-rendering) - `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`](https://github.com/Khan/aphrodite#server-side-rendering)