[docs] Add live demo with CssVarsProvider #38792
Merged
Conversation
This file contains 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
oliviertassinari
added
docs
oliviertassinari
force-pushed
the
demo-css-variables
branch
from
4d81e69 to
c2d3ea9
Compare
danilo-leal
reviewed
Sep 4, 2023
docs/data/material/experimental-api/css-theme-variables/usage/usage.md
Outdated
Show resolved
Hide resolved
oliviertassinari
commented
Sep 4, 2023
| @@ -210,7 +210,6 @@ See the complete usage of `createVssVarsProvider` in [Material UI](https://githu | |||
| - `defaultMode?: 'light' | 'dark' | 'system'` - Application's default mode (`light` by default) | |||
| - `disableTransitionOnChange : boolean` - Disable CSS transitions when switching between modes | |||
| - `enableColorScheme: boolean` - Indicate to the browser which color scheme is used (light or dark) for rendering built-in UI | |||
| - `prefix: string` - CSS variable prefix | |||
There was a problem hiding this comment.
Doesn't exist, outdated docs.
github-actions
bot
added
the
PR: out-of-date
oliviertassinari
force-pushed
the
demo-css-variables
branch
from
e50d63f to
b0cdbcb
Compare
github-actions
bot
added
PR: out-of-date
Co-authored-by: Danilo Leal <[email protected]> Signed-off-by: Olivier Tassinari <[email protected]>
oliviertassinari
force-pushed
the
demo-css-variables
branch
from
b0cdbcb to
7180b23
Compare
github-actions
bot
removed
the
PR: out-of-date
christophermorin
pushed a commit
to christophermorin/material-ui
that referenced
this pull request
Sep 21, 2023
Signed-off-by: Olivier Tassinari <[email protected]> Co-authored-by: Danilo Leal <[email protected]>
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.
I never understood why we didn't have a live demo with CssVarsProvider for Material UI. I have struggled to make this one, I struggled on a couple of points (e.g. tried to use createTheme, tried to use
prefix, I didn't know where to import extendTheme from).Use case: mui/mui-x#10214
Preview: https://deploy-preview-38792--material-ui.netlify.app/material-ui/experimental-api/css-theme-variables/usage/#getting-started
Regarding the CSS size, the CSS variables added to the HTML docs adds 4 kB gzipped. It doesn't seem to really impact performance: https://www.webpagetest.org/video/compare.php?tests=230903_BiDcR6_A0Z,230903_AiDcV1_A8W.
The dark/light mode switch is broken, but it's beyond this PR. We need to fix this as well to fully migrate our docs to use CSS vars #39047.
Screen.Recording.2023-09-18.at.22.23.44.mov