Skip to content

Commit

Permalink
Add box shadow support via templates
Browse files Browse the repository at this point in the history
  • Loading branch information
madhusudhand committed Jan 5, 2023
1 parent d9f13a8 commit 97d2369
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 0 deletions.
83 changes: 83 additions & 0 deletions lib/block-supports/shadow.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php
/**
* Shadow block support flag.
*
* @package gutenberg
*/

/**
* Registers the style and shadow block attributes for block types that support it.
*
* @param WP_Block_Type $block_type Block Type.
*/
function gutenberg_register_shadow_support( $block_type ) {
if ( ! property_exists( $block_type, 'supports' ) ) {
return;
}

$has_shadow_support = true; // _wp_array_get( $block_type->supports, array( 'shadow' ), false );
if ( ! $has_shadow_support ) {
return;
}

if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}

if ( $has_shadow_support && ! array_key_exists( 'style', $block_type->attributes ) ) {
$block_type->attributes['style'] = array(
'type' => 'object',
);
}

if ( $has_shadow_support && ! array_key_exists( 'shadow', $block_type->attributes ) ) {
$block_type->attributes['shadow'] = array(
'type' => 'string',
);
}
}

/**
* Add CSS classes and inline styles for typography features such as font sizes
* to the incoming attributes array. This will be applied to the block markup in
* the front-end.
*
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
*
* @return array Typography CSS classes and inline styles.
*/
function gutenberg_apply_shadow_support( $block_type, $block_attributes ) {
if ( ! property_exists( $block_type, 'supports' ) ) {
return array();
}

$has_shadow_support = true; // _wp_array_get( $block_type->supports, array( 'shadow' ), false );
if ( ! $has_shadow_support ) {
return array();
}

$shadow_block_styles = array();

$preset_shadow = array_key_exists( 'shadow', $block_attributes ) ? "var:preset|shadow|{$block_attributes['shadow']}" : null;
$custom_shadow = isset( $block_attributes['style']['shadow'] ) ? $block_attributes['style']['shadow'] : null;
$shadow_block_styles['shadow'] = $preset_shadow ? $preset_shadow : $custom_shadow;

$attributes = array();
$styles = gutenberg_style_engine_get_styles( $shadow_block_styles );

if ( ! empty( $styles['css'] ) ) {
$attributes['style'] = $styles['css'];
}

return $attributes;
}

// Register the block support.
WP_Block_Supports::get_instance()->register(
'shadow',
array(
'register_attribute' => 'gutenberg_register_shadow_support',
'apply' => 'gutenberg_apply_shadow_support',
)
);
30 changes: 30 additions & 0 deletions lib/compat/wordpress-6.2/blocks.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php
/**
* Temporary compatibility shims for block APIs present in Gutenberg.
*
* @package gutenberg
*/

/**
* Update allowed inline style attributes list.
*
* Note: This should be removed when the minimum required WP version is >= 6.2.
*
* @param string[] $attrs Array of allowed CSS attributes.
* @return string[] CSS attributes.
*/
function gutenberg_safe_style_attrs_6_2( $attrs ) {
$attrs[] = 'flex-wrap';
$attrs[] = 'gap';
$attrs[] = 'margin-block-start';
$attrs[] = 'margin-block-end';
$attrs[] = 'margin-inline-start';
$attrs[] = 'margin-inline-end';
$attrs[] = 'box-shadow';

return $attrs;
}

add_filter( 'safe_style_css', 'gutenberg_safe_style_attrs_6_2' );

?>
2 changes: 2 additions & 0 deletions lib/load.php
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ function gutenberg_is_experiment_enabled( $name ) {
require __DIR__ . '/compat/wordpress-6.1/theme.php';

// WordPress 6.2 compat.
require __DIR__ . '/compat/wordpress-6.2/blocks.php';
require __DIR__ . '/compat/wordpress-6.2/script-loader.php';
require __DIR__ . '/compat/wordpress-6.2/block-template-utils.php';
require __DIR__ . '/compat/wordpress-6.2/get-global-styles-and-settings.php';
Expand Down Expand Up @@ -135,3 +136,4 @@ function gutenberg_is_experiment_enabled( $name ) {
require __DIR__ . '/block-supports/spacing.php';
require __DIR__ . '/block-supports/dimensions.php';
require __DIR__ . '/block-supports/duotone.php';
require __DIR__ . '/block-supports/shadow.php';
11 changes: 11 additions & 0 deletions packages/style-engine/class-wp-style-engine.php
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,17 @@ final class WP_Style_Engine {
),
),
),
'shadow' => array(
'shadow' => array(
'property_keys' => array(
'default' => 'box-shadow',
),
'path' => array( 'shadow' ),
'css_vars' => array(
'shadow' => '--wp--preset--shadow--$slug',
),
)
),
'dimensions' => array(
'minHeight' => array(
'property_keys' => array(
Expand Down

1 comment on commit 97d2369

@github-actions
Copy link

Choose a reason for hiding this comment

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

Flaky tests detected.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3844561195
📝 Reported issues:

Please sign in to comment.