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.

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

Block Supports: Allow skipping serialization of border #30035

Merged
merged 4 commits into from
Mar 23, 2021

Conversation

ockham
Copy link
Contributor

@ockham ockham commented Mar 19, 2021

Description

Part of #28913. Counterpart to #29142 and #29253.

Find affected blocks by grepping __experimentalBorder in block.json files. This yields the

  • Group and
  • Image

blocks.

How has this been tested?

TBD. I don't even see the border radius panel for the Group and Image on trunk. Edit: I just noticed instructions over at #27667, will try those on Monday.

Anyway, this will need adding "__experimentalSkipSerialization": true to the __experimentalBorder object in the block.json files of the Group and Image blocks:

diff --git a/packages/block-library/src/group/block.json b/packages/block-library/src/group/block.json
index ad4cc62fc6..e8f3303669 100644
--- a/packages/block-library/src/group/block.json
+++ b/packages/block-library/src/group/block.json
@@ -26,7 +26,8 @@
                        "color": true,
                        "radius": true,
                        "style": true,
-                       "width": true
+                       "width": true,
+                       "__experimentalSkipSerialization": true
                },
                "__experimentalLayout": true
        },
diff --git a/packages/block-library/src/image/block.json b/packages/block-library/src/image/block.json
index 3952230ded..b664e22593 100644
--- a/packages/block-library/src/image/block.json
+++ b/packages/block-library/src/image/block.json
@@ -73,7 +73,8 @@
        "supports": {
                "anchor": true,
                "__experimentalBorder": {
-                       "radius": true
+                       "radius": true,
+                       "__experimentalSkipSerialization": true
                }
        },
        "editorStyle": "wp-block-image-editor",

Screenshots

TBD

@ockham ockham added the Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json label Mar 19, 2021
@ockham
Copy link
Contributor Author

ockham commented Mar 19, 2021

@nosolosw Can I get a super early review here? I'm not sure if I'm missing any big pieces; it's a bit hard to tell since I can't get the border settings to show for the Group and Image blocks at all (even on trunk).

@github-actions
Copy link

github-actions bot commented Mar 19, 2021

Size Change: +8.73 kB (+1%)

Total Size: 1.41 MB

Filename Size Change
build/a11y/index.js 1.14 kB +1 B (0%)
build/annotations/index.js 3.77 kB -7 B (0%)
build/api-fetch/index.js 3.4 kB -2 B (0%)
build/autop/index.js 2.82 kB -4 B (0%)
build/block-directory/index.js 8.63 kB -1 B (0%)
build/block-editor/index.js 127 kB +377 B (0%)
build/block-editor/style-rtl.css 12.4 kB +32 B (0%)
build/block-editor/style.css 12.4 kB +34 B (0%)
build/block-library/blocks/file/editor-rtl.css 175 B -24 B (-12%) 👏
build/block-library/blocks/file/editor.css 174 B -24 B (-12%) 👏
build/block-library/blocks/freeform/editor-rtl.css 2.45 kB -9 B (0%)
build/block-library/blocks/freeform/editor.css 2.45 kB -9 B (0%)
build/block-library/blocks/list/editor-rtl.css 0 B -65 B (removed) 🏆
build/block-library/blocks/list/editor.css 0 B -65 B (removed) 🏆
build/block-library/blocks/navigation-link/style-rtl.css 897 B +212 B (+31%) 🚨
build/block-library/blocks/navigation-link/style.css 895 B +213 B (+31%) 🚨
build/block-library/blocks/navigation/editor-rtl.css 1.12 kB +10 B (+1%)
build/block-library/blocks/navigation/editor.css 1.13 kB +11 B (+1%)
build/block-library/blocks/page-list/style-rtl.css 167 B -370 B (-69%) 🏆
build/block-library/blocks/page-list/style.css 167 B -369 B (-69%) 🏆
build/block-library/blocks/query-loop/editor-rtl.css 83 B -7 B (-8%)
build/block-library/blocks/query-loop/editor.css 82 B -7 B (-8%)
build/block-library/blocks/query/editor-rtl.css 795 B -25 B (-3%)
build/block-library/blocks/query/editor.css 794 B -25 B (-3%)
build/block-library/editor-rtl.css 9.43 kB -45 B (0%)
build/block-library/editor.css 9.44 kB -44 B (0%)
build/block-library/index.js 148 kB +192 B (0%)
build/block-library/style-rtl.css 8.95 kB +67 B (+1%)
build/block-library/style.css 8.95 kB +66 B (+1%)
build/block-serialization-default-parser/index.js 1.87 kB -1 B (0%)
build/blocks/index.js 48.3 kB -3 B (0%)
build/components/index.js 284 kB -29 B (0%)
build/components/style-rtl.css 16.2 kB +7 B (0%)
build/components/style.css 16.2 kB +8 B (0%)
build/compose/index.js 11.2 kB +59 B (+1%)
build/customize-widgets/index.js 6.03 kB +2.08 kB (+53%) 🆘
build/customize-widgets/style-rtl.css 378 B +210 B (+125%) 🆘
build/customize-widgets/style.css 379 B +211 B (+126%) 🆘
build/data-controls/index.js 831 B +1 B (0%)
build/data/index.js 8.87 kB +2 B (0%)
build/date/index.js 31.9 kB +21 B (0%)
build/dom/index.js 4.98 kB +13 B (0%)
build/edit-navigation/index.js 16.5 kB +4.56 kB (+38%) 🚨
build/edit-navigation/style-rtl.css 2.52 kB +1.21 kB (+92%) 🆘
build/edit-navigation/style.css 2.52 kB +1.21 kB (+93%) 🆘
build/edit-post/index.js 307 kB -344 B (0%)
build/edit-post/style-rtl.css 7.05 kB -68 B (-1%)
build/edit-post/style.css 7.04 kB -62 B (-1%)
build/edit-site/index.js 27.3 kB +131 B (0%)
build/edit-site/style-rtl.css 4.51 kB -47 B (-1%)
build/edit-site/style.css 4.5 kB -47 B (-1%)
build/edit-widgets/index.js 20.2 kB +37 B (0%)
build/edit-widgets/style-rtl.css 3.15 kB -50 B (-2%)
build/edit-widgets/style.css 3.15 kB -52 B (-2%)
build/editor/editor-styles-rtl.css 0 B -347 B (removed) 🏆
build/editor/editor-styles.css 0 B -347 B (removed) 🏆
build/editor/index.js 41.9 kB +77 B (0%)
build/element/index.js 4.62 kB +5 B (0%)
build/format-library/index.js 6.75 kB +5 B (0%)
build/hooks/index.js 2.28 kB +1 B (0%)
build/html-entities/index.js 622 B -1 B (0%)
build/is-shallow-equal/index.js 699 B +1 B (0%)
build/keyboard-shortcuts/index.js 2.53 kB -3 B (0%)
build/keycodes/index.js 1.95 kB +2 B (0%)
build/list-reusable-blocks/index.js 3.19 kB +48 B (+2%)
build/media-utils/index.js 5.38 kB +35 B (+1%)
build/nux/index.js 3.4 kB -1 B (0%)
build/plugins/index.js 2.95 kB +63 B (+2%)
build/primitives/index.js 1.42 kB -1 B (0%)
build/react-i18n/index.js 1.45 kB -3 B (0%)
build/redux-routine/index.js 2.84 kB -3 B (0%)
build/reusable-blocks/index.js 3.78 kB -1 B (0%)
build/rich-text/index.js 13.4 kB +40 B (0%)
build/server-side-render/index.js 2.58 kB -2 B (0%)
build/shortcode/index.js 1.7 kB +1 B (0%)
build/token-list/index.js 1.27 kB -4 B (0%)
build/url/index.js 3.02 kB -3 B (0%)
build/viewport/index.js 1.86 kB -2 B (0%)
build/warning/index.js 1.14 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/blob/index.js 664 B 0 B
build/block-directory/style-rtl.css 1 kB 0 B
build/block-directory/style.css 1.01 kB 0 B
build/block-library/blocks/archives/editor-rtl.css 61 B 0 B
build/block-library/blocks/archives/editor.css 60 B 0 B
build/block-library/blocks/audio/editor-rtl.css 58 B 0 B
build/block-library/blocks/audio/editor.css 58 B 0 B
build/block-library/blocks/audio/style-rtl.css 112 B 0 B
build/block-library/blocks/audio/style.css 112 B 0 B
build/block-library/blocks/block/editor-rtl.css 161 B 0 B
build/block-library/blocks/block/editor.css 161 B 0 B
build/block-library/blocks/button/editor-rtl.css 475 B 0 B
build/block-library/blocks/button/editor.css 474 B 0 B
build/block-library/blocks/button/style-rtl.css 479 B 0 B
build/block-library/blocks/button/style.css 479 B 0 B
build/block-library/blocks/buttons/editor-rtl.css 315 B 0 B
build/block-library/blocks/buttons/editor.css 315 B 0 B
build/block-library/blocks/buttons/style-rtl.css 364 B 0 B
build/block-library/blocks/buttons/style.css 363 B 0 B
build/block-library/blocks/calendar/style-rtl.css 208 B 0 B
build/block-library/blocks/calendar/style.css 208 B 0 B
build/block-library/blocks/categories/editor-rtl.css 84 B 0 B
build/block-library/blocks/categories/editor.css 83 B 0 B
build/block-library/blocks/categories/style-rtl.css 79 B 0 B
build/block-library/blocks/categories/style.css 79 B 0 B
build/block-library/blocks/code/style-rtl.css 90 B 0 B
build/block-library/blocks/code/style.css 90 B 0 B
build/block-library/blocks/columns/editor-rtl.css 190 B 0 B
build/block-library/blocks/columns/editor.css 190 B 0 B
build/block-library/blocks/columns/style-rtl.css 421 B 0 B
build/block-library/blocks/columns/style.css 421 B 0 B
build/block-library/blocks/cover/editor-rtl.css 605 B 0 B
build/block-library/blocks/cover/editor.css 605 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.24 kB 0 B
build/block-library/blocks/cover/style.css 1.24 kB 0 B
build/block-library/blocks/embed/editor-rtl.css 486 B 0 B
build/block-library/blocks/embed/editor.css 486 B 0 B
build/block-library/blocks/embed/style-rtl.css 401 B 0 B
build/block-library/blocks/embed/style.css 400 B 0 B
build/block-library/blocks/file/style-rtl.css 248 B 0 B
build/block-library/blocks/file/style.css 248 B 0 B
build/block-library/blocks/gallery/editor-rtl.css 704 B 0 B
build/block-library/blocks/gallery/editor.css 705 B 0 B
build/block-library/blocks/gallery/style-rtl.css 1.11 kB 0 B
build/block-library/blocks/gallery/style.css 1.1 kB 0 B
build/block-library/blocks/group/editor-rtl.css 160 B 0 B
build/block-library/blocks/group/editor.css 160 B 0 B
build/block-library/blocks/group/style-rtl.css 57 B 0 B
build/block-library/blocks/group/style.css 57 B 0 B
build/block-library/blocks/heading/editor-rtl.css 129 B 0 B
build/block-library/blocks/heading/editor.css 129 B 0 B
build/block-library/blocks/heading/style-rtl.css 76 B 0 B
build/block-library/blocks/heading/style.css 76 B 0 B
build/block-library/blocks/html/editor-rtl.css 281 B 0 B
build/block-library/blocks/html/editor.css 281 B 0 B
build/block-library/blocks/image/editor-rtl.css 717 B 0 B
build/block-library/blocks/image/editor.css 716 B 0 B
build/block-library/blocks/image/style-rtl.css 476 B 0 B
build/block-library/blocks/image/style.css 478 B 0 B
build/block-library/blocks/latest-comments/editor-rtl.css 159 B 0 B
build/block-library/blocks/latest-comments/editor.css 158 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 269 B 0 B
build/block-library/blocks/latest-comments/style.css 269 B 0 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B 0 B
build/block-library/blocks/latest-posts/editor.css 137 B 0 B
build/block-library/blocks/latest-posts/style-rtl.css 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/list/style-rtl.css 63 B 0 B
build/block-library/blocks/list/style.css 63 B 0 B
build/block-library/blocks/media-text/editor-rtl.css 191 B 0 B
build/block-library/blocks/media-text/editor.css 191 B 0 B
build/block-library/blocks/media-text/style-rtl.css 535 B 0 B
build/block-library/blocks/media-text/style.css 532 B 0 B
build/block-library/blocks/more/editor-rtl.css 434 B 0 B
build/block-library/blocks/more/editor.css 434 B 0 B
build/block-library/blocks/navigation-link/editor-rtl.css 626 B 0 B
build/block-library/blocks/navigation-link/editor.css 627 B 0 B
build/block-library/blocks/navigation/style-rtl.css 204 B 0 B
build/block-library/blocks/navigation/style.css 205 B 0 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B 0 B
build/block-library/blocks/nextpage/editor.css 395 B 0 B
build/block-library/blocks/page-list/editor-rtl.css 170 B 0 B
build/block-library/blocks/page-list/editor.css 170 B 0 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B 0 B
build/block-library/blocks/paragraph/editor.css 157 B 0 B
build/block-library/blocks/paragraph/style-rtl.css 247 B 0 B
build/block-library/blocks/paragraph/style.css 248 B 0 B
build/block-library/blocks/post-author/editor-rtl.css 209 B 0 B
build/block-library/blocks/post-author/editor.css 209 B 0 B
build/block-library/blocks/post-author/style-rtl.css 183 B 0 B
build/block-library/blocks/post-author/style.css 184 B 0 B
build/block-library/blocks/post-comments-form/style-rtl.css 250 B 0 B
build/block-library/blocks/post-comments-form/style.css 250 B 0 B
build/block-library/blocks/post-content/editor-rtl.css 139 B 0 B
build/block-library/blocks/post-content/editor.css 139 B 0 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B 0 B
build/block-library/blocks/post-excerpt/editor.css 73 B 0 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B 0 B
build/block-library/blocks/post-featured-image/editor.css 338 B 0 B
build/block-library/blocks/post-featured-image/style-rtl.css 100 B 0 B
build/block-library/blocks/post-featured-image/style.css 100 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 63 B 0 B
build/block-library/blocks/preformatted/style.css 63 B 0 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B 0 B
build/block-library/blocks/pullquote/editor.css 183 B 0 B
build/block-library/blocks/pullquote/style-rtl.css 318 B 0 B
build/block-library/blocks/pullquote/style.css 318 B 0 B
build/block-library/blocks/query-loop/style-rtl.css 315 B 0 B
build/block-library/blocks/query-loop/style.css 317 B 0 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B 0 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B 0 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B 0 B
build/block-library/blocks/query-pagination/editor.css 262 B 0 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B 0 B
build/block-library/blocks/query-pagination/style.css 168 B 0 B
build/block-library/blocks/query-title/editor-rtl.css 86 B 0 B
build/block-library/blocks/query-title/editor.css 86 B 0 B
build/block-library/blocks/quote/editor-rtl.css 61 B 0 B
build/block-library/blocks/quote/editor.css 61 B 0 B
build/block-library/blocks/quote/style-rtl.css 169 B 0 B
build/block-library/blocks/quote/style.css 169 B 0 B
build/block-library/blocks/rss/editor-rtl.css 201 B 0 B
build/block-library/blocks/rss/editor.css 202 B 0 B
build/block-library/blocks/rss/style-rtl.css 290 B 0 B
build/block-library/blocks/rss/style.css 290 B 0 B
build/block-library/blocks/search/editor-rtl.css 165 B 0 B
build/block-library/blocks/search/editor.css 165 B 0 B
build/block-library/blocks/search/style-rtl.css 342 B 0 B
build/block-library/blocks/search/style.css 344 B 0 B
build/block-library/blocks/separator/editor-rtl.css 99 B 0 B
build/block-library/blocks/separator/editor.css 99 B 0 B
build/block-library/blocks/separator/style-rtl.css 236 B 0 B
build/block-library/blocks/separator/style.css 236 B 0 B
build/block-library/blocks/shortcode/editor-rtl.css 512 B 0 B
build/block-library/blocks/shortcode/editor.css 512 B 0 B
build/block-library/blocks/site-logo/editor-rtl.css 201 B 0 B
build/block-library/blocks/site-logo/editor.css 201 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 115 B 0 B
build/block-library/blocks/site-logo/style.css 115 B 0 B
build/block-library/blocks/social-link/editor-rtl.css 164 B 0 B
build/block-library/blocks/social-link/editor.css 165 B 0 B
build/block-library/blocks/social-links/editor-rtl.css 776 B 0 B
build/block-library/blocks/social-links/editor.css 776 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.32 kB 0 B
build/block-library/blocks/social-links/style.css 1.33 kB 0 B
build/block-library/blocks/spacer/editor-rtl.css 317 B 0 B
build/block-library/blocks/spacer/editor.css 317 B 0 B
build/block-library/blocks/spacer/style-rtl.css 48 B 0 B
build/block-library/blocks/spacer/style.css 48 B 0 B
build/block-library/blocks/table/editor-rtl.css 478 B 0 B
build/block-library/blocks/table/editor.css 478 B 0 B
build/block-library/blocks/table/style-rtl.css 402 B 0 B
build/block-library/blocks/table/style.css 402 B 0 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B 0 B
build/block-library/blocks/tag-cloud/editor.css 118 B 0 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B 0 B
build/block-library/blocks/tag-cloud/style.css 94 B 0 B
build/block-library/blocks/template-part/editor-rtl.css 552 B 0 B
build/block-library/blocks/template-part/editor.css 551 B 0 B
build/block-library/blocks/term-description/editor-rtl.css 90 B 0 B
build/block-library/blocks/term-description/editor.css 90 B 0 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B 0 B
build/block-library/blocks/text-columns/editor.css 95 B 0 B
build/block-library/blocks/text-columns/style-rtl.css 166 B 0 B
build/block-library/blocks/text-columns/style.css 166 B 0 B
build/block-library/blocks/verse/editor-rtl.css 50 B 0 B
build/block-library/blocks/verse/editor.css 50 B 0 B
build/block-library/blocks/verse/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/blocks/video/editor-rtl.css 504 B 0 B
build/block-library/blocks/video/editor.css 503 B 0 B
build/block-library/blocks/video/style-rtl.css 187 B 0 B
build/block-library/blocks/video/style.css 187 B 0 B
build/block-library/common-rtl.css 1.1 kB 0 B
build/block-library/common.css 1.1 kB 0 B
build/block-library/reset-rtl.css 374 B 0 B
build/block-library/reset.css 376 B 0 B
build/block-library/theme-rtl.css 700 B 0 B
build/block-library/theme.css 701 B 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/core-data/index.js 16.7 kB 0 B
build/deprecated/index.js 787 B 0 B
build/dom-ready/index.js 576 B 0 B
build/editor/style-rtl.css 3.9 kB 0 B
build/editor/style.css 3.9 kB 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/i18n/index.js 4.01 kB 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/notices/index.js 1.85 kB 0 B
build/nux/style-rtl.css 731 B 0 B
build/nux/style.css 727 B 0 B
build/priority-queue/index.js 791 B 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

@oandregal
Copy link
Member

Sharing here some testing instructions for this PR:

How to test:

  • Install and activate the TT1-blocks theme.
  • Set settings.defaults.border.customRadius to true in the theme.json of the TT1-blocks theme.
  • Add "__experimentalSkipSerialization": true as a new key-value pair within the __experimentalBorder block supports for the group block.

The expected result is that:

  • The UI control for border radius is shown.
  • Using the UI control still syncs the block attributes.
    • Use the radius control.
    • Open the code editor and verify that the block has the proper radius value as attribute: something along the lines of <!-- wp:group {"style":{"border":{"radius":29}}} -->
  • The block attribute for border is not serializade into markup (inline styles).

Copy link
Member

@oandregal oandregal left a comment

Choose a reason for hiding this comment

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

This is working properly with the fix at https://github.com/WordPress/gutenberg/pull/30035/files#r598898672

A good next step would be to use this new feature to add support for border via the hooks in the button block, which is using custom UI controls at the moment.

@ockham
Copy link
Contributor Author

ockham commented Mar 23, 2021

This is working properly with the fix at https://github.com/WordPress/gutenberg/pull/30035/files#r598898672

Thanks André! I've applied the fix, and verified that it yields the desired results.

A good next step would be to use this new feature to add support for border via the hooks in the button block, which is using custom UI controls at the moment.

I'll tackle that next 👍

@ockham ockham marked this pull request as ready for review March 23, 2021 20:16
@ockham ockham merged commit da9b4ae into trunk Mar 23, 2021
@ockham ockham deleted the add/block-supports-skip-serialization-for-border branch March 23, 2021 20:37
@github-actions github-actions bot added this to the Gutenberg 10.3 milestone Mar 23, 2021
@oandregal oandregal mentioned this pull request Mar 24, 2021
82 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants