Skip to content
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.

Sign up for GitHub

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

Global Styles: keep core and theme preset variables and classes even if they are overwritten #27082

Closed
wants to merge 1 commit into from
Closed

Global Styles: keep core and theme preset variables and classes even if they are overwritten #27082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 68 additions & 10 deletions lib/class-wp-theme-json.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ class WP_Theme_JSON {
*/
const PRESETS_METADATA = array(
array(
'path' => array( 'settings', 'color', 'palette' ),
Copy link
Member

@oandregal oandregal Nov 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we already discussed this? I may be dreaming, though 😅 so I'm going to list why I don't think this is a good idea:

  • it forces all the code that processes the presets to hold a partial reference to its path (settings), which they shouldn't need to.
  • we can't automate updating the docs from this info without also holding a reference to settings
  • a reader of the code can't know where these are sourced from without looking at how they're processed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nosolosw,
I applied this change here because as part of this PR I needed to retrieve and set presets from deactivatedSettings instead of from settings.


						gutenberg_experimental_set(
							$this->contexts[ $context ]['deactivatedSettings'],
							$preset['path'],

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the caveat that I'm not sure this should work this way, as I mentioned below, I also wanted to share that perhaps is a way to balance both needs?

'path' => array( 'color', 'palette' ),
'value_key' => 'color',
'css_var_infix' => 'color',
'classes' => array(
Expand All @@ -192,7 +192,7 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'color', 'gradients' ),
'path' => array( 'color', 'gradients' ),
'value_key' => 'gradient',
'css_var_infix' => 'gradient',
'classes' => array(
Expand All @@ -203,7 +203,7 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'typography', 'fontSizes' ),
'path' => array( 'typography', 'fontSizes' ),
'value_key' => 'size',
'css_var_infix' => 'font-size',
'classes' => array(
Expand All @@ -214,13 +214,13 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'typography', 'fontFamilies' ),
'path' => array( 'typography', 'fontFamilies' ),
'value_key' => 'fontFamily',
'css_var_infix' => 'font-family',
'classes' => array(),
),
array(
'path' => array( 'settings', 'typography', 'fontStyles' ),
'path' => array( 'typography', 'fontStyles' ),
'value_key' => 'slug',
'css_var_infix' => 'font-style',
'classes' => array(
Expand All @@ -231,7 +231,7 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'typography', 'fontWeights' ),
'path' => array( 'typography', 'fontWeights' ),
'value_key' => 'slug',
'css_var_infix' => 'font-weight',
'classes' => array(
Expand All @@ -242,7 +242,7 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'typography', 'textDecorations' ),
'path' => array( 'typography', 'textDecorations' ),
'value_key' => 'value',
'css_var_infix' => 'text-decoration',
'classes' => array(
Expand All @@ -253,7 +253,7 @@ class WP_Theme_JSON {
),
),
array(
'path' => array( 'settings', 'typography', 'textTransforms' ),
'path' => array( 'typography', 'textTransforms' ),
'value_key' => 'slug',
'css_var_infix' => 'text-transform',
'classes' => array(
Expand Down Expand Up @@ -701,9 +701,19 @@ private static function compute_preset_classes( &$stylesheet, $context ) {
// and we don't want to increase its specificity.
$selector = '';
}
if ( empty( $context['settings'] ) ) {
return;
}

foreach ( self::PRESETS_METADATA as $preset ) {
$values = gutenberg_experimental_get( $context, $preset['path'], array() );
$values = gutenberg_experimental_get( $context['settings'], $preset['path'], array() );
if ( isset( $context['deactivatedSettings'] ) ) {
$values = array_merge(
gutenberg_experimental_get( $context['deactivatedSettings'], $preset['path'], array() ),
$values
);
}

foreach ( $values as $value ) {
foreach ( $preset['classes'] as $class ) {
$stylesheet .= self::to_ruleset(
Expand Down Expand Up @@ -738,8 +748,17 @@ private static function compute_preset_classes( &$stylesheet, $context ) {
* @param array $context Input context to process.
*/
private static function compute_preset_vars( &$declarations, $context ) {
if ( empty( $context['settings'] ) ) {
return;
}
foreach ( self::PRESETS_METADATA as $preset ) {
$values = gutenberg_experimental_get( $context, $preset['path'], array() );
$values = gutenberg_experimental_get( $context['settings'], $preset['path'], array() );
if ( isset( $context['deactivatedSettings'] ) ) {
$values = array_merge(
gutenberg_experimental_get( $context['deactivatedSettings'], $preset['path'], array() ),
$values
);
}
foreach ( $values as $value ) {
$declarations[] = array(
'name' => '--wp--preset--' . $preset['css_var_infix'] . '--' . $value['slug'],
Expand Down Expand Up @@ -930,6 +949,45 @@ public function merge( $theme_json ) {
$this->contexts[ $context ]['selector'] = $metadata[ $context ]['selector'];
$this->contexts[ $context ]['supports'] = $metadata[ $context ]['supports'];

// Add the presets to the deactivated settings if they will be overwritten.
if (
! empty( $incoming_data[ $context ]['settings'] ) &&
! empty( $this->contexts[ $context ]['settings'] )
) {
foreach ( self::PRESETS_METADATA as $preset ) {
$incoming_preset = gutenberg_experimental_get(
$incoming_data[ $context ]['settings'],
$preset['path'],
null
);
$current_preset = gutenberg_experimental_get(
$this->contexts[ $context ]['settings'],
$preset['path'],
null
);
// If the preset will be overwritten.
if (
! empty( $current_preset ) &&
! empty( $incoming_preset )
) {
if ( ! isset( $this->contexts[ $context ]['deactivatedSettings'] ) ) {
$this->contexts[ $context ]['deactivatedSettings'] = array();
}
// Append the presets that will be overwritten to the set of deactivated presets that already exist.
$inactive_preset = gutenberg_experimental_get(
$this->contexts[ $context ]['deactivatedSettings'],
$preset['path'],
array()
);
gutenberg_experimental_set(
$this->contexts[ $context ]['deactivatedSettings'],
$preset['path'],
array_merge( $inactive_preset, $current_preset )
);
}
}
}

foreach ( array( 'settings', 'styles' ) as $subtree ) {
if ( ! isset( $incoming_data[ $context ][ $subtree ] ) ) {
continue;
Expand Down
27 changes: 26 additions & 1 deletion packages/edit-site/src/components/editor/global-styles-provider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* External dependencies
*/
import { set, get, mapValues, mergeWith } from 'lodash';
import { set, get, mapValues, mergeWith, isEmpty } from 'lodash';

/**
* WordPress dependencies
Expand All @@ -22,6 +22,7 @@ import { useSelect, useDispatch } from '@wordpress/data';
*/
import { default as getGlobalStyles } from './global-styles-renderer';
import {
PRESET_CATEGORIES,
GLOBAL_CONTEXT,
getValueFromVariable,
getPresetVariable,
Expand Down Expand Up @@ -135,6 +136,30 @@ export default function GlobalStylesProvider( { children, baseStyles } ) {
mergeTreesCustomizer
);

for ( const context in newMergedStyles ) {
const userSettings = get( newUserStyles, [ context, 'settings' ] );
const baseSettings = get( baseStyles, [ context, 'settings' ] );
if ( ! isEmpty( userSettings ) && ! isEmpty( baseSettings ) ) {
for ( const presetCategory in PRESET_CATEGORIES ) {
const { path } = PRESET_CATEGORIES[ presetCategory ];
const userPreset = get( userSettings, path );
const basePreset = get( baseSettings, path );
if ( ! isEmpty( userPreset ) && ! isEmpty( basePreset ) ) {
const inactivePreset = get(
newMergedStyles,
[ context, 'deactivatedSettings', ...path ],
[]
);
set(
newMergedStyles,
[ context, 'deactivatedSettings', ...path ],
[ ...inactivePreset, ...basePreset ]
);
}
}
}
}

return {
userStyles: newUserStyles,
mergedStyles: newMergedStyles,
Expand Down
31 changes: 25 additions & 6 deletions packages/edit-site/src/components/editor/global-styles-renderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,21 @@ export default ( blockData, tree, metadata ) => {
*
* @param {string} blockSelector
* @param {Object} blockPresets
* @param {Object} deactivatedPresets
* @return {string} CSS declarations for the preset classes.
*/
const getBlockPresetClasses = ( blockSelector, blockPresets = {} ) => {
const getBlockPresetClasses = (
blockSelector,
blockPresets = {},
deactivatedPresets = {}
) => {
return reduce(
PRESET_CLASSES,
( declarations, { path, key, property }, classSuffix ) => {
const presets = get( blockPresets, path, [] );
const presets = [
...get( deactivatedPresets, path, [] ),
...get( blockPresets, path, [] ),
];
presets.forEach( ( preset ) => {
const slug = preset.slug;
const value = preset[ key ];
Expand All @@ -88,14 +96,21 @@ export default ( blockData, tree, metadata ) => {
* Transform given preset tree into a set of style declarations.
*
* @param {Object} blockPresets
* @param {Object} deactivatedPresets
*
* @return {Array} An array of style declarations.
*/
const getBlockPresetsDeclarations = ( blockPresets = {} ) => {
const getBlockPresetsDeclarations = (
blockPresets = {},
deactivatedPresets = {}
) => {
return reduce(
PRESET_CATEGORIES,
( declarations, { path, key }, category ) => {
const preset = get( blockPresets, path, [] );
const preset = [
...get( deactivatedPresets, path, [] ),
...get( blockPresets, path, [] ),
];
preset.forEach( ( value ) => {
declarations.push(
`--wp--preset--${ kebabCase( category ) }--${
Expand Down Expand Up @@ -144,7 +159,10 @@ export default ( blockData, tree, metadata ) => {
blockData[ context ].supports,
tree?.[ context ]?.styles
),
...getBlockPresetsDeclarations( tree?.[ context ]?.settings ),
...getBlockPresetsDeclarations(
tree?.[ context ]?.settings,
tree?.[ context ]?.deactivatedSettings
),
...getCustomDeclarations( tree?.[ context ]?.settings?.custom ),
];
if ( blockDeclarations.length > 0 ) {
Expand All @@ -155,7 +173,8 @@ export default ( blockData, tree, metadata ) => {

const presetClasses = getBlockPresetClasses(
blockSelector,
tree?.[ context ]?.settings
tree?.[ context ]?.settings,
tree?.[ context ]?.deactivatedSettings
);
if ( presetClasses ) {
styles.push( presetClasses );
Expand Down
14 changes: 14 additions & 0 deletions phpunit/class-wp-theme-json-test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,20 @@ public function test_merge_incoming_data() {
'fontSize' => '12',
),
),
'deactivatedSettings' => array(
'color' => array(
'palette' => array(
array(
'slug' => 'red',
'color' => 'red',
),
array(
'slug' => 'blue',
'color' => 'blue',
),
),
),
),
),
'core/paragraph' => array(
'selector' => 'p',
Expand Down