Make useBlockEditingMode() public #52094
Merged
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
noisysocks
added
[Feature] Extensibility
noisysocks
requested review from
ellatrix,
tellthemachines,
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
Size Change: -88 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
noisysocks
force-pushed
the
update/make-useBlockEditingMode-public
branch
from
4cf09e9
to
5b1e455
Compare
noisysocks
added
[Type] New API
Mamaduka
requested changes
Jul 11, 2023
There was a problem hiding this comment.
The changes look good, and I couldn't spot any regression page content focus.
We'll need to audit the getBlockEditingMode and remove the unlock wrapper where unnecessary.
Here are a few examples:
- https://github.com/WordPress/gutenberg/blob/trunk/packages/block-editor/src/components/block-editing-mode/index.js#L52
- https://github.com/WordPress/gutenberg/blob/trunk/packages/block-editor/src/components/block-inspector/index.js#L38-L42
- https://github.com/WordPress/gutenberg/blob/trunk/packages/block-editor/src/components/block-list/block.js#L101-L105
There's more when you search the codebase.
|
All done @Mamaduka 👍 |
noisysocks
force-pushed
the
update/make-useBlockEditingMode-public
branch
from
6a4d00c
to
0f57c17
Compare
Mamaduka
approved these changes
Aug 9, 2023
There was a problem hiding this comment.
Thanks for the follow-up, @noisysocks!
The changes look good to me. I smoke-tested the page/template editing in the Site Editor.
noisysocks
force-pushed
the
update/make-useBlockEditingMode-public
branch
from
0f57c17
to
bc79a32
Compare
10 tasks
✍🏻 Dev noteNew public hook in the Block Editor API: useBlockEditingMode()Blocks can set an editing "mode" using the useBlockEditingMode hook.
The block editing mode can be one of three options:
The block editing mode is inherited by all of the block's inner blocks, unless inner blocks have their own modes set. Usage: function MyBlock( { attributes, setAttributes } ) {
useBlockEditingMode( 'disabled' );
// MyBlock will be marked as 'disabled' editing mode.
return <ChildComponent { ...useBlockProps() }></ChildComponent>;
}
function ChildComponent( props ) {
const blockEditingMode = useBlockEditingMode();
let text = 'Child component';
if ( blockEditingMode === 'disabled' ) {
// Block is disabled, add custom block properties to indicate disabled mode.
text+= ' is disabled!';
}
if ( blockEditingMode === 'default' ) {
// Block can be edited, show controls or other editing-related settings.
<MyBlockCustomControls />
}
return <div { ...props }>{ text }</div>;
} |
|
Why do extenders need this? |
I think to check the block editing mode and hide controls based on it. Some of the core blocks do the same. |
|
I can't help but feel these API weren't ready to be public. And now we'll have to support them forever. Why should a block be able to disable itself through |
|
Yeah. We probably rushed making this public :/ Here's one example in the core that uses |
|
@ellatrix I cannot speak to if this was rushed or not. But I can speak to why we need it. Id you are building a custom block that should work and expose a subset of controls inside a Yeah there is the never official way of adding |
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?
Makes
useBlockEditingMode()(see #50643) public so that extenders can use it. The accompanying selector (getBlockEditingMode) and actions (setBlockEditingMode,unsetBlockEditingMode) are also made public.Why?
A few folks have reached out to me asking for this as they'd like to use it in their plugins.
The only reason it's private is because I want the API to have time in the Gutenberg plugin where we can iterate on it before we merge it to Core and have to maintain backwards compatibility forever. WP 6.3 was too near when the API was added. By making this public now the API will be available for use by extenders in the next Gutenberg plugin release and then in WP 6.4.
Testing Instructions
Nothing specific. Check for regressions to the Page Content Focus functionality.