[create-block] Refinements to the create-block-interactive-template package. #52801
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
ryanwelcher
added
[Type] Enhancement
|
Size Change: +499 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
luisherranz
approved these changes
Jul 20, 2023
| * @see https://github.com/WordPress/gutenberg/blob/trunk/docs/reference-guides/block-api/block-metadata.md#render | ||
| */ | ||
|
|
||
| $unique_id = uniqid( 'p-' ); | ||
| ?> | ||
|
|
||
| <div | ||
| <?php echo get_block_wrapper_attributes(); ?> | ||
| <?php echo wp_kses_data( get_block_wrapper_attributes() ); ?> |
There was a problem hiding this comment.
Are you sure this is needed? I've never seen it before, and none of the Core blocks seems to do it.
There was a problem hiding this comment.
There is some differing opinions on this. WPCS is trigger because all echo statements need to be escaped. That being said, I see that the default template in create-block is not using it. So I'll remove it for consistency.
Comment on lines
18
to
24
| customBlockJSON: { | ||
| example: { | ||
| attributes: { | ||
| message: 'Example Interactive', | ||
| }, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
So, out of curiosity, what is this example thing teaching the developer? How to add attributes?
There was a problem hiding this comment.
The example property allows a preview of the block in the inserter.
With the property defined:
Without:
There was a problem hiding this comment.
This does beg the question of the point of that inner attributes property. I don't think it's actually being used...
There was a problem hiding this comment.
Looks like by just having example defined, the preview appear. If we were actually using attributes, we'd need to add those as well. Change incoming.
There was a problem hiding this comment.
Ohhhh, nice.
I completely overlooked that example property until now 😄
|
I've moved the |
luisherranz
added
the
[Feature] Interactivity API
8 tasks
ryanwelcher
changed the title
|
Flaky tests detected in 5629261. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5645662304
|
ryanwelcher
deleted the
fix/create-block-interactivity-template-refinements
branch
10 tasks
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 PR introduces some refinements to the template files to have the
exampleproperty defined in theblock.jsonfile instead of theindex.jsand to add some late escaping to the render.php file.Why?
It is better to contain as much as possible in the block.json file, especially if there are translations involved as those strings are automatically translated. The escaping items trigger various WPCS rules and make for a better developer experience.
Testing Instructions
cdinto thepackages/create-block-interactive-template create-block-interactive-templatenpx @wordpress/create-block@latest my-first-interactive-block --template ./my-first-interactive-blockand runnpx @wp-now/wp-now start]