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

Encode the heading block as block variations of h1-h6 elements #22805

Closed
wants to merge 1 commit into from

Conversation

oandregal
Copy link
Member

@oandregal oandregal commented Jun 1, 2020

Related

Some blocks represent many HTML elements. Examples of this are the core/heading block (h1-h6) and the core/list block (ol, ul). The Block Style System needs to bind a block to a CSS selector. However, for these blocks, the selector they use depends on some other attribute values.

This PR explores whether the selector can be expressed as a field within a block variation in these cases.

@oandregal oandregal self-assigned this Jun 1, 2020
@github-actions
Copy link

github-actions bot commented Jun 1, 2020

Size Change: +95 B (0%)

Total Size: 1.11 MB

Filename Size Change
build/block-library/index.js 119 kB +95 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 3.4 kB 0 B
build/autop/index.js 2.83 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.48 kB 0 B
build/block-directory/style-rtl.css 787 B 0 B
build/block-directory/style.css 787 B 0 B
build/block-editor/index.js 106 kB 0 B
build/block-editor/style-rtl.css 11.3 kB 0 B
build/block-editor/style.css 11.3 kB 0 B
build/block-library/editor-rtl.css 7.61 kB 0 B
build/block-library/editor.css 7.61 kB 0 B
build/block-library/style-rtl.css 7.68 kB 0 B
build/block-library/style.css 7.68 kB 0 B
build/block-library/theme-rtl.css 684 B 0 B
build/block-library/theme.css 686 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.1 kB 0 B
build/components/index.js 190 kB 0 B
build/components/style-rtl.css 19.5 kB 0 B
build/components/style.css 19.5 kB 0 B
build/compose/index.js 9.32 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.43 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 771 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 3.11 kB 0 B
build/edit-navigation/index.js 7.88 kB 0 B
build/edit-navigation/style-rtl.css 857 B 0 B
build/edit-navigation/style.css 856 B 0 B
build/edit-post/index.js 302 kB 0 B
build/edit-post/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 kB 0 B
build/edit-site/index.js 14.1 kB 0 B
build/edit-site/style-rtl.css 2.96 kB 0 B
build/edit-site/style.css 2.96 kB 0 B
build/edit-widgets/index.js 8.88 kB 0 B
build/edit-widgets/style-rtl.css 2.4 kB 0 B
build/edit-widgets/style.css 2.4 kB 0 B
build/editor/editor-styles-rtl.css 425 B 0 B
build/editor/editor-styles.css 428 B 0 B
build/editor/index.js 44.6 kB 0 B
build/editor/style-rtl.css 4.26 kB 0 B
build/editor/style.css 4.27 kB 0 B
build/element/index.js 4.64 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.71 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 622 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.51 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 5.29 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 14.8 kB 0 B
build/server-side-render/index.js 2.68 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.02 kB 0 B
build/viewport/index.js 1.84 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

@ZebulanStanphill ZebulanStanphill added [Block] Heading Affects the Headings Block [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible labels Jun 2, 2020
@oandregal
Copy link
Member Author

oandregal commented Jun 2, 2020

I've been playing with the block variations API. Block variations are preset of block attributes. By design, there's no guarantee that two fields are in sync when the user makes changes (ex: changes a block from h2 to h3), that's not what the block variations API is about. Instead, it offers presets that can be exposed in two different contexts:

  • inserter: show the variations in the block inserter
  • block: show the variations when the block is added (this requires some hooking up by the block, see columns block)

This exploration was driven by the question: can block variations absorb the dynamic nature of the block selectors (blocks that represent multiple HTML elements)?

The answer seems to be that block selectors need a different thing: a mechanism to be synchronized with some other part of the block. In the case of core/heading, we want it to be synchronized with the level attribute: level is 1 => selector is h1, and so on. In the case of core/list, we want it to be synchronized with the ordered attribute: ordered is true => selector is ol, ordered is false => selector is ul.

I'll close this and will open a different PR to explore how to achieve that synchronization.

@oandregal oandregal closed this Jun 2, 2020
@oandregal oandregal deleted the try/heading-as-block-variations branch June 2, 2020 10:50
@oandregal
Copy link
Member Author

The above is not to say that blocks that represent many HTML elements won't benefit from block variations. Probably that's a worthy exploration anyway. What I'm saying is that the idea of "dynamic selectors" discussed at #22518 (comment) is orthogonal/independent from block variations.

Copy link
Member

@jorgefilipecosta jorgefilipecosta left a comment

Choose a reason for hiding this comment

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

Hi @nosolosw,

By design, there's no guarantee that two fields are in sync when the user makes changes (ex: changes a block from h2 to h3)

The variations provide an initial set of attributes. These attributes may later be changed, changing the variation.
I guess to use variations we would need a way to say if the current block attributes match a variation. The mechanism could be as simple as compare the attributes of the block and verify if all of them are still equal to the variation.
This also seems to be the same that we need for global styles.
If we added this mechanism to variations e.g: a function that given a variation and the current attributes a block says if the block matches the variation, would variations work for global styles selector matching?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Heading Affects the Headings Block [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants