List View: Account for text fields in shortcut handler #61583
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
added
[Type] Bug
Mamaduka
commented
May 10, 2024
Comment on lines
+185
to
+188
| // Retain the default behavior for text fields. | ||
| if ( isTextField( event.target ) ) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
@mcsf, @andrewserong, what do you think about this solution?
There was a problem hiding this comment.
I don't mind it, but for completeness' sake this is what my local branch looks like:
diff --git a/packages/block-editor/src/components/block-rename/modal.js b/packages/block-editor/src/components/block-rename/modal.js
index f3db0d6c362..0ca42aacad4 100644
--- a/packages/block-editor/src/components/block-rename/modal.js
+++ b/packages/block-editor/src/components/block-rename/modal.js
@@ -67,6 +67,11 @@ export default function BlockRenameModal( {
focusOnMount="firstContentElement"
aria={ { describedby: descriptionId } }
size="small"
+ onKeyDown={ function stopKeyPropagation( event ) {
+ if ( event.key === 'Backspace' || event.key === 'Delete' ) {
+ event.stopPropagation();
+ }
+ } }
>
<form
onSubmit={ ( e ) => {with the current draft commit message:
Naive fix, just to get the ball rolling.
The rationale here is that the Modal component is the boundary that
corresponds to the user's mental modal of "UI boundary". So intercept
key presses at that boundary, preventing those events from reaching
ListViewBlock (since #61130, where this bug was introduced), where they
will cause the current block to be deleted.
Both approaches probably carry some unknowns, I'll let you follow your intuition. :)
There was a problem hiding this comment.
I also considered fixing the issue locally for the "Rename" modal, but the same issue will affect other modals (e.g., "Create pattern") with text fields.
My thought was that consumers shouldn't care how list view handles shortcuts.
|
Size Change: +7 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
mcsf
approved these changes
May 10, 2024
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Mamaduka
commented
May 11, 2024
Comment on lines
-40
to
-42
| await editor.setPreferences( 'core', { | ||
| showListViewByDefault: true, | ||
| } ); |
There was a problem hiding this comment.
Just setting the preference doesn't open the list view. It needs a page refresh or manual trigger.
Mamaduka
commented
May 11, 2024
| name: 'core/group', | ||
| attributes: { content: 'First Paragraph' }, | ||
| } ); | ||
| await editor.insertBlock( { name: 'core/group' } ); |
There was a problem hiding this comment.
I decided to just insert a group block instead of converting it.
@getdave, do we need to test a nested block, or is it okay this way?
Mamaduka
commented
May 11, 2024
Comment on lines
-145
to
-148
| // Check the original block name to reflected in List View. | ||
| listView.getByRole( 'link', { | ||
| name: 'Group', | ||
| } ); |
There was a problem hiding this comment.
Just constructing a locator doesn't test anything, so the test never asserted values in the List View. This is fixed now.
Mamaduka
added
the
Backport to Gutenberg Minor Release
andrewserong
approved these changes
May 13, 2024
There was a problem hiding this comment.
Thanks for the ping! I agree that consumers shouldn't have to worry about the list view unexpectedly handling keyboard shortcuts, so checking that we're not in a text field does seem pretty good from that perspective.
In terms of the rename modal, would it be worth also including the change from @mcsf? Without it, if you tab over to either of the buttons within the modal and then press backspace, it'll also delete the block:
2024-05-13.13.47.46.mp4
Not a blocker to landing, though, if you want to get this fix in quickly, as it's a much less visible issue.
|
Thanks for the review, @andrewserong!
It's probably rare, but that would still fix an issue in the wrong place. I think we might want to ship a more general fix, though I'm not sure what for the moment. P.S. You can use shortcuts on canvas to delete a block, but it's much easier in the List View, with a single delete key. |
|
@mcsf, @andrewserong here's an alternative fix #61606. I only merged this one to have the fixed e2e test in place. |
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?
Fixes #61544.
PR fixes a bug when pressing Delete in modals opened from the List View was causing block deletion.
Todo
Why?
This fixes a regression introduced in #61130. The list view shortcut handler now captures events propagated from modals.
Testing Instructions
Testing Instructions for Keyboard
Same.