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

Jump to bottom

Global Styles: rename core origin key to default for presets #36645

Merged
merged 6 commits into from Nov 19, 2021
Merged

Global Styles: rename core origin key to default for presets #36645

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eff2d8e
Rename core origin key to default.
jorgefilipecosta Nov 19, 2021
69634b3
Update tests
oandregal Nov 19, 2021
40c0a49
Update comment
oandregal Nov 19, 2021
f2574ab
Update key in useSetting
oandregal Nov 19, 2021
d200e5e
update mobile fixtures
jorgefilipecosta Nov 19, 2021
fb4821e
add missing changes
jorgefilipecosta Nov 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/class-wp-theme-json-gutenberg.php
View file
Open in desktop
Expand Up @@ -35,7 +35,7 @@ class WP_Theme_JSON_Gutenberg {
const ROOT_BLOCK_SELECTOR = 'body';

const VALID_ORIGINS = array(
'core',
'default',
'theme',
'user',
);
Expand Down Expand Up @@ -281,7 +281,7 @@ class WP_Theme_JSON_Gutenberg {
* Constructor.
*
* @param array $theme_json A structure that follows the theme.json schema.
* @param string $origin What source of data this object represents. One of core, theme, or user. Default: theme.
* @param string $origin What source of data this object represents. One of default, theme, or user. Default: theme.
*/
public function __construct( $theme_json = array(), $origin = 'theme' ) {
if ( ! in_array( $origin, self::VALID_ORIGINS, true ) ) {
Expand Down Expand Up @@ -1263,7 +1263,7 @@ private static function get_setting_nodes( $theme_json, $selectors = array() ) {
* 'variables': only the CSS Custom Properties for presets & custom ones.
* 'styles': only the styles section in theme.json.
* 'presets': only the classes for the presets.
* @param array $origins A list of origins to include. By default it includes 'core', 'theme', and 'user'.
* @param array $origins A list of origins to include. By default it includes 'default', 'theme', and 'user'.
*
* @return string Stylesheet.
*/
Expand Down
6 changes: 3 additions & 3 deletions lib/class-wp-theme-json-resolver-gutenberg.php
View file
Open in desktop
Expand Up @@ -117,7 +117,7 @@ public static function get_core_data() {

$config = self::read_json_file( __DIR__ . '/theme.json' );
$config = self::translate( $config );
self::$core = new WP_Theme_JSON_Gutenberg( $config, 'core' );
self::$core = new WP_Theme_JSON_Gutenberg( $config, 'default' );

return self::$core;
}
Expand Down Expand Up @@ -283,8 +283,8 @@ public static function get_user_data() {

/**
* There are three sources of data (origins) for a site:
* core, theme, and user. The user's has higher priority
* than the theme's, and the theme's higher than core's.
* default, theme, and user. The user's has higher priority
* than the theme's, and the theme's higher than defaults's.
*
* Unlike the getters {@link get_core_data},
* {@link get_theme_data}, and {@link get_user_data},
Expand Down
6 changes: 3 additions & 3 deletions lib/compat/wordpress-5.9/get-global-styles-and-settings.php
View file
Open in desktop
Expand Up @@ -99,14 +99,14 @@ function gutenberg_get_global_stylesheet( $types = array() ) {
$types = array( 'variables', 'styles', 'presets' );
}

$origins = array( 'core', 'theme', 'user' );
$origins = array( 'default', 'theme', 'user' );
if ( ! $supports_theme_json && ! $supports_link_color ) {
// In this case we only enqueue the core presets (CSS Custom Properties + the classes).
$origins = array( 'core' );
$origins = array( 'default' );
} elseif ( ! $supports_theme_json && $supports_link_color ) {
// For the legacy link color feature to work, the CSS Custom Properties
// should be in scope (either the core or the theme ones).
$origins = array( 'core', 'theme' );
$origins = array( 'default', 'theme' );
}

$tree = WP_Theme_JSON_Resolver_Gutenberg::get_merged_data();
Expand Down
6 changes: 3 additions & 3 deletions lib/global-styles.php
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
$colors_by_origin['user'] : (
isset( $colors_by_origin['theme'] ) ?
$colors_by_origin['theme'] :
$colors_by_origin['core']
$colors_by_origin['default']
);
}

Expand All @@ -124,7 +124,7 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
$gradients_by_origin['user'] : (
isset( $gradients_by_origin['theme'] ) ?
$gradients_by_origin['theme'] :
$gradients_by_origin['core']
$gradients_by_origin['default']
);
}

Expand All @@ -134,7 +134,7 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
$font_sizes_by_origin['user'] : (
isset( $font_sizes_by_origin['theme'] ) ?
$font_sizes_by_origin['theme'] :
$font_sizes_by_origin['core']
$font_sizes_by_origin['default']
);
}

Expand Down
4 changes: 2 additions & 2 deletions packages/block-editor/src/components/colors-gradients/panel-color-gradient-settings.js
View file
Open in desktop
Expand Up @@ -174,7 +174,7 @@ const PanelColorGradientSettingsMultipleSelect = ( props ) => {
const colorGradientSettings = useCommonSingleMultipleSelects();
const customColors = useSetting( 'color.palette.user' );
const themeColors = useSetting( 'color.palette.theme' );
const defaultColors = useSetting( 'color.palette.core' );
const defaultColors = useSetting( 'color.palette.default' );
const shouldDisplayDefaultColors = useSetting( 'color.defaultPalette' );

colorGradientSettings.colors = useMemo( () => {
Expand Down Expand Up @@ -215,7 +215,7 @@ const PanelColorGradientSettingsMultipleSelect = ( props ) => {

const customGradients = useSetting( 'color.gradients.user' );
const themeGradients = useSetting( 'color.gradients.theme' );
const defaultGradients = useSetting( 'color.gradients.core' );
const defaultGradients = useSetting( 'color.gradients.default' );
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess this one might be a breaking change? Should we provide an alias or maybe it's fine for this one?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it is fine origins were never exposed in the core.

const shouldDisplayDefaultGradients = useSetting(
'color.defaultGradients'
);
Expand Down
8 changes: 4 additions & 4 deletions packages/components/src/mobile/global-styles-context/test/fixtures/theme.native.js
View file
Open in desktop
Expand Up @@ -23,7 +23,7 @@ export const GLOBAL_STYLES_PALETTE = [
];

export const GLOBAL_STYLES_GRADIENTS = {
core: [
default: [
{
name: 'Vivid cyan blue to vivid purple',
gradient:
Expand Down Expand Up @@ -138,7 +138,7 @@ export const PARSED_GLOBAL_STYLES = {
export const RAW_FEATURES = {
color: {
palette: {
core: [
default: [
{
name: 'Black',
slug: 'black',
Expand Down Expand Up @@ -174,7 +174,7 @@ export const RAW_FEATURES = {
],
},
gradients: {
core: [
default: [
{
name: 'Vivid cyan blue to vivid purple',
gradient:
Expand Down Expand Up @@ -204,7 +204,7 @@ export const RAW_FEATURES = {
},
typography: {
fontSizes: {
core: [
default: [
{
name: 'Small',
slug: 'small',
Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/mobile/global-styles-context/utils.native.js
View file
Open in desktop
Expand Up @@ -265,7 +265,7 @@ function normalizeFontSizes( fontSizes ) {
const normalizedFontSizes = {};
const dimensions = Dimensions.get( 'window' );

[ 'core', 'theme', 'user' ].forEach( ( key ) => {
[ 'default', 'theme', 'user' ].forEach( ( key ) => {
if ( fontSizes[ key ] ) {
normalizedFontSizes[ key ] = fontSizes[ key ]?.map(
( fontSizeObject ) => {
Expand Down
6 changes: 3 additions & 3 deletions packages/edit-site/src/components/global-styles/hooks.js
View file
Open in desktop
Expand Up @@ -65,7 +65,7 @@ export function useSetting( path, blockName, source = 'all' ) {
const getSettingValue = ( configToUse ) => {
const result = get( configToUse, currentPath );
if ( PATHS_WITH_MERGE[ path ] ) {
return result?.user ?? result?.theme ?? result?.core;
return result?.user ?? result?.theme ?? result?.default;
}
return result;
};
Expand Down Expand Up @@ -220,7 +220,7 @@ export function getSupportedGlobalStylesPanels( name ) {
export function useColorsPerOrigin( name ) {
const [ customColors ] = useSetting( 'color.palette.user', name );
const [ themeColors ] = useSetting( 'color.palette.theme', name );
const [ defaultColors ] = useSetting( 'color.palette.core', name );
const [ defaultColors ] = useSetting( 'color.palette.default', name );
const [ shouldDisplayDefaultColors ] = useSetting( 'color.defaultPalette' );

return useMemo( () => {
Expand Down Expand Up @@ -263,7 +263,7 @@ export function useColorsPerOrigin( name ) {
export function useGradientsPerOrigin( name ) {
const [ customGradients ] = useSetting( 'color.gradients.user', name );
const [ themeGradients ] = useSetting( 'color.gradients.theme', name );
const [ defaultGradients ] = useSetting( 'color.gradients.core', name );
const [ defaultGradients ] = useSetting( 'color.gradients.default', name );
const [ shouldDisplayDefaultGradients ] = useSetting(
'color.defaultGradients'
);
Expand Down
2 changes: 1 addition & 1 deletion packages/edit-site/src/components/global-styles/utils.js
View file
Open in desktop
Expand Up @@ -90,7 +90,7 @@ function findInPresetsBy(
for ( const presetByOrigin of orderedPresetsByOrigin ) {
if ( presetByOrigin ) {
// Preset origins ordered by priority.
const origins = [ 'user', 'theme', 'core' ];
const origins = [ 'user', 'theme', 'default' ];
for ( const origin of origins ) {
const presets = presetByOrigin[ origin ];
if ( presets ) {
Expand Down
16 changes: 8 additions & 8 deletions phpunit/class-wp-theme-json-test.php
View file
Open in desktop
Expand Up @@ -64,7 +64,7 @@ function test_get_settings() {
}

function test_get_settings_presets_are_keyed_by_origin() {
$core_origin = new WP_Theme_JSON_Gutenberg(
$default_origin = new WP_Theme_JSON_Gutenberg(
array(
'version' => WP_Theme_JSON_Gutenberg::LATEST_SCHEMA,
'settings' => array(
Expand All @@ -91,9 +91,9 @@ function test_get_settings_presets_are_keyed_by_origin() {
),
),
),
'core'
'default'
);
$no_origin = new WP_Theme_JSON_Gutenberg(
$no_origin = new WP_Theme_JSON_Gutenberg(
array(
'version' => WP_Theme_JSON_Gutenberg::LATEST_SCHEMA,
'settings' => array(
Expand Down Expand Up @@ -122,15 +122,15 @@ function test_get_settings_presets_are_keyed_by_origin() {
)
);

$actual_core = $core_origin->get_raw_data();
$actual_default = $default_origin->get_raw_data();
$actual_no_origin = $no_origin->get_raw_data();

$expected_core = array(
$expected_default = array(
'version' => WP_Theme_JSON_Gutenberg::LATEST_SCHEMA,
'settings' => array(
'color' => array(
'palette' => array(
'core' => array(
'default' => array(
array(
'slug' => 'white',
'color' => 'white',
Expand All @@ -142,7 +142,7 @@ function test_get_settings_presets_are_keyed_by_origin() {
'core/group' => array(
'color' => array(
'palette' => array(
'core' => array(
'default' => array(
array(
'slug' => 'white',
'color' => 'white',
Expand Down Expand Up @@ -184,7 +184,7 @@ function test_get_settings_presets_are_keyed_by_origin() {
),
);

$this->assertEqualSetsWithIndex( $expected_core, $actual_core );
$this->assertEqualSetsWithIndex( $expected_default, $actual_default );
$this->assertEqualSetsWithIndex( $expected_no_origin, $actual_no_origin );
}

Expand Down