Add prop to disable block selection clearer in BlockList#44517
Merged
Add prop to disable block selection clearer in BlockList#44517
Conversation
|
Size Change: +89 B (0%) Total Size: 1.27 MB
ℹ️ View Unchanged
|
talldan
reviewed
Sep 28, 2022
Contributor
talldan
left a comment
talldan
left a comment
There was a problem hiding this comment.
This kind of change does always pose a maintenance issue. There's nothing to stop this setting becoming accidentally broken because it's unused in first-party code. I would suggest adding tests, though it may be challenging to test this kind of thing.
It's also hard to know whether an editor with this setting might have some weird side effects, either now or in the future.
In terms of the API, I think it might be better exposed as an editor setting to avoid adding extra props to BlockList. Something along the lines of clearBlockSelection: false (and it would have a true default).
It could also be made an __experimental setting to start with until there has been more chance to test it. That means there's more of an option to remove the setting if you change your mind.
packages/block-editor/src/components/block-selection-clearer/index.js
Outdated
Show resolved
Hide resolved
talldan
added
[Type] Enhancement
joshuatf
force-pushed
the
update/block-selection-clearer-event
branch
from
bc76f22 to
be68c99
Compare
8 tasks
Contributor
Author
|
Thanks for the feedback, @talldan!
While this is true, this is a relatively straightforward disabling of an event that (as far as I can tell) tends to be more specific to handling of deselection around iframes. There weren't any tests around block selection clearing yet, and not a ton around
Great idea! Also prefixed this with |
Contributor
Author
|
Hi @talldan could you take another look at this when you have time? |
Contributor
Author
|
Hi @talldan do you have time to take another look at this PR? |
2 tasks
talldan
approved these changes
Oct 18, 2022
Contributor
talldan
left a comment
talldan
left a comment
There was a problem hiding this comment.
Sorry for the delays reviewing. This looks good now, thanks for addressing the feedback!
14 tasks
This was referenced Jan 31, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 adds a prop to allow disabling of the block selection clearing.
I'm open to other ways of handling this, but this seems like the most minimal and non-invasive way to handle this without affecting existing editors.
Fixes #44508
Why?
This can be useful for consumers wanting to use the block editor who don't necessarily want to deselect block elements and lose the contextual toolbar when editing.
In WooCommerce, we're working on a rich text editor which should always show a toolbar. Currently this isn't always possible due to deselection:
How?
Testing Instructions
disableBlockSelectionClearerprop:Screenshots or screencast