-
Notifications
You must be signed in to change notification settings - Fork 72
[LG-5798] feat: Emotion SSR Support #3384
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
Conversation
🦋 Changeset detectedLatest commit: cfe20cf The changes in this PR will be included in the next version bump. This PR includes changesets to release 91 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Size Change: +70 B (0%) Total Size: 1.82 MB
ℹ️ View Unchanged
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds server-side rendering (SSR) support for Emotion styles in Next.js applications by exporting the CacheProvider component and adding comprehensive documentation for both App Router and Pages Router implementations. This enables proper extraction and injection of Emotion styles during server rendering, preventing flash of unstyled content (FOUC).
Key Changes:
- Exports
CacheProviderfrom@leafygreen-ui/emotionfor use in SSR configurations - Adds
@emotion/reactas a dependency to enable theCacheProviderexport - Documents Next.js App Router SSR setup using
useServerInsertedHTMLandCacheProvider - Documents Next.js Pages Router SSR setup using
extractCritical
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
packages/emotion/package.json |
Adds @emotion/react ^11.14.0 as a dependency using proper caret notation |
packages/emotion/src/index.ts |
Imports and re-exports CacheProvider from @emotion/react |
packages/emotion/README.md |
Adds comprehensive SSR documentation for Next.js App Router and Pages Router with code examples |
.changeset/mean-sloths-wonder.md |
Documents the change as a minor version bump with appropriate description |
pnpm-lock.yaml |
Updates dependency resolution to include new @emotion/react and @emotion/cache packages; removes unrelated Next.js app dependencies |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
tsck
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The README needs a bit of a re-read, bunch of small issues there
tsck
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny nit but otherwise LGTM
|
Coverage after merging ar/LG-5798-ssr-docs into main will be
Coverage Report for Changed Files
|
✍️ Proposed changes
Adds
CacheProviderexport from@leafygreen-ui/emotionand SSR documentation for integrating LeafyGreen UI with Next.js applications. This enables proper server-side rendering of Emotion styles for both App Router (usinguseServerInsertedHTML) and Pages Router (usingextractCritical), preventing flash of unstyled content (FOUC).🎟️ Jira ticket: LG-5798
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes
@leafygreen-ui/emotionin a Next.js App Router projectEmotionRegistry.tsxfile following the README instructionsEmotionRegistrycssfrom@leafygreen-ui/emotionin a client component