Update useSyntheticChange to only call execCommand if input is focused
#3562
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
🦋 Changeset detectedLatest commit: 210a6ac The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
joshblack
approved these changes
Jul 25, 2023
This was referenced Jul 26, 2023
Merged
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.
useSyntheticChangepowers all updates to theMarkdownEditortextarea under the hood. Using this hook instead of directly updating the input value allows us to preserve the caret position and browser undo stack. However, it usesexecCommandwhich has all sorts of gotchas since it essentially just simulates the user typing in the input. This means the input needs to be focused, which is fine because it usually is when you are editing Markdown.When uploading a file, the delay between interaction and update may be significant. In this case, the user might have started working on something else. For example, they might have opened a dialog which activated a focus trap. Then we can't pull focus into the editor, so we can't use
execCommandto update the input.Currently in this case we still call
execCommand, unexpectedly updating whatever input is focused instead. This is obviously not great since it means we may insert file URLs into random spots. So instead, this PR updated the hook to ensure the input is focused before trying to callexecCommand. If not, it falls back to the already-available fallback method of directly updating the input.Closes #3548
Merge checklist
[ ] Added/updated testsexecCommandis not available in JSDom so we always use the fallback method in the test suite anyway.[ ] Added/updated documentationTake a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.