Try: add content flag to blocks with no content attributes #68162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ramonjd
added
[Type] Experimental
ramonjd
commented
Dec 20, 2024
packages/blocks/src/api/utils.js
Outdated
| const attributes = getBlockType( name )?.attributes; | ||
| const blockType = getBlockType( name ); | ||
|
|
||
| if ( blockType?.[ blockMetadataDisplayKey ]?.role === 'content' ) { |
There was a problem hiding this comment.
This is the special sauce.
There are probably other scenarios where this key needs to be checked as well.
|
Size Change: +209 B (+0.01%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 31cdc45. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12425564615
|
|
So this only is useful to show the block in the list view and have it selectable right? It won't help with actually editing? |
Determining what the block does as a content block/in write mode would still have to be figured out, mostly likely at the block level |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This is an experiment only. Do not commit. It's for discussion and exploration only.
Testing a private block setting to flag to the block editor environment that the block should be treated, and display, as a content block for the purposes of write mode.
Why?
Properties of certain blocks such as the Query block should be editable in write mode. These blocks, however, don't always have attributes with content roles.
A content flag ensures these blocks will always be treated as containing "content" despite their attributes.
Kapture.2024-12-20.at.14.42.14.mp4
How?
Via the
blocks.registerBlockTypefilter, adding a private Symbol to a block settings.The side-effect is that iterating over these settings during registration and in the reducer needs to ensure Symbols are not filtered out.
Testing Instructions
I've conducted very limited testing.
I created a template with two Query blocks: one at the root level, and another nested in a Group block.
When switching to Write mode, the Query blocks should selectable and feature in the list view.