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.

Sign up for GitHub

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

Jump to bottom

Add render prop support to <Main> #30156

Merged
merged 23 commits into from
Nov 7, 2021
Merged

Add render prop support to <Main> #30156

merged 23 commits into from
Nov 7, 2021

Conversation

devknoll
Copy link
Contributor

@devknoll devknoll commented Oct 22, 2021 •
edited
Loading

Adds support for render props to the <Main> component, when using the functional custom Document style. This allows you to write something like this:

export default function Document() {
  const jsxStyleRegistry = createStyleRegistry()
  return (
    <Html>
      <Head />
      <body>
        <Main>
          {content => (
            <StyledJsxWrapper registry={jsxStyleRegistry}>
              {content}
            </StyledJsxWrapper>
          )}
        </Main>
        <NextScript />
      </body>
    </Html>
  )
}

In functional document components, this allows the <App> to be wrapped, similar to enhanceApp (which is only available via getInitialProps, which is not supported by functional document components). The primary use for this is for integrating with 3rd party CSS-in-JS libraries, allowing them to attach an useFlush handler to support React 18:

import { unstable_useFlush as useFlush } from 'next/document'

export default function StyledJsxWrapper({ children, registry }) {
  useFlush(() => {
    /* ... */
  })
  return (
    <StyleRegistry registry={registry}>
      {children}
    </StyleRegistry>
  )
}

Support for useFlush will be added in a follow up PR.

@ijjk

This comment has been minimized.

Sign in to view
@ijjk

This comment has been minimized.

Sign in to view
@ijjk

This comment has been minimized.

Sign in to view
@devknoll devknoll marked this pull request as ready for review October 22, 2021 16:35
@devknoll devknoll closed this Oct 27, 2021
@devknoll devknoll reopened this Nov 1, 2021
@ijjk

This comment has been minimized.

Sign in to view
huozhi
huozhi reviewed Nov 1, 2021
View reviewed changes
Copy link
Member

@huozhi huozhi left a comment

Choose a reason for hiding this comment

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

The styled-jsx example is great 👍 Would be great if we can have a test for it!

packages/next/server/render.tsx Show resolved Hide resolved
@ijjk

This comment has been minimized.

Sign in to view
@ijjk

This comment has been minimized.

Sign in to view
@ijjk

This comment has been minimized.

Sign in to view
@ijjk

This comment has been minimized.

Sign in to view
shuding
shuding previously approved these changes Nov 2, 2021
View reviewed changes
ijjk
ijjk previously approved these changes Nov 2, 2021
View reviewed changes
@ijjk

This comment has been minimized.

Sign in to view
huozhi
huozhi previously approved these changes Nov 2, 2021
View reviewed changes
@ijjk

This comment has been minimized.

Sign in to view
@devknoll devknoll dismissed stale reviews from huozhi, ijjk, and shuding via 9e774c8 November 6, 2021 17:18
@ijjk

This comment has been minimized.

Sign in to view
shuding
shuding previously approved these changes Nov 6, 2021
View reviewed changes
@devknoll devknoll changed the title Add experimental render prop support to <Main> Add render prop support to <Main> Nov 7, 2021
@ijjk

This comment has been minimized.

Sign in to view
@ijjk
Copy link
Member

ijjk commented Nov 7, 2021

Stats from current PR

