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 Controls: add None option for text decoration #31768

Closed
wants to merge 2 commits into from

Conversation

creativecoder
Copy link
Contributor

@creativecoder creativecoder commented May 12, 2021

Description

  • Adds a default option for text decoration, for when there's no block specific setting and text decoration is inherited by global styles
  • Sets a block specific text-decoration: none when all toggles are turned off

This option is needed for overriding styles that a theme sets for a block.

Uses a new icon, as suggested here. Figma link

How has this been tested?

  • With a block based theme (e.g. TT1 Blocks) activated, visit the site editor
  • Select the Navigation block (top level) and open the block settings in the sidebar
  • See that you can set the text decoration options for the block

To test overriding a theme, insert block settings in the theme.json of your theme, which will default an underline style to the navigation:

{
  "styles": {
    "blocks": {
      "core/navigation": {
        "typography": {
          "textDecoration": "underline"
        }
      }
    }
  }
}

Screenshots

image

Types of changes

New feature (non-breaking change which adds functionality)

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

@creativecoder creativecoder added [Package] Block editor /packages/block-editor [Package] Icons /packages/icons labels May 12, 2021
@creativecoder creativecoder requested a review from ellatrix as a code owner May 12, 2021 17:21
@@ -123,6 +123,7 @@ export { default as moreHorizontalMobile } from './library/more-horizontal-mobil
export { default as moreVertical } from './library/more-vertical';
export { default as moveTo } from './library/move-to';
export { default as navigation } from './library/navigation';
export { default as none } from './library/none';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alternatively this could be named for the icon form, rather than it's purpose, e.g. shortDash. Any recommendations @jasmussen @jameskoster?

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the same icon we're using the the solid border style? cc @aaronrobertshaw :D

This could be seen as an antonym to the "Add" icon (+). So perhaps "Remove", "Subtract", "Minus" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I took the remove icon from Icons / Editor (it's called minus in the icons package) and shortened it from 12 px to 8 px. The minus icon seemed a little wide to me, as is.

Here's a figma link.

@github-actions
Copy link

github-actions bot commented May 12, 2021

Size Change: -17.9 kB (-1%)

Total Size: 1.3 MB

Filename Size Change
build/a11y/index.js 1.12 kB +1 B (0%)
build/annotations/index.js 2.93 kB -3 B (0%)
build/api-fetch/index.js 2.42 kB +1 B (0%)
build/blob/index.js 673 B +1 B (0%)
build/block-directory/index.js 6.61 kB +15 B (0%)
build/block-editor/index.js 118 kB +927 B (+1%)
build/block-library/blocks/file/frontend.js 771 B -1 B (0%)
build/block-library/index.js 146 kB +3.04 kB (+2%)
build/block-serialization-default-parser/index.js 1.3 kB -1 B (0%)
build/block-serialization-spec-parser/index.js 3.06 kB -1 B (0%)
build/blocks/index.js 47.1 kB +46 B (0%)
build/components/index.js 188 kB +66 B (0%)
build/components/style-rtl.css 16.2 kB +8 B (0%)
build/components/style.css 16.2 kB +9 B (0%)
build/compose/index.js 9.92 kB -2 B (0%)
build/core-data/index.js 12.1 kB +7 B (0%)
build/customize-widgets/index.js 5.98 kB -10 B (0%)
build/data-controls/index.js 828 B -1 B (0%)
build/date/index.js 31.8 kB -1 B (0%)
build/deprecated/index.js 739 B +2 B (0%)
build/dom-ready/index.js 577 B +1 B (0%)
build/dom/index.js 4.62 kB -6 B (0%)
build/edit-navigation/index.js 13.6 kB +85 B (+1%)
build/edit-post/index.js 334 kB +204 B (0%)
build/edit-site/index.js 26 kB -82 B (0%)
build/edit-widgets/index.js 12.5 kB -101 B (-1%)
build/editor/index.js 38.4 kB -22.1 kB (-36%) 🎉
build/element/index.js 3.44 kB -1 B (0%)
build/format-library/index.js 5.67 kB -4 B (0%)
build/hooks/index.js 1.76 kB -1 B (0%)
build/html-entities/index.js 627 B -1 B (0%)
build/i18n/index.js 3.73 kB -2 B (0%)
build/keycodes/index.js 1.43 kB -1 B (0%)
build/nux/index.js 2.31 kB +6 B (0%)
build/plugins/index.js 1.99 kB -13 B (-1%)
build/primitives/index.js 1.03 kB -1 B (0%)
build/react-i18n/index.js 923 B -1 B (0%)
build/redux-routine/index.js 2.82 kB -3 B (0%)
build/reusable-blocks/index.js 2.54 kB -26 B (-1%)
build/rich-text/index.js 10.7 kB +26 B (0%)
build/server-side-render/index.js 1.64 kB -2 B (0%)
build/shortcode/index.js 1.68 kB -1 B (0%)
build/token-list/index.js 846 B -2 B (0%)
build/viewport/index.js 1.28 kB +2 B (0%)
build/widgets/index.js 1.66 kB -20 B (-1%)
build/wordcount/index.js 1.24 kB +3 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/autop/index.js 2.28 kB 0 B
build/block-directory/style-rtl.css 993 B 0 B
build/block-directory/style.css 995 B 0 B
build/block-editor/style-rtl.css 13 kB 0 B
build/block-editor/style.css 13 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 601 B 0 B
build/block-library/blocks/button/style.css 600 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/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 643 B 0 B
build/block-library/blocks/cover/editor.css 645 B 0 B
build/block-library/blocks/cover/style-rtl.css 1.22 kB 0 B
build/block-library/blocks/cover/style.css 1.22 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/editor-rtl.css 301 B 0 B
build/block-library/blocks/file/editor.css 300 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.45 kB 0 B
build/block-library/blocks/freeform/editor.css 2.45 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.05 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/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 717 B 0 B
build/block-library/blocks/image/editor.css 716 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/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 557 B 0 B
build/block-library/blocks/legacy-widget/editor.css 557 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 617 B 0 B
build/block-library/blocks/navigation-link/editor.css 619 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.52 kB 0 B
build/block-library/blocks/navigation/editor.css 1.52 kB 0 B
build/block-library/blocks/navigation/style-rtl.css 1.71 kB 0 B
build/block-library/blocks/navigation/style.css 1.71 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 239 B 0 B
build/block-library/blocks/page-list/editor.css 240 B 0 B
build/block-library/blocks/page-list/style-rtl.css 204 B 0 B
build/block-library/blocks/page-list/style.css 204 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 119 B 0 B
build/block-library/blocks/post-featured-image/style.css 119 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/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/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/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 796 B 0 B
build/block-library/blocks/social-links/editor.css 795 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 485 B 0 B
build/block-library/blocks/table/style.css 485 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/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 169 B 0 B
build/block-library/blocks/video/style.css 169 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.84 kB 0 B
build/block-library/editor.css 9.83 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.1 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/customize-widgets/style-rtl.css 698 B 0 B
build/customize-widgets/style.css 699 B 0 B
build/data/index.js 7.23 kB 0 B
build/edit-navigation/style-rtl.css 2.83 kB 0 B
build/edit-navigation/style.css 2.83 kB 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/edit-post/style-rtl.css 6.79 kB 0 B
build/edit-post/style.css 6.78 kB 0 B
build/edit-site/style-rtl.css 4.79 kB 0 B
build/edit-site/style.css 4.78 kB 0 B
build/edit-widgets/style-rtl.css 3.02 kB 0 B
build/edit-widgets/style.css 3.03 kB 0 B
build/editor/style-rtl.css 3.95 kB 0 B
build/editor/style.css 3.95 kB 0 B
build/escape-html/index.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/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 1.65 kB 0 B
build/list-reusable-blocks/index.js 2.06 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.js 3.08 kB 0 B
build/navigation/index.js 2.85 kB 0 B
build/notices/index.js 1.07 kB 0 B
build/nux/style-rtl.css 718 B 0 B
build/nux/style.css 716 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/url/index.js 1.95 kB 0 B
build/warning/index.js 1.13 kB 0 B

compressed-size-action

@oandregal oandregal requested a review from aaronrobertshaw May 13, 2021 06:16
@jasmussen
Copy link
Contributor

Thanks for your work. The key problem, to reiterate, is to allow a design control to untoggle a style applied by a theme.

This is different from a default, which it is in Figma. In Figma, "none" is toggled until you choose one of the other options. In this implementation, none of the controls would be enabled by default — the "none" option is one you toggle when you discover that the theme has applied an underline to a heading, title, link or something else, and you want something else.

I surface this as it's pretty key to getting the interface, as well as the user interface right. And it adds some followup questions:

  • What is the right icon? Minus works in context of Figma where it also means "unset". I'm not sure it's actually as succesful here when it won't be toggled by default.
  • Is there an opportunity to revisit this "overriding" behavior? Could the toggles be aware of what a theme.json might have set already, and be toggled to match what's set there?

The feature itself makes sense to me, even from a usability or accessibility viewpoint, because it gives control to the user over themes that might be inaccessible:

  • A theme might use an underline on a block post title that isn't a link, and untoggling the underline will be more clear.
  • A theme might use a link style that doesn't have underlines, and toggling underlines on will make them distinct.

So I'm mostly thinking in terms of a good design for this.

@jameskoster
Copy link
Contributor

untoggle a style applied by a theme

I'm curious about how all this works under the hood. Obviously there are two ways to "untoggle a style" with css:

  1. Override the property (with none in this case)
  2. Remove the declaration altogether

Option one is a blunt instrument, but can be required in some cases. Option two is cleaner, but leaves the block open to the css cascade which could have unpredictable results (e.g. removing the text-decoration control, but the text remains underlined).

In order to accomodate end users who want to over-ride a theme setting, and themers who want to build clean themes in the site editor, don't we need to allow for both?

If that's the case, then having none as a default when you add a control like text-decoration seems reasonable? Otherwise it's possible to add the control without specifying a value which seems a bit strange to me.

On reflection I think the dash actually works well as an icon because it caters to both scenarios:

  • If I am over-riding a theme defined style, it looks like a minus (IE remove)
  • If I've added a new control, it resembles an undefined value (IE none)

@jasmussen
Copy link
Contributor

If that's the case, then having none as a default when you add a control like text-decoration seems reasonable? Otherwise it's possible to add the control without specifying a value which seems a bit strange to me.

I understand the use case, it seems valid. I think the primary challenge I have especially with comparing to figma is that due to the cascade we don't necessarily have a default, where Figma does. I say we don't necessarily have a default, because I'm unsure whether the Global Styles system can help there:

  1. We can't know, and we can't have a default. You might have non-underlined text, and toggling the "none" button has zero visible effect.
  2. We CAN know, because in theme.json the text decoration is defined in a way that can be picked up by the control. In this case, we can have the "none" toggled if nothing is set there.

2 I like, but don't think we can do (but hope to be corrected). One, especially the "no visible effect" is the one that has me pause.

@jameskoster
Copy link
Contributor

You might have non-underlined text, and toggling the "none" button has zero visible effect.

Ah, I understand the (my) confusion now...

I'm working on the assumption that the buttons behave like a segmented control. IE one of them must be selected, and it is not possible to toggle them all off, or toggle combinations on. The value is either none, linethrough, or underline.

If that's not the case then I agree, having a none button that can be toggled on/off doesn't make sense.

So I suppose it's a question of whether we want to allow combinations of decorations. Should it be possible to apply both linethrough and underline? 🤔 If so, how far do we take it... there is overline and text-decoration-style (dotted, dashed, or wavy lines) to consider as well.

@jasmussen
Copy link
Contributor

So I suppose it's a question of whether we want to allow combinations of decorations. Should it be possible to apply both linethrough and underline? 🤔 If so, how far do we take it... there is overline and text-decoration-style (dotted, dashed, or wavy lines) to consider as well.

With vanilla CSS (using purely text-decoration) it maps pretty well to a segmented control because you can only have one, not multiple. To emulate multiple you'd have to use box-shadow, which would be prone to theme line-height and font size/appearance issues. So the segmented control seems fine.

To me the question mostly boils down to: are we able to know from theme.json whether a particular block has none, underline or strikethrough applied? If not, then we're left with that weird gray area where you can toggle "none" on a block that already has none.

@jameskoster
Copy link
Contributor

jameskoster commented May 14, 2021

you can only have one

I thought so too, but TIL: https://www.w3schools.com/cssref/tryit.asp?filename=trycss_text-decoration2 🙈

we're left with that weird gray area where you can toggle "none" on a block that already has none.

I don't think that's quite right. You're actually specifying none as an override of the default (inherit). In the vast majority of cases you are correct – the result will be the same. But if by chance the selected block has underlined text due to the cascade – and you don't want it to – you add the decoration control and set it to none to remove it. So I think having "none" as the default value when you add the control may be ok.

I made a quick figma prototype to test how this feels as a segmented control.

@jasmussen
Copy link
Contributor

I thought so too, but TIL: https://www.w3schools.com/cssref/tryit.asp?filename=trycss_text-decoration2 🙈

Whoah brain explosion! That's ... awesome?

But if by chance the selected block has underlined text due to the cascade – and you don't want it to – you add the decoration control and set it to none to remove it. So I think having "none" as the default value when you add the control may be ok.

Right, there's nuance. I also agree that the use case seems valid enough, it's nice for a user to be able to remove an underline on a theme they otherwise love.

It may be worth bringing up an inconvenient truth: so long as CSS is allowed, themes can write CSS that our controls can't touch. For example this one:

html > body h2.wp-block-post-title.wp-block-post-title.wp-block-post-title.wp-block-post-title.wp-block-post-title {
	text-decoration: underline !important;
}

That's a deliberately extreme example. But it's an example of a CSS rule that would almost always win, even if you explicitly pressed a "none" button in the UI.

And that brings me back to the theme.json file potentially being the driver of this; that if we tie the control, including the state of "none", to whatever is defined in that file, we can have not only (I think?) a default toggled, but probably a more resilient and predictable behavior too. So I guess this is a bit of a question for @nosolosw or @jorgefilipecosta:

are we able to know from theme.json whether a particular block has none, underline or strikethrough applied? And if yes, can we leverage that to show one of the controls toggled?

@creativecoder
Copy link
Contributor Author

And that brings me back to the theme.json file potentially being the driver of this; that if we tie the control, including the state of "none", to whatever is defined in that file, we can have not only (I think?) a default toggled, but probably a more resilient and predictable behavior too. So I guess this is a bit of a question for @nosolosw or @jorgefilipecosta:

are we able to know from theme.json whether a particular block has none, underline or strikethrough applied? And if yes, can we leverage that to show one of the controls toggled?

I did some investigation on this yesterday. The theme.json sets global styles. I don't see a way to access global style settings from within the block typography components the way things are structured now. The global styles context and provider are contained within the edit-site package and not accessible from block-editor. But I think the global styles provider could be extracted into a different (or it's own) package, or provide a data store, to make this possible.

Note that

  • Global styles are output on the page in a dynamically created "internal" stylesheet and block specific styles applies to all instances of a block.
  • Block settings are output as inline styles within the block and are saved as block attributes so they're unique to each block instance.

Regarding the UI these are really great points: the main confusion seems to be differentiating between the "default" state set by global styles and inherited by the block, from a "none" setting for the block that overrides global styles. Maybe that could be represented like this

Default (inherit from global styles)

Screen Shot 2021-05-14 at 15 24 15

None (block setting of text-decoration: none)

image

I pushed an update to the branch that works this way.

This brings the toggles close to how the dropdown settings work, with a "default" setting at the top, but also allows you to unset that default. I'm not sure if it's better than a 4 way segmented control where one option must be selected 🤔.

@oandregal
Copy link
Member

oandregal commented May 18, 2021

are we able to know from theme.json whether a particular block has none, underline or strikethrough applied? And if yes, can we leverage that to show one of the controls toggled?

Yes. We have useSetting for this. So far, blocks (and UI hooks) have used this to get the color palette, for example. Or whether something is enabled (should this control be visible or not?).

@creativecoder
Copy link
Contributor Author

Looks like this was taken care of in #44067

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Block editor /packages/block-editor [Package] Icons /packages/icons
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants