Iframe: event bubbling should retain the original target #55105
Closed
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
|
Size Change: +17 B (0%) Total Size: 1.65 MB
ℹ️ View Unchanged
|
ellatrix
reviewed
Oct 6, 2023
| // inadvertantly (like global shortcuts when typing within inputs...) | ||
| Object.defineProperty( newEvent, 'target', { | ||
| writable: false, | ||
| value: event.target, |
There was a problem hiding this comment.
I guess that makes sense, the React events also have the original target
There was a problem hiding this comment.
But it doesn't work unfortunately. It breaks shortcuts like the "duplicate block" one and I'm not sure how to fix.
There was a problem hiding this comment.
I think we should re-explore the provider tbh, and avoid this bubbling entirely.
There was a problem hiding this comment.
I agree that there's something to be reconsidered here but I don't know yet what the solution is. I think a provider like we used to have is a hack. It relies on React event bubbling working but not DOM events) which means we won't be able to have global shortcuts).
I'm thinking maybe we could have a special provider wrapping the iframe body content, but I'm not entirely sure how that would work.
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?
In #54080 we changed how we capture keyboard shortcuts and in doing so we added keydown events bubbling to the editor iframe component.
One side effect I noticed was that in "playground" in storybook, when typing in the editor, typed characters conflicted with Storybook shortcuts. The weird thing is that even if there were no iframe used (so events are still bubbling on the same window), the conflicts didn't happen. So the issue was in the way we generated the "virtual" events in the iframe component (since in both with or without iframe, the event was propagated to the parent of the editor).
After multiple checks and attempts, it seems that copying the "target" property (which is supposed to be readonly) when creating the synthetic event is what was triggering the conflict. Some event handlers ignore events from inputs/contenteditable...
Let's see if the e2e tests of Gutenberg confirm the fix or not.
Testing Instructions
1- Run storybook locally
npm run storybook:dev2- Open one of the playground stories
3- Type "s" within the editor, the Storybook sidebar shouldn't be toggling.