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

BoxControl: Allow configurable sides #30606

Merged
merged 6 commits into from
Apr 19, 2021

Conversation

aaronrobertshaw
Copy link
Contributor

@aaronrobertshaw aaronrobertshaw commented Apr 8, 2021

Description

  • Update BoxControl to allow configurable sides
  • Fix error thrown when BoxControl attempts to check modifier key on drag gestures
  • Fix BoxControl reset button when used from Global Styles sidebar

This allows for the BoxControl component to accept a new sides prop allowing omission of specific sides. For example, with this you could now choose to only allow editing of top and bottom values.

This was originally part of #29363 where it was used to manage top/bottom margins on the separator block. It has been extracted into this PR for finer granularity.

How has this been tested?

Manually.

Test Instructions

The easiest method to test this updated BoxControl will be to test #30607.

That PR is based upon this one and through checking it out and testing it, this updated BoxControl will also be tested.

Screenshots

Linked Unlinked
Screen Shot 2021-04-08 at 6 54 50 pm Screen Shot 2021-04-08 at 6 54 38 pm

Types of changes

New feature.

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).

@aaronrobertshaw aaronrobertshaw added [Type] Enhancement A suggestion for improvement. [Feature] Design Tools Tools that impact the appearance of blocks both to expand the number of tools and improve the experi labels Apr 8, 2021
@aaronrobertshaw aaronrobertshaw self-assigned this Apr 8, 2021
@github-actions
Copy link

github-actions bot commented Apr 8, 2021

Size Change: +42.7 kB (+3%)

Total Size: 1.46 MB

