Blocks: Add supports lock flag #39568
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
Mamaduka
requested review from
ellatrix,
ajitbohra,
mkaz,
ryanwelcher and
juanmaguitar
as code owners
Mamaduka
added
[Feature] Blocks
Mamaduka
commented
Mar 18, 2022
| * @return {boolean} Whether a given block type can be locked/unlocked. | ||
| */ | ||
| export function canLockBlockType( state, nameOrType ) { | ||
| if ( ! hasBlockSupport( nameOrType, 'lock', true ) ) { |
There was a problem hiding this comment.
I went with a simple name for the flag, but happy to change it if necessary.
There was a problem hiding this comment.
One of the confusing aspects about this is that supporting lock here might means two things:
- A block can be locked and unlocked (via attributes and UI).
- The UI to change locking is disabled.
I know that all blocks support locking, and this support flag is just for the UI, it feels a bit confusing but lockUI doesn't look as clean.
There was a problem hiding this comment.
I agree; the support flag name doesn't really represent what the setting might do.
Maybe we should use __experimentalLock while thinking about the permanent name.
@mtias What do you think?
There was a problem hiding this comment.
I think it's okay to go with lock as long as documentation explains what this flag does.
There was a problem hiding this comment.
Let's add it as experimental for a release or two but aim at formalizing it before 6.0 is released.
|
Size Change: +1.25 kB (0%) Total Size: 1.21 MB
ℹ️ View Unchanged
|
senadir
approved these changes
Mar 24, 2022
| * @return {boolean} Whether a given block type can be locked/unlocked. | ||
| */ | ||
| export function canLockBlockType( state, nameOrType ) { | ||
| if ( ! hasBlockSupport( nameOrType, 'lock', true ) ) { |
There was a problem hiding this comment.
One of the confusing aspects about this is that supporting lock here might means two things:
- A block can be locked and unlocked (via attributes and UI).
- The UI to change locking is disabled.
I know that all blocks support locking, and this support flag is just for the UI, it feels a bit confusing but lockUI doesn't look as clean.
Do you mean missing documentation for this support flag? |
Mamaduka
force-pushed
the
add/block-lock-support-flag
branch
from
d935529 to
98abe7d
Compare
|
Yes, it was unclear to me what flag I should add until I digged into the code. |
|
Sorry about that. I included documentation now. |
|
@Mamaduka In a comment on the other issue, you suggested being able to base the lock on user capabilities. How would that be done using this approach? |
|
Hi, @carlomanf This will be a new block-level control. You can find general block lock settings PR here - #39566. |
draganescu
pushed a commit
that referenced
this pull request
Mar 30, 2022
Add documentation Make flag experimental Author: George Mamadashvili <[email protected]> Date: Mon Mar 28 18:01:27 2022 +0400
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?
Part of #29864.
Introduces new blocks
supports.__experimentalLockflag.Why?
A new support flag will allow disabling locking UI on the block type level.
How?
PR adds a new
canLockBlockTypeselector that checks block type supports flag and fallbacks to block editor settings.Todos
Testing Instructions
"__experimentalLock": false.