Default Build (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
buildDuration 20.8s 21.4s ⚠️ +505ms
buildDurationCached 4.2s 4.2s -38ms
nodeModulesSize 332 MB 332 MB ⚠️ +1.9 kB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.487 3.519 ⚠️ +0.03
/ avg req/sec 716.9 710.38 ⚠️ -6.52
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.644 1.703 ⚠️ +0.06
/error-in-render avg req/sec 1520.49 1467.93 ⚠️ -52.56
Client Bundles (main, webpack, commons)
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 28 kB 28 kB ✓
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 71.9 kB 71.9 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
_app-HASH.js gzip 1.23 kB 1.23 kB ✓
_error-HASH.js gzip 194 B 194 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 327 B 327 B ✓
dynamic-HASH.js gzip 2.38 kB 2.38 kB ✓
head-HASH.js gzip 350 B 350 B ✓
hooks-HASH.js gzip 635 B 635 B ✓
image-HASH.js gzip 4.44 kB 4.44 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 1.87 kB 1.87 kB ✓
routerDirect..HASH.js gzip 321 B 321 B ✓
script-HASH.js gzip 383 B 383 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
334f979574ae..6f4.css gzip 106 B 106 B ✓
Overall change 13.1 kB 13.1 kB ✓
Client Build Manifests
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
_buildManifest.js gzip 459 B 459 B ✓
Overall change 459 B 459 B ✓
Rendered Page Sizes
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
index.html gzip 522 B 522 B ✓
link.html gzip 535 B 535 B ✓
withRouter.html gzip 515 B 515 B ✓
Overall change 1.57 kB 1.57 kB ✓
Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
buildDuration 22s 22.5s ⚠️ +527ms
buildDurationCached 4.1s 4.3s ⚠️ +203ms
nodeModulesSize 332 MB 332 MB ⚠️ +1.9 kB
Page Load Tests Overall increase ✓
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
/ failed reqs 0 0 ✓
/ total time (seconds) 3.451 3.392 -0.06
/ avg req/sec 724.43 737.05 +12.62
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.597 1.598 0
/error-in-render avg req/sec 1565.68 1564 ⚠️ -1.68
Client Bundles (main, webpack, commons)
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.3 kB 42.3 kB ✓
main-HASH.js gzip 28.2 kB 28.2 kB ✓
webpack-HASH.js gzip 1.43 kB 1.43 kB ✓
Overall change 72.1 kB 72.1 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
_app-HASH.js gzip 1.22 kB 1.22 kB ✓
_error-HASH.js gzip 180 B 180 B ✓
amp-HASH.js gzip 305 B 305 B ✓
css-HASH.js gzip 321 B 321 B ✓
dynamic-HASH.js gzip 2.38 kB 2.38 kB ✓
head-HASH.js gzip 342 B 342 B ✓
hooks-HASH.js gzip 622 B 622 B ✓
image-HASH.js gzip 4.46 kB 4.46 kB ✓
index-HASH.js gzip 256 B 256 B ✓
link-HASH.js gzip 1.91 kB 1.91 kB ✓
routerDirect..HASH.js gzip 314 B 314 B ✓
script-HASH.js gzip 375 B 375 B ✓
withRouter-HASH.js gzip 309 B 309 B ✓
334f979574ae..6f4.css gzip 106 B 106 B ✓
Overall change 13.1 kB 13.1 kB ✓
Client Build Manifests
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
_buildManifest.js gzip 460 B 460 B ✓
Overall change 460 B 460 B ✓
Rendered Page Sizes
vercel/next.js canary azukaru/next.js x-experimental-content-wrapper Change
index.html gzip 521 B 521 B ✓
link.html gzip 534 B 534 B ✓
withRouter.html gzip 515 B 515 B ✓
Overall change 1.57 kB 1.57 kB ✓
Commit: 0600dfe

@kodiakhq kodiakhq bot merged commit ad98178 into vercel:canary Nov 7, 2021
@devknoll devknoll mentioned this pull request Nov 9, 2021
Closed
@ijjk ijjk mentioned this pull request Nov 19, 2021
Merged
3 tasks
kodiakhq bot pushed a commit that referenced this pull request Nov 19, 2021
@ijjk
Fix non-concurrent function _document (#31628)
e8ca334 
This ensures functional `_document` is rendered correctly when not using concurrent mode. 

## Bug

- [x] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

Fixes: #31593
x-ref: #30156
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@shuding shuding shuding approved these changes

@ijjk ijjk ijjk left review comments

@huozhi huozhi huozhi left review comments

@padmaia padmaia Awaiting requested review from padmaia

@styfle styfle Awaiting requested review from styfle

@timneutkens timneutkens Awaiting requested review from timneutkens

Assignees
No one assigned
Labels
type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@devknoll @ijjk @shuding @huozhi