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

Fix widgets background when loading theme styles #32683

Merged
merged 15 commits into from
Jun 21, 2021

Conversation

tellthemachines
Copy link
Contributor

Description

WordPress/wordpress-develop#1369 fixes #26163. This PR updates the editor styles so whatever background color the theme sets is reflected in the editor, and changes the widget area border color so it's visible on a light background unless a dark background is set.

How has this been tested?

To test, build local environment with WordPress/wordpress-develop#1369, then apply these changes. Check that with Twenty Twenty One, the editor and the widget area backgrounds match the theme styles, and widget area borders are visible whether the background color is light or dark.

Screenshots

Types of changes

Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@github-actions
Copy link

github-actions bot commented Jun 15, 2021

Size Change: +1.57 kB (0%)

Total Size: 1.04 MB

Filename Size Change
build/api-fetch/index.min.js 2.44 kB +17 B (+1%)
build/block-directory/index.min.js 6.61 kB -1 B (0%)
build/block-editor/index.min.js 119 kB +50 B (0%)
build/block-library/index.min.js 145 kB +362 B (0%)
build/blocks/index.min.js 47.3 kB +77 B (0%)
build/components/index.min.js 180 kB +158 B (0%)
build/components/style-rtl.css 16.2 kB +8 B (0%)
build/components/style.css 16.2 kB +7 B (0%)
build/compose/index.min.js 10.2 kB -2 B (0%)
build/customize-widgets/index.min.js 9.98 kB +5 B (0%)
build/customize-widgets/style-rtl.css 1.45 kB +6 B (0%)
build/customize-widgets/style.css 1.45 kB +5 B (0%)
build/data-controls/index.min.js 829 B +1 B (0%)
build/deprecated/index.min.js 739 B +1 B (0%)
build/edit-navigation/index.min.js 14 kB -2 B (0%)
build/edit-post/index.min.js 58.6 kB +4 B (0%)
build/edit-post/style-rtl.css 7.05 kB +72 B (+1%)
build/edit-post/style.css 7.04 kB +70 B (+1%)
build/edit-site/index.min.js 26 kB +69 B (0%)
build/edit-widgets/index.min.js 16 kB +233 B (+1%)
build/edit-widgets/style-rtl.css 3.49 kB +44 B (+1%)
build/edit-widgets/style.css 3.5 kB +43 B (+1%)
build/editor/index.min.js 38.6 kB +279 B (+1%)
build/format-library/index.min.js 5.68 kB +3 B (0%)
build/i18n/index.min.js 3.73 kB +1 B (0%)
build/nux/index.min.js 2.31 kB +1 B (0%)
build/plugins/index.min.js 1.99 kB -3 B (0%)
build/reusable-blocks/index.min.js 2.56 kB +1 B (0%)
build/server-side-render/index.min.js 1.64 kB +5 B (0%)
build/widgets/style-rtl.css 722 B +29 B (+4%)
build/widgets/style.css 722 B +29 B (+4%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.min.js 1.12 kB 0 B
build/annotations/index.min.js 2.93 kB 0 B
build/autop/index.min.js 2.28 kB 0 B
build/blob/index.min.js 672 B 0 B
build/block-directory/style-rtl.css 989 B 0 B
build/block-directory/style.css 990 B 0 B
build/block-editor/style-rtl.css 13.5 kB 0 B
build/block-editor/style.css 13.5 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/archives/style-rtl.css 65 B 0 B
build/block-library/blocks/archives/style.css 65 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/audio/theme-rtl.css 125 B 0 B
build/block-library/blocks/audio/theme.css 125 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 603 B 0 B
build/block-library/blocks/button/style.css 602 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 375 B 0 B
build/block-library/blocks/buttons/style.css 375 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/code/theme-rtl.css 131 B 0 B
build/block-library/blocks/code/theme.css 131 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 422 B 0 B
build/block-library/blocks/columns/style.css 422 B 0 B
build/block-library/blocks/cover/editor-rtl.css 644 B 0 B
build/block-library/blocks/cover/editor.css 646 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.22 kB 0 B
build/block-library/blocks/cover/style.css 1.23 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/embed/theme-rtl.css 124 B 0 B
build/block-library/blocks/embed/theme.css 124 B 0 B
build/block-library/blocks/file/editor-rtl.css 301 B 0 B
build/block-library/blocks/file/editor.css 300 B 0 B
build/block-library/blocks/file/frontend.min.js 773 B 0 B
build/block-library/blocks/file/style-rtl.css 255 B 0 B
build/block-library/blocks/file/style.css 255 B 0 B
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB 0 B
build/block-library/blocks/freeform/editor.css 2.44 kB 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.06 kB 0 B
build/block-library/blocks/gallery/style.css 1.06 kB 0 B
build/block-library/blocks/gallery/theme-rtl.css 122 B 0 B
build/block-library/blocks/gallery/theme.css 122 B 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/group/theme-rtl.css 93 B 0 B
build/block-library/blocks/group/theme.css 93 B 0 B
build/block-library/blocks/heading/editor-rtl.css 152 B 0 B
build/block-library/blocks/heading/editor.css 152 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/home-link/style-rtl.css 259 B 0 B
build/block-library/blocks/home-link/style.css 259 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 729 B 0 B
build/block-library/blocks/image/editor.css 727 B 0 B
build/block-library/blocks/image/style-rtl.css 481 B 0 B
build/block-library/blocks/image/style.css 485 B 0 B
build/block-library/blocks/image/theme-rtl.css 124 B 0 B
build/block-library/blocks/image/theme.css 124 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 281 B 0 B
build/block-library/blocks/latest-comments/style.css 282 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 529 B 0 B
build/block-library/blocks/latest-posts/style.css 529 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 176 B 0 B
build/block-library/blocks/media-text/editor.css 176 B 0 B
build/block-library/blocks/media-text/style-rtl.css 492 B 0 B
build/block-library/blocks/media-text/style.css 489 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 633 B 0 B
build/block-library/blocks/navigation-link/editor.css 634 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 94 B 0 B
build/block-library/blocks/navigation-link/style.css 94 B 0 B
build/block-library/blocks/navigation/editor-rtl.css 1.55 kB 0 B
build/block-library/blocks/navigation/editor.css 1.55 kB 0 B
build/block-library/blocks/navigation/frontend.min.js 2.86 kB 0 B
build/block-library/blocks/navigation/style-rtl.css 1.63 kB 0 B
build/block-library/blocks/navigation/style.css 1.63 kB 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 310 B 0 B
build/block-library/blocks/page-list/editor.css 311 B 0 B
build/block-library/blocks/page-list/style-rtl.css 240 B 0 B
build/block-library/blocks/page-list/style.css 240 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 140 B 0 B
build/block-library/blocks/post-comments-form/style.css 140 B 0 B
build/block-library/blocks/post-comments/style-rtl.css 360 B 0 B
build/block-library/blocks/post-comments/style.css 359 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-excerpt/style-rtl.css 69 B 0 B
build/block-library/blocks/post-excerpt/style.css 69 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 141 B 0 B
build/block-library/blocks/post-featured-image/style.css 141 B 0 B
build/block-library/blocks/post-template/editor-rtl.css 100 B 0 B
build/block-library/blocks/post-template/editor.css 99 B 0 B
build/block-library/blocks/post-template/style-rtl.css 379 B 0 B
build/block-library/blocks/post-template/style.css 380 B 0 B
build/block-library/blocks/post-title/style-rtl.css 60 B 0 B
build/block-library/blocks/post-title/style.css 60 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 103 B 0 B
build/block-library/blocks/preformatted/style.css 103 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/pullquote/theme-rtl.css 169 B 0 B
build/block-library/blocks/pullquote/theme.css 169 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/query/editor-rtl.css 131 B 0 B
build/block-library/blocks/query/editor.css 132 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/quote/theme-rtl.css 221 B 0 B
build/block-library/blocks/quote/theme.css 221 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 211 B 0 B
build/block-library/blocks/search/editor.css 211 B 0 B
build/block-library/blocks/search/style-rtl.css 359 B 0 B
build/block-library/blocks/search/style.css 362 B 0 B
build/block-library/blocks/search/theme-rtl.css 64 B 0 B
build/block-library/blocks/search/theme.css 64 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 251 B 0 B
build/block-library/blocks/separator/style.css 251 B 0 B
build/block-library/blocks/separator/theme-rtl.css 172 B 0 B
build/block-library/blocks/separator/theme.css 172 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 440 B 0 B
build/block-library/blocks/site-logo/editor.css 441 B 0 B
build/block-library/blocks/site-logo/style-rtl.css 154 B 0 B
build/block-library/blocks/site-logo/style.css 154 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 800 B 0 B
build/block-library/blocks/social-links/editor.css 799 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.34 kB 0 B
build/block-library/blocks/social-links/style.css 1.34 kB 0 B
build/block-library/blocks/spacer/editor-rtl.css 308 B 0 B
build/block-library/blocks/spacer/editor.css 308 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 480 B 0 B
build/block-library/blocks/table/style.css 480 B 0 B
build/block-library/blocks/table/theme-rtl.css 188 B 0 B
build/block-library/blocks/table/theme.css 188 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 551 B 0 B
build/block-library/blocks/template-part/editor.css 550 B 0 B
build/block-library/blocks/template-part/theme-rtl.css 101 B 0 B
build/block-library/blocks/template-part/theme.css 101 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/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 569 B 0 B
build/block-library/blocks/video/editor.css 570 B 0 B
build/block-library/blocks/video/style-rtl.css 173 B 0 B
build/block-library/blocks/video/style.css 173 B 0 B
build/block-library/blocks/video/theme-rtl.css 124 B 0 B
build/block-library/blocks/video/theme.css 124 B 0 B
build/block-library/common-rtl.css 1.26 kB 0 B
build/block-library/common.css 1.26 kB 0 B
build/block-library/editor-rtl.css 9.68 kB 0 B
build/block-library/editor.css 9.67 kB 0 B
build/block-library/reset-rtl.css 506 B 0 B
build/block-library/reset.css 507 B 0 B
build/block-library/style-rtl.css 10.2 kB 0 B
build/block-library/style.css 10.2 kB 0 B
build/block-library/theme-rtl.css 692 B 0 B
build/block-library/theme.css 693 B 0 B
build/block-serialization-default-parser/index.min.js 1.3 kB 0 B
build/block-serialization-spec-parser/index.min.js 3.06 kB 0 B
build/core-data/index.min.js 12.2 kB 0 B
build/data/index.min.js 7.22 kB 0 B
build/date/index.min.js 31.8 kB 0 B
build/dom-ready/index.min.js 576 B 0 B
build/dom/index.min.js 4.62 kB 0 B
build/edit-navigation/style-rtl.css 3.08 kB 0 B
build/edit-navigation/style.css 3.08 kB 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/edit-site/style-rtl.css 4.75 kB 0 B
build/edit-site/style.css 4.75 kB 0 B
build/editor/style-rtl.css 3.91 kB 0 B
build/editor/style.css 3.9 kB 0 B
build/element/index.min.js 3.44 kB 0 B
build/escape-html/index.min.js 739 B 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/hooks/index.min.js 1.76 kB 0 B
build/html-entities/index.min.js 628 B 0 B
build/is-shallow-equal/index.min.js 709 B 0 B
build/keyboard-shortcuts/index.min.js 1.74 kB 0 B
build/keycodes/index.min.js 1.43 kB 0 B
build/list-reusable-blocks/index.min.js 2.07 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/media-utils/index.min.js 3.08 kB 0 B
build/notices/index.min.js 1.07 kB 0 B
build/nux/style-rtl.css 718 B 0 B
build/nux/style.css 716 B 0 B
build/primitives/index.min.js 1.03 kB 0 B
build/priority-queue/index.min.js 791 B 0 B
build/react-i18n/index.min.js 924 B 0 B
build/redux-routine/index.min.js 2.82 kB 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/rich-text/index.min.js 10.6 kB 0 B
build/shortcode/index.min.js 1.68 kB 0 B
build/token-list/index.min.js 847 B 0 B
build/url/index.min.js 1.95 kB 0 B
build/viewport/index.min.js 1.28 kB 0 B
build/warning/index.min.js 1.13 kB 0 B
build/widgets/index.min.js 6.48 kB 0 B
build/wordcount/index.min.js 1.24 kB 0 B

compressed-size-action

@noisysocks
Copy link
Member

Nice work! This looks totally feasible.

I checked out this PR alongside WordPress/wordpress-develop#1369 and here's how things looked using Twenty Twenty-one:

Screen Shot 2021-06-16 at 10 18 42

Some notes:

  1. The space outside of the widget areas shouldn't receive the theme's background colour as this is part of the editor's chrome and not somewhere that the user can add or edit content. Can we get it looking like this mockup?

    Screen Shot 2021-06-16 at 10 25 58
  2. The Legacy Widget block's preview always has a white background. Is it possible to address or mitigate this? We're limited by the fact that it uses an <iframe>.

  3. Can we add an "Enable theme styles" option to the Preferences here?

    Screen Shot 2021-06-16 at 10 29 24

@noisysocks noisysocks added the [Feature] Widgets Screen The block-based screen that replaced widgets.php. label Jun 16, 2021
@noisysocks noisysocks added the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jun 16, 2021
@tellthemachines
Copy link
Contributor Author

The space outside of the widget areas shouldn't receive the theme's background colour as this is part of the editor's chrome and not somewhere that the user can add or edit content. Can we get it looking like this mockup?

I don't think we can, unless I'm missing something. Themes add their background colours to the body, which in the editor gets translated as editor-styles-wrapper, and in order to have that background colour in the widget areas all the elements between have to have a transparent background.

The Legacy Widget block's preview always has a white background. Is it possible to address or mitigate this? We're limited by the fact that it uses an <iframe>.

Done! The culprit was in the Legacy Widget block boilerplate.

Can we add an "Enable theme styles" option to the Preferences here?

On by default, like in the post editor?

@noisysocks
Copy link
Member

I don't think we can, unless I'm missing something. Themes add their background colours to the body, which in the editor gets translated as editor-styles-wrapper, and in order to have that background colour in the widget areas all the elements between have to have a transparent background.

Can we move editor-styles-wrapper so that it is within the widget area?

On by default, like in the post editor?

I'm not sure. Stepping back, I think there's two possible scenarios for what we can do in 5.8 and we should do some testing and pick the scenario that has the best UX:

  • We do not ship editor styles for the widgets editor (or have it off by default), we address Core-53388 by implementing better default block styling for e.g. the Latest Posts and Recent Comments blocks, and we address Core-53327 by e.g. patching Twenty Twenty.
  • We ship editor styles for the widgets editor which automatically addresses Core-53388 and Core-53327, and we implement better block styling for e.g. the Latest Posts and Recent Comments blocks as this is what users will see in the Customizer and with "Use theme styles" turned off.

@tellthemachines
Copy link
Contributor Author

Can we move editor-styles-wrapper so that it is within the widget area?

Thanks! Not sure if moving it will have any ill effect, but adding the same class to each widget area works. It should be fixed now, but my local env is playing up and I can't make sure.

I'm inclined to shipping theme styles on by default as the best UX solution, based on the issues raised about it.

implementing better default block styling for e.g. the Latest Posts and Recent Comments blocks

This would affect the post editor too, right? Would be good to have some design input on it. In any case, if theme styles are on by default it won't be such an issue.

@noisysocks
Copy link
Member

implementing better default block styling for e.g. the Latest Posts and Recent Comments blocks

This would affect the post editor too, right? Would be good to have some design input on it. In any case, if theme styles are on by default it won't be such an issue.

Correct. I opened a separate issue for it: #32718

@critterverse
Copy link
Contributor

critterverse commented Jun 16, 2021

To test, build local environment with WordPress/wordpress-develop#1369, then apply these changes.

@tellthemachines could you provide further setup instructions here? I don't believe I'm set up to test this as described 😅

A quick video/screenshots would also be super helpful if possible!! Would be good to see: widget areas full/empty, open/closed, a widget resting/selected, some common flows like adding and selecting a legacy widget from the dropdown.

Can we add an "Enable theme styles" option to the Preferences here?

Related: #32569 (comment) and #32711

@noisysocks
Copy link
Member

Here's a video:

Kapture.2021-06-17.at.11.33.40.mp4

Overall I think it looks really good! My testing notes:

  1. When you collapse all of the areas there's some white background behind the grey background.

  2. Legacy Widget block's preview iframe still has a white background.

  3. Legacy Widget block's placeholder text is serif and truncated. (I think this an existing issue, but would be good to fix.)

  4. In Twenty Twenty and Twenty Nineteen (and probably others), the widget area's panel title is being styled.

@tellthemachines
Copy link
Contributor Author

tellthemachines commented Jun 17, 2021

When you collapse all of the areas there's some white background behind the grey background.

This is fixed now!

Legacy Widget block's preview iframe still has a white background.

I removed the hardcoded background colour from the Legacy Widget block, but I think that change needs to be backported to core before we can test it. I tried changing it manually in my local env and it worked ok.

Legacy Widget block's placeholder text is serif and truncated. (I think this an existing issue, but would be good to fix.)
In Twenty Twenty and Twenty Nineteen (and probably others), the widget area's panel title is being styled.

Yeah, the truncation in Twenty Twenty One is more obvious than in other themes (we can fix it with an override for the theme styles) but I can't repro the serif font locally 😕
There are different styles bleeding from different themes. I'll go through and fix whatever I can find for the default themes, but there's always potential for a theme to break something.

@noisysocks
Copy link
Member

This is how it looks for me now. The title of each widget area has some bleeding issues.

Screen Shot 2021-06-17 at 14 11 10

@tellthemachines
Copy link
Contributor Author

The title of each widget area has some bleeding issues.

If you mean the space around the heading, I've just pushed a fix.

@noisysocks
Copy link
Member

Hm. I still see some padding issues with the area header, now in Twenty Twenty.

Screen Shot 2021-06-18 at 11 03 10

I think that we're fighting a losing battle against CSS bleed issues in the Widget Area block. How about we remove the top level .editor-styles-wrapper div and have each Widget Area provide .editor-styles-wrapper? This makes sense in my mind as there is never any style-able content outside of the Widget Area panel body.

I've pushed up d2fd4f4 which does exactly that. It seems to work but admittedly I haven't tested it very thoroughly. Let me know what you think and feel free to remove the commit if it's no good.

@critterverse
Copy link
Contributor

Nice, thanks for the video @noisysocks ✌️

I removed the hardcoded background colour from the Legacy Widget block, but I think that change needs to be backported to core before we can test it. I tried changing it manually in my local env and it worked ok.

This is probably the main thing that I would want to be sure we can get resolved. Plus some of the issues @noisysocks mentioned with the extra spacing in the header area, but it sounds like those might be fixed with the latest commit.

Another thing that caught my eye was that it looks like the width of the center column changes in width when switching the "Use theme styles" preference on and off (looks wider when the styling is off).

Thanks for working on this @tellthemachines!

@tellthemachines
Copy link
Contributor Author

@critterverse the Legacy Widget block preview is fixed, but this PR will have to be backported to Core before we can see the changes take effect.

Another thing that caught my eye was that it looks like the width of the center column changes in width when switching the "Use theme styles" preference on and off (looks wider when the styling is off).

Is this the whole widget areas, or just the blocks inside them? I notice some padding diffs on some of the themes, but that's due to theme styling (doesn't happen on all of them). If it was the widget areas themselves though, I can't see that with the latest changes so it should be fixed.

