@wordpress/style-engine 1.29.0 → 1.30.0

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+## 1.30.0 (2023-11-29)
+
 ## 1.29.0 (2023-11-16)
 
 ## 1.28.0 (2023-11-02)

package/class-wp-style-engine.php

@@ -210,6 +210,9 @@ final class WP_Style_Engine {
 				'property_keys' => array(
 					'default' => 'font-size',
 				),
+				'css_vars'      => array(
+					'font-size' => '--wp--preset--font-size--$slug',
+				),
 				'path'          => array( 'typography', 'fontSize' ),
 				'classnames'    => array(
 					'has-$slug-font-size' => 'font-size',
@@ -219,6 +222,9 @@ final class WP_Style_Engine {
 				'property_keys' => array(
 					'default' => 'font-family',
 				),
+				'css_vars'      => array(
+					'font-family' => '--wp--preset--font-family--$slug',
+				),
 				'path'          => array( 'typography', 'fontFamily' ),
 				'classnames'    => array(
 					'has-$slug-font-family' => 'font-family',

package/docs/using-the-style-engine-with-block-supports.md

@@ -30,11 +30,11 @@ The global function `wp_style_engine_get_styles` accepts a style object as its f
 
 ```php
 $block_styles =  array(
-     'spacing' => array( 'padding' => '10px', 'margin' => array( 'top' => '1em') ),
-     'typography' => array( 'fontSize' => '2.2rem' ),
+	'spacing' => array( 'padding' => '10px', 'margin' => array( 'top' => '1em') ),
+	'typography' => array( 'fontSize' => '2.2rem' ),
 );
 $styles = wp_style_engine_get_styles(
-    $block_styles
+	$block_styles
 );
 print_r( $styles );
 
@@ -51,7 +51,7 @@ When [registering a block support](https://developer.wordpress.org/reference/cla
 
 If a block has opted into the block support, the values of "class" and "style" will be applied to the block element's "class" and "style" attributes accordingly when rendered in the frontend HTML. Note, this applies only to server-side rendered blocks, for example, the [Site Title block](https://developer.wordpress.org/block-editor/reference-guides/core-blocks/#site-title).
 
-The callback receives `$block_type` and `$block_attributes` as arguments. The `style` attribute within `$block_attributes` only contains the raw style object, if any styles have been set for the block, and not any CSS or classnames to be applied to the block's HTML elements. 
+The callback receives `$block_type` and `$block_attributes` as arguments. The `style` attribute within `$block_attributes` only contains the raw style object, if any styles have been set for the block, and not any CSS or classnames to be applied to the block's HTML elements.
 
 Here is where `wp_style_engine_get_styles` comes in handy: it will generate CSS and, if appropriate, classnames to be added to the "style" and "class" HTML attributes in the final rendered block markup.
 
@@ -100,7 +100,7 @@ Before passing the block style object to the Style Engine, you'll need to take i
 
 If a block either:
 
-- has no support for a style, or 
+- has no support for a style, or
 - skips serialization of that style
 
 it's likely that you'll want to remove those style values from the style object before passing it to the Style Engine with help of two functions:
@@ -108,24 +108,24 @@ it's likely that you'll want to remove those style values from the style object
 - wp_should_skip_block_supports_serialization()
 - block_has_support()
 
-We can now update the apply callback code above so that we'll only return "style" and "class", where a block has support and it doesn't skip serialization:
+We can now update the "apply" callback code above so that we'll only return "style" and "class", where a block has support, and it doesn't skip serialization:
 
 ```php
 function gutenberg_apply_colors_support( $block_type, $block_attributes ) {
 	// The return value.
 	$attributes = array();
-    
+
 	// Return early if the block skips all serialization for block supports.
 	if ( gutenberg_should_skip_block_supports_serialization( $block_type, 'color' ) ) {
 		return $attributes;
 	}
 
 	// Checks for support and skip serialization.
-	$has_text_support                        = block_has_support( $block_type, array( 'color', 'text' ), false ); 
+	$has_text_support                        = block_has_support( $block_type, array( 'color', 'text' ), false );
 	$has_background_support                  = block_has_support( $block_type, array( 'color', 'background' ), false );
-	$skips_serialization_of_color_text       = wp_should_skip_block_supports_serialization( $block_type, 'color', 'text' ); 
-	$skips_serialization_of_color_background = wp_should_skip_block_supports_serialization( $block_type, 'color', 'background' ); 
-    
+	$skips_serialization_of_color_text       = wp_should_skip_block_supports_serialization( $block_type, 'color', 'text' );
+	$skips_serialization_of_color_background = wp_should_skip_block_supports_serialization( $block_type, 'color', 'background' );
+
 	// Get the color styles from the style object.
 	$block_color_styles = isset( $block_attributes['style']['color'] ) ? $block_attributes['style']['color'] : null;
 
@@ -161,7 +161,7 @@ Styling a block using these presets normally involves adding the selector to the
 
 For styles that can have preset values, such as text color and font family, the Style Engine knows how to construct the classnames using the preset slug.
 
-To discern CSS values from preset values however, the Style Engine expects a special format.
+To discern CSS values from preset values, the Style Engine expects a special format.
 
 Preset values must follow the pattern `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`.
 
@@ -171,13 +171,16 @@ Example:
 
 ```php
 // Let's say the block attributes styles contain a fontSize preset slug of "small".
+// $block_attributes['fontSize'] = 'var:preset|font-size|small';
 $preset_font_size        = "var:preset|font-size|{$block_attributes['fontSize']}";
 // Now let's say the block attributes styles contain a backgroundColor preset slug of "blue".
+// $block_attributes['backgroundColor'] = 'var:preset|color|blue';
 $preset_background_color = "var:preset|color|{$block_attributes['backgroundColor']}";
 
 $block_styles =  array(
 	'typography' => array( 'fontSize' => $preset_font_size ),
-	'color'      => array( 'background' => $preset_background_color )
+	'color'      => array( 'background' => $preset_background_color ),
+	'spacing'    => array( 'padding' => '10px', 'margin' => array( 'top' => '1em') ),
 );
 
 $styles = wp_style_engine_get_styles(
@@ -187,19 +190,29 @@ print_r( $styles );
 
 /*
 array(
-    'css'        => 'background-color:var(--wp--preset--color--blue);font-size:var(--wp--preset--font-size--small);',
-    'classnames' => 'has-background-color has-blue-background-color has-small-font-size',
+	'css'          => 'background-color:var(--wp--preset--color--blue);padding:10px;margin-top:1em;font-size:var(--wp--preset--font-size--small);',
+	'declarations' => array(
+		'background-color' => 'var(--wp--preset--color--blue)',
+		'padding' => '10px',
+		'margin-top' => '1em',
+		'font-size' => 'var(--wp--preset--font-size--small)',
+	),
+    'classnames'   => 'has-background has-blue-background-color has-small-font-size',
 )
 */
 ```
 
-If you don't want the Style Engine to output the CSS custom vars as well, which you might not if you're applying both the CSS and classnames to the block element, you can pass `'convert_vars_to_classnames' => true` in the options array.
+If you don't want the Style Engine to output the CSS custom vars in the generated CSS string as well, which you might not if you're applying both the CSS rules and classnames to the block element, you can pass `'convert_vars_to_classnames' => true` in the options array.
+
+This flag means "convert the vars to classnames and don't output the vars to the CSS". The Style Engine will therefore **only** generate the required classnames and omit the CSS custom vars in the CSS.
+
+Using the above example code, observe the different output when we pass the option:
 
 ```php
 $options = array(
-	// Whether to skip converting CSS var:? values to var( --wp--preset--* ) values. Default is `false`.
-	'convert_vars_to_classnames' => 'true',
+	'convert_vars_to_classnames' => true,
 );
+
 $styles = wp_style_engine_get_styles(
 	$block_styles,
 	$options
@@ -208,8 +221,12 @@ print_r( $styles );
 
 /*
 array(
-    'css'        => 'letter-spacing:12px;', // non-preset-based CSS will still be compiled.
-    'classnames' => 'has-background-color has-blue-background-color has-small-font-size',
+	'css'          => 'padding:10px;margin-top:1em;',
+	'declarations' => array(
+		'padding' => '10px',
+		'margin-top' => '1em',
+	),
+	'classnames'   => 'has-background has-blue-background-color has-small-font-size',
 )
 */
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/style-engine",
-	"version": "1.29.0",
+	"version": "1.30.0",
 	"description": "A suite of parsers and compilers for WordPress styles.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -35,5 +35,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "839018ff6029ba749780e288e08ff9cd898e50e8"
+	"gitHead": "d98dff8ea96f29cfea045bf964269f46f040d539"
 }