Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[lexical-yjs] Feature: Expose function to get anchor and focus nodes for given user awareness state #6942

Merged
merged 7 commits into from
Jan 4, 2025
+79 −73
Merged

[lexical-yjs] Feature: Expose function to get anchor and focus nodes for given user awareness state #6942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b16929b
[lexical-yjs] Expose function to get anchor and focus nodes for given…
amanharwara Dec 11, 2024
08baf4c
Merge branch 'main' into yjs-cursor-util
amanharwara Dec 23, 2024
915ae40
Merge branch 'main' into yjs-cursor-util
amanharwara Dec 24, 2024
32d0b47
Merge branch 'main' into yjs-cursor-util
amanharwara Jan 1, 2025
88bb1c9
PR feedback
amanharwara Jan 4, 2025
d6f74b6
Refactor to use actual Point
amanharwara Jan 4, 2025
1226143
Revert "Refactor to use actual Point"
amanharwara Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 75 additions & 72 deletions packages/lexical-yjs/src/SyncCursors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import {
createRelativePositionFromTypeIndex,
} from 'yjs';

import {Provider} from '.';
import {Provider, UserState} from '.';
import {CollabDecoratorNode} from './CollabDecoratorNode';
import {CollabElementNode} from './CollabElementNode';
import {CollabLineBreakNode} from './CollabLineBreakNode';
Expand Down Expand Up @@ -295,50 +295,73 @@ function updateCursor(
}
}

export function $syncLocalCursorPosition(
binding: Binding,
provider: Provider,
): void {
const awareness = provider.awareness;
const localState = awareness.getLocalState();
type AnyCollabNode =
| CollabDecoratorNode
| CollabElementNode
| CollabTextNode
| CollabLineBreakNode;
amanharwara marked this conversation as resolved.
Show resolved Hide resolved

if (localState === null) {
return;
}
export function getAnchorAndFocusCollabNodesForUserState(
binding: Binding,
userState: UserState,
) {
const {anchorPos, focusPos} = userState;

const anchorPos = localState.anchorPos;
const focusPos = localState.focusPos;
let anchorCollabNode: AnyCollabNode | null = null;
let anchorOffset = 0;
let focusCollabNode: AnyCollabNode | null = null;
let focusOffset = 0;

if (anchorPos !== null && focusPos !== null) {
const anchorAbsPos = createAbsolutePosition(anchorPos, binding);
const focusAbsPos = createAbsolutePosition(focusPos, binding);

if (anchorAbsPos !== null && focusAbsPos !== null) {
const [anchorCollabNode, anchorOffset] = getCollabNodeAndOffset(
[anchorCollabNode, anchorOffset] = getCollabNodeAndOffset(
anchorAbsPos.type,
anchorAbsPos.index,
);
const [focusCollabNode, focusOffset] = getCollabNodeAndOffset(
[focusCollabNode, focusOffset] = getCollabNodeAndOffset(
focusAbsPos.type,
focusAbsPos.index,
);
}
}

if (anchorCollabNode !== null && focusCollabNode !== null) {
const anchorKey = anchorCollabNode.getKey();
const focusKey = focusCollabNode.getKey();
return {
anchorCollabNode,
anchorOffset,
focusCollabNode,
focusOffset,
};
}

const selection = $getSelection();
export function $syncLocalCursorPosition(
binding: Binding,
provider: Provider,
): void {
const awareness = provider.awareness;
const localState = awareness.getLocalState();

if (!$isRangeSelection(selection)) {
return;
}
const anchor = selection.anchor;
const focus = selection.focus;
if (localState === null) {
return;
}

$setPoint(anchor, anchorKey, anchorOffset);
$setPoint(focus, focusKey, focusOffset);
}
const {anchorCollabNode, anchorOffset, focusCollabNode, focusOffset} =
getAnchorAndFocusCollabNodesForUserState(binding, localState);

if (anchorCollabNode !== null && focusCollabNode !== null) {
const anchorKey = anchorCollabNode.getKey();
const focusKey = focusCollabNode.getKey();

const selection = $getSelection();

if (!$isRangeSelection(selection)) {
return;
}

$setPoint(selection.anchor, anchorKey, anchorOffset);
$setPoint(selection.focus, focusKey, focusOffset);
}
}

Expand All @@ -363,16 +386,7 @@ function getCollabNodeAndOffset(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
sharedType: any,
offset: number,
): [
(
| null
| CollabDecoratorNode
| CollabElementNode
| CollabTextNode
| CollabLineBreakNode
),
number,
] {
): [null | AnyCollabNode, number] {
const collabNode = sharedType._collabNode;

if (collabNode === undefined) {
Expand Down Expand Up @@ -413,7 +427,7 @@ export function syncCursorPositions(

if (clientID !== localClientID) {
visitedClientIDs.add(clientID);
const {anchorPos, focusPos, name, color, focusing} = awareness;
const {name, color, focusing} = awareness;
let selection = null;

let cursor = cursors.get(clientID);
Expand All @@ -423,41 +437,30 @@ export function syncCursorPositions(
cursors.set(clientID, cursor);
}

if (anchorPos !== null && focusPos !== null && focusing) {
const anchorAbsPos = createAbsolutePosition(anchorPos, binding);
const focusAbsPos = createAbsolutePosition(focusPos, binding);

if (anchorAbsPos !== null && focusAbsPos !== null) {
const [anchorCollabNode, anchorOffset] = getCollabNodeAndOffset(
anchorAbsPos.type,
anchorAbsPos.index,
);
const [focusCollabNode, focusOffset] = getCollabNodeAndOffset(
focusAbsPos.type,
focusAbsPos.index,
);

if (anchorCollabNode !== null && focusCollabNode !== null) {
const anchorKey = anchorCollabNode.getKey();
const focusKey = focusCollabNode.getKey();
selection = cursor.selection;

if (selection === null) {
selection = createCursorSelection(
cursor,
anchorKey,
anchorOffset,
focusKey,
focusOffset,
);
} else {
const anchor = selection.anchor;
const focus = selection.focus;
anchor.key = anchorKey;
anchor.offset = anchorOffset;
focus.key = focusKey;
focus.offset = focusOffset;
}
if (focusing) {
const {anchorCollabNode, anchorOffset, focusCollabNode, focusOffset} =
getAnchorAndFocusCollabNodesForUserState(binding, awareness);

if (anchorCollabNode !== null && focusCollabNode !== null) {
const anchorKey = anchorCollabNode.getKey();
const focusKey = focusCollabNode.getKey();
selection = cursor.selection;

if (selection === null) {
selection = createCursorSelection(
cursor,
anchorKey,
anchorOffset,
focusKey,
focusOffset,
);
} else {
const anchor = selection.anchor;
const focus = selection.focus;
anchor.key = anchorKey;
anchor.offset = anchorOffset;
focus.key = focusKey;
focus.offset = focusOffset;
etrepum marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand Down
5 changes: 4 additions & 1 deletion packages/lexical-yjs/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,10 @@ export function setLocalStateFocus(
localState.focusing = focusing;
awareness.setLocalState(localState);
}
export {syncCursorPositions} from './SyncCursors';
export {
getAnchorAndFocusCollabNodesForUserState,
syncCursorPositions,
} from './SyncCursors';
export {
syncLexicalUpdateToYjs,
syncYjsChangesToLexical,
Expand Down
Loading