Components: Expand theming support in COLORS #58097
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,6 @@ | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| const white = '#fff'; | ||
|
|
||
| // Matches the grays in @wordpress/base-styles | ||
|
|
@@ -29,41 +27,65 @@ const ALERT = { | |
| green: '#4ab866', | ||
| }; | ||
|
|
||
| // Should match packages/components/src/utils/theme-variables.scss | ||
| const THEME = { | ||
| accent: `var(--wp-components-color-accent, var(--wp-admin-theme-color, #3858e9))`, | ||
| accentDarker10: `var(--wp-components-color-accent-darker-10, var(--wp-admin-theme-color-darker-10, #2145e6))`, | ||
| accentDarker20: `var(--wp-components-color-accent-darker-20, var(--wp-admin-theme-color-darker-20, #183ad6))`, | ||
| /** Used when placing text on the accent color. */ | ||
| accentInverted: `var(--wp-components-color-accent-inverted, ${ white })`, | ||
|
|
||
| background: `var(--wp-components-color-background, ${ white })`, | ||
|
|
||
| foreground: `var(--wp-components-color-foreground, ${ GRAY[ 900 ] })`, | ||
| /** Used when placing text on the foreground color. */ | ||
| foregroundInverted: `var(--wp-components-color-foreground-inverted, ${ white })`, | ||
|
|
||
| gray: { | ||
| /** @deprecated Use `COLORS.theme.foreground` instead. */ | ||
| 900: `var(--wp-components-color-foreground, ${ GRAY[ 900 ] })`, | ||
| 800: `var(--wp-components-color-gray-800, ${ GRAY[ 800 ] })`, | ||
| 700: `var(--wp-components-color-gray-700, ${ GRAY[ 700 ] })`, | ||
| 600: `var(--wp-components-color-gray-600, ${ GRAY[ 600 ] })`, | ||
| 400: `var(--wp-components-color-gray-400, ${ GRAY[ 400 ] })`, | ||
| 300: `var(--wp-components-color-gray-300, ${ GRAY[ 300 ] })`, | ||
| 200: `var(--wp-components-color-gray-200, ${ GRAY[ 200 ] })`, | ||
| 100: `var(--wp-components-color-gray-100, ${ GRAY[ 100 ] })`, | ||
| }, | ||
| }; | ||
|
|
||
| const UI = { | ||
| background: THEME.background, | ||
| backgroundDisabled: THEME.gray[ 100 ], | ||
| border: THEME.gray[ 600 ], | ||
| borderHover: THEME.gray[ 700 ], | ||
| borderFocus: THEME.accent, | ||
| borderDisabled: THEME.gray[ 400 ], | ||
| textDisabled: THEME.gray[ 600 ], | ||
|
|
||
| // Matches @wordpress/base-styles | ||
| darkGrayPlaceholder: `color-mix(in srgb, ${ THEME.foreground }, transparent 38%)`, | ||
| lightGrayPlaceholder: `color-mix(in srgb, ${ THEME.background }, transparent 35%)`, | ||
| }; | ||
|
|
||
| export const COLORS = Object.freeze( { | ||
| /** | ||
| * The main gray color object. | ||
| * | ||
| * @deprecated Use semantic aliases in `COLORS.ui` or theme-ready variables in `COLORS.theme.gray`. | ||
|
There was a problem hiding this comment. This deprecation marking should encourage devs to stop using this while we migrate the existing usages. |
||
| */ | ||
| gray: GRAY, // TODO: Stop exporting this when everything is migrated to `theme` or `ui` | ||
|
There was a problem hiding this comment. Do we have a tracking issue for all the planned work that we intend to do around theming in the short term? Edit: yes, we do! It's #44116. We could probably tidy that issue up, knowing that in the long term the |
||
| white, | ||
| alert: ALERT, | ||
| /** | ||
| * Theme-ready variables with fallbacks. | ||
| * | ||
| * Prefer semantic aliases in `COLORS.ui` when applicable. | ||
| */ | ||
| theme: THEME, | ||
| /** | ||
| * Semantic aliases (prefer these over raw variables when applicable). | ||
| */ | ||
| ui: UI, | ||
| } ); | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
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.
Should we add a
textalias under UI ? Currently components would be forced to usetheme.foregroundinstead.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.
I'm actually kind of reluctant to add a ton of semantic aliases for the pretty obvious ones like
foreground,background, andaccentbecause it adds more overhead when reworking and renaming stuff. I do think the aliases for the grayscales are useful because nobody memorizes them and it's easy to introduce inconsistencies. Does that resonate?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.
My original reasoning behind proposing
textwas mostly so that folks can continue to use "semantic" color aliases to style their components, instead of mixing them with "raw" theme values. But if we're ok with folks using bothCOLORS.ui.*andCOLORS.theme.*, then we can keep things as-is and only adjust later / if needed, especially if the long term plan is to move theming functionality to a separate package.