fix: only treat editor as collaborative when awareness is non-null#368
Open
gularsson wants to merge 1 commit into
Open
fix: only treat editor as collaborative when awareness is non-null#368gularsson wants to merge 1 commit into
gularsson wants to merge 1 commit into
Conversation
A Y.XmlText value with the `awareness` prop key present but null/undefined (e.g. a local-only draft with no peers) was flagged collaborative, which mounts the remote-cursor overlay. withCursors then stored a falsy awareness, so CursorEditor.isCursorEditor returned false and useRemoteCursorOverlayPositions threw "Cannot use useSyncExternalStore outside the context of a RemoteCursorEditor". Require a non-null awareness in both isTextbitRootCollaborationProps and isSlateContainerCollaborationProps so the collaborative flag and the withCursors attachment agree. A peerless Yjs value now renders as a plain Yjs editor with no cursor overlay. Adds a regression test covering both the null-awareness and real-awareness paths.
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
1 participant
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.
A Y.XmlText value with the
awarenessprop key present but null/undefined (e.g. a local-only draft with no peers) was flagged collaborative, which mounts the remote-cursor overlay. withCursors then stored a falsy awareness, so CursorEditor.isCursorEditor returned false and useRemoteCursorOverlayPositions threw "Cannot use useSyncExternalStore outside the context of a RemoteCursorEditor".Require a non-null awareness in both isTextbitRootCollaborationProps and isSlateContainerCollaborationProps so the collaborative flag and the withCursors attachment agree. A peerless Yjs value now renders as a plain Yjs editor with no cursor overlay.
Adds a regression test covering both the null-awareness and real-awareness paths.