Filename Size Change
build/annotations/index.js 3.78 kB +3 B (0%)
build/api-fetch/index.js 3.41 kB +2 B (0%)
build/autop/index.js 2.81 kB -1 B (0%)
build/block-editor/index.js 129 kB +2.25 kB (+2%)
build/block-editor/style-rtl.css 12.5 kB +117 B (+1%)
build/block-editor/style.css 12.5 kB +116 B (+1%)
build/block-library/blocks/buttons/style-rtl.css 368 B +4 B (+1%)
build/block-library/blocks/buttons/style.css 368 B +5 B (+1%)
build/block-library/blocks/cover/style-rtl.css 1.23 kB -11 B (-1%)
build/block-library/blocks/cover/style.css 1.23 kB -12 B (-1%)
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB -6 B (0%)
build/block-library/blocks/freeform/editor.css 2.44 kB -6 B (0%)
build/block-library/blocks/gallery/style-rtl.css 1.09 kB -14 B (-1%)
build/block-library/blocks/gallery/style.css 1.09 kB -15 B (-1%)
build/block-library/blocks/navigation/editor-rtl.css 1.24 kB +3 B (0%)
build/block-library/blocks/navigation/editor.css 1.24 kB +3 B (0%)
build/block-library/blocks/navigation/style-rtl.css 272 B +68 B (+33%) 🚨
build/block-library/blocks/navigation/style.css 271 B +66 B (+32%) 🚨
build/block-library/blocks/page-list/editor-rtl.css 239 B +69 B (+41%) 🚨
build/block-library/blocks/page-list/editor.css 240 B +70 B (+41%) 🚨
build/block-library/blocks/query/editor-rtl.css 810 B +15 B (+2%)
build/block-library/blocks/query/editor.css 809 B +15 B (+2%)
build/block-library/blocks/site-logo/editor-rtl.css 440 B +2 B (0%)
build/block-library/blocks/site-logo/editor.css 441 B +3 B (+1%)
build/block-library/blocks/site-logo/style-rtl.css 154 B +4 B (+3%)
build/block-library/blocks/site-logo/style.css 154 B +4 B (+3%)
build/block-library/blocks/social-links/editor-rtl.css 796 B +20 B (+3%)
build/block-library/blocks/social-links/editor.css 795 B +19 B (+2%)
build/block-library/blocks/verse/editor-rtl.css 0 B -50 B (removed) 🏆
build/block-library/blocks/verse/editor.css 0 B -50 B (removed) 🏆
build/block-library/blocks/video/editor-rtl.css 568 B +64 B (+13%) ⚠️
build/block-library/blocks/video/editor.css 569 B +66 B (+13%) ⚠️
build/block-library/blocks/video/style-rtl.css 173 B -14 B (-7%)
build/block-library/blocks/video/style.css 173 B -14 B (-7%)
build/block-library/editor-rtl.css 9.79 kB +54 B (+1%)
build/block-library/editor.css 9.78 kB +55 B (+1%)
build/block-library/index.js 153 kB +1.12 kB (+1%)
build/block-library/style-rtl.css 9.43 kB +28 B (0%)
build/block-library/style.css 9.44 kB +28 B (0%)
build/blocks/index.js 48.5 kB +86 B (0%)
build/components/index.js 286 kB +2.3 kB (+1%)
build/components/style-rtl.css 16.3 kB +6 B (0%)
build/components/style.css 16.3 kB +6 B (0%)
build/compose/index.js 11.3 kB +13 B (0%)
build/core-data/index.js 17.1 kB +48 B (0%)
build/customize-widgets/index.js 8.01 kB +920 B (+13%) ⚠️
build/data-controls/index.js 837 B +1 B (0%)
build/data/index.js 8.87 kB -7 B (0%)
build/date/index.js 31.9 kB +1 B (0%)
build/dom-ready/index.js 576 B -1 B (0%)
build/dom/index.js 5.1 kB -58 B (-1%)
build/edit-navigation/index.js 17 kB -3 B (0%)
build/edit-navigation/style-rtl.css 2.86 kB -4 B (0%)
build/edit-navigation/style.css 2.86 kB -5 B (0%)
build/edit-post/index.js 339 kB +32.4 kB (+11%) ⚠️
build/edit-post/style-rtl.css 6.99 kB +78 B (+1%)
build/edit-post/style.css 6.98 kB +80 B (+1%)
build/edit-site/index.js 28.7 kB +655 B (+2%)
build/edit-site/style-rtl.css 4.9 kB +285 B (+6%) 🔍
build/edit-site/style.css 4.89 kB +281 B (+6%) 🔍
build/edit-widgets/index.js 16.7 kB +1.01 kB (+6%) 🔍
build/edit-widgets/style-rtl.css 2.97 kB -4 B (0%)
build/edit-widgets/style.css 2.98 kB -4 B (0%)
build/editor/index.js 42.6 kB +489 B (+1%)
build/editor/style-rtl.css 3.92 kB -3 B (0%)
build/editor/style.css 3.92 kB -3 B (0%)
build/element/index.js 4.61 kB -2 B (0%)
build/format-library/index.js 6.75 kB -3 B (0%)
build/hooks/index.js 2.28 kB -1 B (0%)
build/html-entities/index.js 623 B +1 B (0%)
build/i18n/index.js 4.04 kB +31 B (+1%)
build/keyboard-shortcuts/index.js 2.52 kB -4 B (0%)
build/keycodes/index.js 1.95 kB -1 B (0%)
build/list-reusable-blocks/index.js 3.19 kB -1 B (0%)
build/media-utils/index.js 5.38 kB +1 B (0%)
build/notices/index.js 1.85 kB +1 B (0%)
build/plugins/index.js 2.95 kB +2 B (0%)
build/primitives/index.js 1.42 kB -1 B (0%)
build/react-i18n/index.js 1.45 kB -1 B (0%)
build/redux-routine/index.js 2.83 kB -2 B (0%)
build/rich-text/index.js 13.5 kB -1 B (0%)
build/token-list/index.js 1.27 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/blob/index.js 664 B 0 B
build/block-directory/index.js 8.62 kB 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 503 B 0 B
build/block-library/blocks/button/style.css 503 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/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 436 B 0 B
build/block-library/blocks/columns/style.css 435 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/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/editor-rtl.css 175 B 0 B
build/block-library/blocks/file/editor.css 174 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/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/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 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/legacy-widget/editor-rtl.css 398 B 0 B
build/block-library/blocks/legacy-widget/editor.css 399 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 597 B 0 B
build/block-library/blocks/navigation-link/editor.css 597 B 0 B
build/block-library/blocks/navigation-link/style-rtl.css 1.07 kB 0 B
build/block-library/blocks/navigation-link/style.css 1.07 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/style-rtl.css 167 B 0 B
build/block-library/blocks/page-list/style.css 167 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-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 100 B 0 B
build/block-library/blocks/post-featured-image/style.css 100 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/query-loop/editor-rtl.css 83 B 0 B
build/block-library/blocks/query-loop/editor.css 82 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/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 189 B 0 B
build/block-library/blocks/search/editor.css 189 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/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/shortcode/editor-rtl.css 512 B 0 B
build/block-library/blocks/shortcode/editor.css 512 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/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 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 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/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/common-rtl.css 1.31 kB 0 B
build/block-library/common.css 1.31 kB 0 B
build/block-library/reset-rtl.css 502 B 0 B
build/block-library/reset.css 503 B 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.js 1.87 kB 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/customize-widgets/style-rtl.css 630 B 0 B
build/customize-widgets/style.css 631 B 0 B
build/deprecated/index.js 787 B 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 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/is-shallow-equal/index.js 699 B 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/nux/index.js 3.41 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/index.js 3.78 kB 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/server-side-render/index.js 2.6 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/url/index.js 3.02 kB 0 B
build/viewport/index.js 1.86 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

This looking good overall, just wondering whether an array prop is better.

Thanks for extracting this. Potentially we could consider adding a storybook story with an example of that.

packages/components/src/box-control/index.js Outdated Show resolved Hide resolved
packages/components/src/box-control/input-controls.js Outdated Show resolved Hide resolved
@aaronrobertshaw
Copy link
Contributor Author

Thanks for the quick feedback @youknowriad!

I can definitely look to switch to an array prop. I'll make some time tomorrow to make these updates and address any other feedback.

Appreciate your assistance on this 👍

Copy link
Contributor

@youknowriad youknowriad 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 looking good.

Maybe we can consider this

Thanks for extracting this. Potentially we could consider adding a storybook story with an example of that.

Also, some thing I've been thinking about: what happens when you pass 0 or 1 side:

  • Should we ignore the prop when sides is an empty array? (make it work like undefined)
  • Should we not render the "toggle" to switch between merged state and unmerged state when there's only one side?

@aaronrobertshaw
Copy link
Contributor Author

Also, some thing I've been thinking about: what happens when you pass 0 or 1 side:

  • Should we ignore the prop when sides is an empty array? (make it work like undefined)
  • Should we not render the "toggle" to switch between merged state and unmerged state when there's only one side?

They sound like some good improvements. I'll make it happen.

@aaronrobertshaw
Copy link
Contributor Author

The BoxControl will now treat an empty array the same as undefined. If there is only one side selected in the config, the BoxControl will not display the "unlink" button.

Thanks for extracting this. Potentially we could consider adding a storybook story with an example of that.

Would the story be acceptable as a separate PR? It's not something I've looked at before but it would be good to take some time and update it with examples of the new features.

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

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

This looks good to me. Thanks for the iterations.

And yeah a separate PR for the story would be good.

@youknowriad youknowriad merged commit be7ae06 into trunk Apr 19, 2021
@youknowriad youknowriad deleted the update/boxcontrol-with-configurable-sides branch April 19, 2021 11:02
@github-actions github-actions bot added this to the Gutenberg 10.5 milestone Apr 19, 2021
@aaronrobertshaw
Copy link
Contributor Author

Storybook updates can be found in #31029

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Design Tools Tools that impact the appearance of blocks both to expand the number of tools and improve the experi [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants