Proposal: Internal block attributes #49457
Closed
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
|
Size Change: +338 B (0%) Total Size: 1.34 MB
ℹ️ View Unchanged
|
gziolo
added
[Feature] Block API
|
I wanted to re-share my comment #49391 (comment) where I expressed my sympathy towards this PR:
|
gziolo
added
the
[Type] Technical Prototype
|
It's also an alternative approach to #34750 where @stacimc proposed extending the "attributes": {
"_blobURL": {
"type": "string",
"__experimentalRole": "internal"
}
}How do you feel about using In effect, this PR could potentially close #29693. |
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 & why
This PR is an alternative approach to #49391 and experiments with adding the concept of internal attributes to the block API.
Internal attributes behave like regular attributes except that they are:
post_contentand do not appear inserialize( block ).The motivation for this is to fix a longstanding issue we've had in Gutenberg which is that we use attributes to store "internal" state in certain blocks. For example an undo level is created when dragging-and-dropping an image or file into the editor because the blob URL is stored in the
urlattribute while the file is uploaded. I've included a fix for the File block (61ad707) to illustrate how this can be fixed using an internal_blobURLattribute.I've also included fixes for two other issues to illustrate that there are many uses for such an API:
__internalWidgetIdattribute in favour of an explicit_widgetIdinternal attribute.__internalWidgetIdis how the widget editor tracks which widget entity should be updated when a block is modified. It's a hack that works because__internalWidgetIddoes not appear in theblock.jsonand so is filtered out byserialize(). Using an internal attribute works exactly the same but is more explicit._classicMenuIdattribute. See Widget Importer: ensure it works with importing menus #47285.The downside of this is that implementation details appear for all to see in
block.json.