Copy link
Member

@noisysocks noisysocks left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@tellthemachines tellthemachines merged commit 1c01f3c into trunk Jun 21, 2021
@tellthemachines tellthemachines deleted the fix/widgets-background branch June 21, 2021 03:33
@github-actions github-actions bot added this to the Gutenberg 11.0 milestone Jun 21, 2021
@youknowriad youknowriad removed the Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Jun 21, 2021
youknowriad pushed a commit that referenced this pull request Jun 21, 2021
* Fix widgets background when loading theme styles

* Adjust for dark background colors.

* Fix heading hover styles

* Fix theme styles in legacy widget preview

* Remove theme colour from editor background

* Remove border styling as not needed anymore

* Add toggle and fix background styles

* Fix padding issue

* Add back interface background color

* Fix legacy widget select padding

* Fix theme style bleed

* Fix space around widget area heading

* Move .editor-styles-wrapper to the widget area

* Create temp canvas only if no canvas exists; inserter fix

* Add theme styles for older versions of WP

Co-authored-by: Robert Anderson <robert@noisysocks.com>
youknowriad pushed a commit that referenced this pull request Jun 21, 2021
* Fix widgets background when loading theme styles

* Adjust for dark background colors.

* Fix heading hover styles

* Fix theme styles in legacy widget preview

* Remove theme colour from editor background

* Remove border styling as not needed anymore

* Add toggle and fix background styles

* Fix padding issue

* Add back interface background color

* Fix legacy widget select padding

* Fix theme style bleed

* Fix space around widget area heading

* Move .editor-styles-wrapper to the widget area

* Create temp canvas only if no canvas exists; inserter fix

* Add theme styles for older versions of WP

Co-authored-by: Robert Anderson <robert@noisysocks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Widgets Screen The block-based screen that replaced widgets.php.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Render widgets in the editor with the same style as in the theme
4 participants