Inspector Controls: Stabilize the experimental control groups #47105
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
aaronrobertshaw
added
[Type] Enhancement
aaronrobertshaw
requested review from
michalczaplinski,
tellthemachines and
ajitbohra
as code owners
|
Size Change: +48 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 8b5d693. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4003564357
|
Mamaduka
reviewed
Jan 12, 2023
There was a problem hiding this comment.
It would be a good idea to make this change backward compatible. Custom blocks are probably using __experimentalGroup at least for advanced controls.
Here's a quick directory search: https://wpdirectory.net/search/01GPJHG378MPCAKYVJPK1AY3JF
Definitely. I'll finish off working on this tomorrow. |
aaronrobertshaw
force-pushed
the
update/stabilize-inspector-control-groups
branch
2 times, most recently
from
36a63c0
to
3d6a919
Compare
|
@aaronrobertshaw and @Mamaduka just want to confirm inspector control tabs are intended for inclusion in 6.2? If so, I am going to add this to the 6.2 project board for consideration because I think this PR is likely a prerequisite for the tabs being included. |
@ndiego That's the plan. The block inspector tabs are required for the off-canvas editor for the navigation block, so this will be needed as well. I'm out of the office until Monday but it's top of my list to push along then. |
aaronrobertshaw
force-pushed
the
update/stabilize-inspector-control-groups
branch
from
3d6a919
to
f2186d5
Compare
talldan
reviewed
Jan 25, 2023
talldan
approved these changes
Jan 25, 2023
There was a problem hiding this comment.
LGTM, only left a minor comment about the deprecation message.
I'm not sure what tests are in place for this feature currently, but it might be good to add some (maybe in another PR), especially for the new 'styles' slot which is unused in core. Usually for that it would involve e2e tests that make use of test plugins. The plugin could provide a custom block implementation that uses all the inspector control groups.
|
@aaronrobertshaw this looks great! We can get this in 15.1, right? cc @bph @femkreations regarding documentation. This is a pretty big change that block plugin developers will need to account for in prepping their plugins for 6.2. |
bph
added
the
Needs Dev Note
|
Thanks for the the ping, @ndiego - I added the "needs dev note" label to surface this for the release documentation. |
aaronrobertshaw
force-pushed
the
update/stabilize-inspector-control-groups
branch
from
1e35a1f
to
a36fbf0
Compare
|
Agreed, these changes need a dev note. Should it be on its own or part of a wider "stabilized APIs" dev note? If grouped with other stabilized APIs, a section detailing this PR's changes could be: __experimentalGroupThe In addition to stabilizing the <InspectorControls group="styles">
// Add your custom styles related controls here.
</InspectorControls> |
|
My feeling is that the dev note might be best as part of the one for the block settings tabs, as the features are so closely related. |
|
Noting for developers that I already created an issue around sharing this explicitly on the developer blog: WordPress/developer-blog-content#57 |
femkreations
added
Needs User Documentation
youknowriad
reviewed
Nov 9, 2023
| '`__experimentalGroup` property in `InspectorControlsFill`', | ||
| { | ||
| since: '6.2', | ||
| version: '6.4', |
There was a problem hiding this comment.
Should we follow-up on these deprecations as we've reached the target version.
There was a problem hiding this comment.
PR is up removing the deprecations and old experimental prop here: #56023
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.
Related:
What?
__experimentalGroupprop for the inspector control slot fills.stylesinspector controls groupdefaultgroup assettingsWhy?
With the stabilization of the Block Inspector tabs, which paves the way for the off-canvas navigation editor, it makes sense to stabilize the inspector control groups. Without this, we'll end up with a situation where plugins use the experimental API more because of the lack of a stable API.
How?
__experimentalprefix from the Inspector Control SlotFills' group propsstylesinspector controls group slot and adds it to the styles block inspector tabdefaultgroup assettings. Allows block to explicitly assign a control tosettingswhich would render where thedefaultgroup does now.Testing Instructions
Check there are no further references to
__experimentalGroupEdit a post containing various blocks, select each of them ensuring the appropriate panels display within the Block Inspector tabs
Override the display of Block Inspector tabs and confirm appropriate group slots still render correctly
Click for quick and dirty patch to update block editor setting to test disabling tab display across blocks
diff --git a/packages/block-library/src/navigation-link/index.php b/packages/block-library/src/navigation-link/index.php index f214a6b9b5..db113f7289 100644 --- a/packages/block-library/src/navigation-link/index.php +++ b/packages/block-library/src/navigation-link/index.php @@ -396,7 +396,7 @@ function gutenberg_disable_tabs_for_navigation_link_block( $settings ) { $settings['blockInspectorTabs'] = array_merge( $current_tab_settings, - array( 'core/navigation-link' => false ) + array( 'core/navigation-link' => false, 'default' => false ) ); return $settings;Check blocks that cover each of the block supports below and ensure their controls still render
Check the controls for the following blocks appear
Check the advanced controls are correct for Template Part
Test adding a control to a block via the
stylesgroup. Ensure adding such a control causes the styles tab to display if a block would otherwise not show the tab.Test assigning a control to the
settingsgroup and ensure it still gets rendered into the Settings tab.Example diff adding a control via styles and settings groups