Unverified Commit 64a3697d authored by Henrik Wenz's avatar Henrik Wenz Committed by GitHub

[Docs] Update examples to favour functional _document (#39871)



## Changes

- Migrate class based `_document`s to functional documents 
- Removed `_document.js` where default
- Removed `MyDocument.getInitialProps` where default

## Motivation

This removes some boilerplate and prepares examples for server components.

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
parent b8562839
import Document, { import { Html, Head, Main, NextScript } from 'next/document'
Html,
Head,
Main,
NextScript,
DocumentContext,
} from 'next/document'
class MyDocument extends Document { export default function Document() {
static async getInitialProps(ctx: DocumentContext) {
const initialProps = await Document.getInitialProps(ctx)
return { ...initialProps }
}
render() {
return ( return (
<Html> <Html>
<Head> <Head>
...@@ -27,7 +15,4 @@ class MyDocument extends Document { ...@@ -27,7 +15,4 @@ class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
export default MyDocument
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { import { Html, Head, Main, NextScript } from 'next/document'
Html,
Head,
Main,
NextScript,
DocumentContext,
} from 'next/document'
class MyDocument extends Document { export default function Document() {
static async getInitialProps(ctx: DocumentContext) {
const initialProps = await Document.getInitialProps(ctx)
return { ...initialProps }
}
render() {
const meta = { const meta = {
title: 'Next.js Blog Starter Kit', title: 'Next.js Blog Starter Kit',
description: 'Clone and deploy your own Next.js portfolio in minutes.', description: 'Clone and deploy your own Next.js portfolio in minutes.',
image: image: 'https://assets.vercel.com/image/upload/q_auto/front/vercel/dps.png',
'https://assets.vercel.com/image/upload/q_auto/front/vercel/dps.png',
} }
return ( return (
...@@ -41,7 +28,4 @@ class MyDocument extends Document { ...@@ -41,7 +28,4 @@ class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
export default MyDocument
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -11,5 +10,4 @@ export default class MyDocument extends Document { ...@@ -11,5 +10,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document({ css }) {
render() {
return ( return (
<Html> <Html>
<Head> <Head>
<style dangerouslySetInnerHTML={{ __html: this.props.css }} /> <style dangerouslySetInnerHTML={{ __html: css }} />
</Head> </Head>
<body> <body>
<Main /> <Main />
...@@ -13,5 +12,4 @@ export default class MyDocument extends Document { ...@@ -13,5 +12,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
import { FB_PIXEL_ID } from '../lib/fpixel' import { FB_PIXEL_ID } from '../lib/fpixel'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html> <Html>
<Head> <Head>
...@@ -21,5 +20,4 @@ export default class MyDocument extends Document { ...@@ -21,5 +20,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
import { useAmp } from 'next/amp' import { useAmp } from 'next/amp'
import { GA_TRACKING_ID } from '../lib/gtag' import { GA_TRACKING_ID } from '../lib/gtag'
...@@ -10,8 +10,7 @@ function AmpWrap({ ampOnly, nonAmp }) { ...@@ -10,8 +10,7 @@ function AmpWrap({ ampOnly, nonAmp }) {
return !isAmp && nonAmp return !isAmp && nonAmp
} }
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html> <Html>
<Head /> <Head />
...@@ -68,5 +67,4 @@ export default class MyDocument extends Document { ...@@ -68,5 +67,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
import { GTM_ID } from '../lib/gtm' import { GTM_ID } from '../lib/gtm'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html> <Html>
<Head /> <Head />
...@@ -20,5 +19,4 @@ export default class MyDocument extends Document { ...@@ -20,5 +19,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
class MyDocument extends Document { export default function Document() {
static async getInitialProps(ctx) {
const initialProps = await Document.getInitialProps(ctx)
return { ...initialProps }
}
render() {
return ( return (
<Html> <Html>
<Head> <Head>
...@@ -18,7 +12,4 @@ class MyDocument extends Document { ...@@ -18,7 +12,4 @@ class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
export default MyDocument
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
static async getInitialProps(ctx) {
const initialProps = await Document.getInitialProps(ctx)
return { ...initialProps }
}
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head> <Head>
...@@ -28,5 +22,4 @@ export default class MyDocument extends Document { ...@@ -28,5 +22,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document { export default function Document() {
render() {
return ( return (
<Html> <Html>
<Head /> <Head />
...@@ -13,5 +12,4 @@ export default class MyDocument extends Document { ...@@ -13,5 +12,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
import { ServerStyleSheet } from 'styled-components' import { ServerStyleSheet } from 'styled-components'
export default class MyDocument extends Document { export default function Document() {
render() {
const sheet = new ServerStyleSheet() const sheet = new ServerStyleSheet()
const main = sheet.collectStyles(<Main />) const main = sheet.collectStyles(<Main />)
const styleTags = sheet.getStyleElement() const styleTags = sheet.getStyleElement()
...@@ -16,5 +15,4 @@ export default class MyDocument extends Document { ...@@ -16,5 +15,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import crypto from 'crypto' import crypto from 'crypto'
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
const cspHashOf = (text) => { const cspHashOf = (text) => {
const hash = crypto.createHash('sha256') const hash = crypto.createHash('sha256')
hash.update(text) hash.update(text)
return `'sha256-${hash.digest('base64')}'` return `'sha256-${hash.digest('base64')}'`
} }
export default class MyDocument extends Document { export default function Document() {
render() {
let csp = `default-src 'self'; script-src 'self' ${cspHashOf( let csp = `default-src 'self'; script-src 'self' ${cspHashOf(
NextScript.getInlineScriptSource(this.props) NextScript.getInlineScriptSource(this.props)
)}` )}`
...@@ -28,5 +27,4 @@ export default class MyDocument extends Document { ...@@ -28,5 +27,4 @@ export default class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
import Document, { Html, Head, Main, NextScript } from 'next/document'
export default class MyDocument extends Document {
render() {
return (
<Html>
<Head>
<style dangerouslySetInnerHTML={{ __html: this.props.css }} />
</Head>
<body>
<Main />
<NextScript />
</body>
</Html>
)
}
}
import Document, { Html, Head, Main, NextScript } from 'next/document' import { Html, Head, Main, NextScript } from 'next/document'
class MyDocument extends Document { export default function Document() {
static async getInitialProps(ctx) {
const initialProps = await Document.getInitialProps(ctx)
return { ...initialProps }
}
render() {
return ( return (
<Html lang="en"> <Html lang="en">
<Head /> <Head />
...@@ -16,7 +10,4 @@ class MyDocument extends Document { ...@@ -16,7 +10,4 @@ class MyDocument extends Document {
</body> </body>
</Html> </Html>
) )
}
} }
export default MyDocument
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment