[infra] Automatically get info for CSS variables #874
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
Netlify deploy preview |
mnajdova
commented
Nov 26, 2024
Signed-off-by: Marija Najdova <[email protected]>
mnajdova
commented
Nov 26, 2024
| @@ -20,11 +20,5 @@ | |||
| "type": "number", | |||
| "description": "Indicates how many dialogs are nested within." | |||
| } | |||
| }, | |||
| "cssVariables": { | |||
There was a problem hiding this comment.
No need for manually defining it 🎉
mnajdova
commented
Nov 26, 2024
mnajdova
commented
Nov 26, 2024
| @@ -0,0 +1,11 @@ | |||
| export type DialogPopupCssVars = { | |||
There was a problem hiding this comment.
The convention here is tha the type with [ComponentName]CssVars exists. By default, the type is assumed string, if it is something else we can add the @type tag. The actual CSS variable in the docs is the kebab case of the key. I added support for the @deprecated tag too, in case we ever need it in the future.
mnajdova
commented
Nov 27, 2024
| nestedDialogs: string; | ||
| }; | ||
|
|
||
| export const cssVars: DialogPopupCssVars = generateCssVariables(['nestedDialogs']); |
There was a problem hiding this comment.
I added this util similar to the utility for generating classes we have in other projects: https://github.com/mui/material-ui/blob/master/packages/mui-material/src/Dialog/dialogClasses.ts#L43, to make sure we don't have typos while generating the CSS variables.
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
mnajdova
requested review from
michaldudak,
atomiks and
colmtuite
as code owners
mnajdova
requested review from
michaldudak and
vladmoroz
and removed request for
atomiks
vladmoroz
approved these changes
Nov 27, 2024
michaldudak
reviewed
Nov 27, 2024
Signed-off-by: Marija Najdova <[email protected]>
zannager
added
the
scope: infra
github-actions
bot
added
the
PR: out-of-date
atomiks
approved these changes
Dec 2, 2024
Signed-off-by: Marija Najdova <[email protected]>
github-actions
bot
removed
the
PR: out-of-date
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.
This PR proposes a more structured way of defining CSS variables used in the components. The benefits are:
Depends on mui/material-ui#44587
Preview: https://deploy-preview-874--base-ui.netlify.app/new/components/dialog#popup
I will update the rest of the CSS variables usages in a follow up PR.