Fix caret jumping to wrong position when decorations restructure DOM #5987#6033
Open
dannelundqvist wants to merge 4 commits intoianstormtaylor:mainfrom
Open
Fix caret jumping to wrong position when decorations restructure DOM #5987#6033dannelundqvist wants to merge 4 commits intoianstormtaylor:mainfrom
dannelundqvist wants to merge 4 commits intoianstormtaylor:mainfrom
Conversation
…hat the selection restoration layout effect runs after the decoration-induced DOM changes are committed. Without this, text components re-render and restructure the DOM in a separate pass where Editable's layout effect never fires, leaving the caret at a wrong position.
🦋 Changeset detectedLatest commit: 072cd7b 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 |
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
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.
Description
When decorate changes asynchronously, the caret jumps to the wrong position.
Root cause: Text components re-render in a separate React commit from Editable. When decorations restructure the DOM, Editable's selection-restoration useLayoutEffect has already run and never re-fires, leaving the browser selection pointing at a stale node.
A forceUpdate() in useDecorateContext forces Editable to re-render in the same commit as the Text components, so the layout effect runs after the updated DOM is in place.
Example and integration test added: Decorations Async — an editor where duplicate words are highlighted 600 ms after each edit, demonstrating that the caret stays put when the async decoration update fires.
Closes #5987
Checks
yarn test.yarn lint. (Fix errors withyarn fix.)yarn start.)yarn changeset add.)