feat(docs): fix theme flicker #4271
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
bot
added
the
size:M
github-actions
bot
added
Type: Documentation
krisantrobus
commented
Mar 13, 2025
| @@ -49,6 +49,8 @@ const LivePreview: React.FC<React.PropsWithChildren<LivePreviewProps>> = ({ | |||
|
|
|||
| const overflow = showOverflow ? "visible" : "auto"; | |||
|
|
|||
| if (!previewTheme) return null; | |||
There was a problem hiding this comment.
I am now delaying the Live code preview rendering until we have correctly identified the theme. I could not fix the Theme provider with CSS variables as it's nested an needs to cahgne independent of the actual app. This was the only workaround to not getting the previews to do the flicker. Won't effect SEO
krisantrobus
commented
Mar 13, 2025
| const [componentMounted, setComponentMounted] = React.useState(false); | ||
|
|
||
| const setMode = (mode: ValidThemeName): void => { | ||
| SimpleStorage.set("theme", mode); |
There was a problem hiding this comment.
No need to use local storage, all done via cookies now
krisantrobus
commented
Mar 13, 2025
| @@ -1,4 +1,6 @@ | |||
| import { datadogRum } from "@datadog/browser-rum"; | |||
| import "@twilio-paste/design-tokens/dist/themes/twilio-dark/tokens.data-theme.css"; | |||
| import "@twilio-paste/design-tokens/dist/themes/twilio/tokens.custom-properties.css"; | |||
There was a problem hiding this comment.
By using the tokens.custom.properties.css instead of tokens.data-theme.css it will set this theme to be applied by default and only overridden when the document.body.data.theme = "twilio-dark"
|
View your CI Pipeline Execution ↗ for commit 84cefa7.
☁️ Nx Cloud last updated this comment at |
krisantrobus
commented
Mar 13, 2025
Comment on lines
+36
to
+51
| <script | ||
| type="text/javascript" | ||
| // eslint-disable-next-line react/no-danger | ||
| dangerouslySetInnerHTML={{ | ||
| __html: ` | ||
| let parts = typeof document !== "undefined" && document?.cookie.split("paste-docs-theme="); | ||
| let cookie = parts.length == 2 ?parts?.pop().split(";").shift() : null; | ||
| if(cookie){ | ||
| document.body.dataset.theme = cookie; | ||
| } | ||
| else if(window !== "undefined" && window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches){ | ||
| document.body.dataset.theme = "twilio-dark"; | ||
| } | ||
| `, | ||
| }} | ||
| /> |
There was a problem hiding this comment.
I tried doing this using the Next Script element but I didn't have any luck, flicker was there just shorted. Doing it this way was the only thing to ge tit to work
|
Size Change: 0 B Total Size: 1.12 MB ℹ️ View Unchanged
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 84cefa7:
|
Paste
|
||||||||||||||||||||||||||||
| Project |
Paste
|
| Branch Review |
use-css-themes-next-js
|
| Run status |
|
| Run duration | 03m 53s |
| Commit |
|
| Committer | Kristian Antrobus |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
67
|
| View all changes introduced in this branch ↗︎ | |
serifluous
approved these changes
Mar 14, 2025
serifluous
added
the
🕵🏻♀️ Run website visual regression
Paste
|
||||||||||||||||||||||||||||
| Project |
Paste
|
| Branch Review |
use-css-themes-next-js
|
| Run status |
|
| Run duration | 06m 58s |
| Commit |
|
| Committer | krisantrobus |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
Failures
|
0
|
|
Flaky
|
0
|
|
Pending
|
0
|
|
Skipped
|
0
|
|
Passing
|
125
|
| View all changes introduced in this branch ↗︎ | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the site to use CSS variables instead of static themes to fix theme flicker