Module: @lexical/yjs

Interfaces

• Provider

Type Aliases

Binding

Ƭ Binding: Object

Type declaration

Name	Type
clientID	number
collabNodeMap	Map<NodeKey, CollabElementNode | CollabTextNode | CollabDecoratorNode | CollabLineBreakNode>
cursors	Map<ClientID, Cursor>
cursorsContainer	null | HTMLElement
doc	Doc
docMap	Map<string, Doc>
editor	LexicalEditor
excludedProperties	ExcludedProperties
id	string
nodeProperties	Map<string, string[]>
root	CollabElementNode

Defined in

packages/lexical-yjs/src/Bindings.ts:25

---

ClientID

Ƭ ClientID: number

Defined in

packages/lexical-yjs/src/Bindings.ts:24

---

Delta

Ƭ Delta: Operation[]

Defined in

packages/lexical-yjs/src/index.ts:57

---

ExcludedProperties

Ƭ ExcludedProperties: Map<Klass<LexicalNode>, Set<string>>

Defined in

packages/lexical-yjs/src/Bindings.ts:44

---

Operation

Ƭ Operation: Object

Type declaration

Name	Type
attributes	{ __type: string }
attributes.__type	string
insert	string | Record<string, unknown>

Defined in

packages/lexical-yjs/src/index.ts:51

---

ProviderAwareness

Ƭ ProviderAwareness: Object

Type declaration

Name	Type
getLocalState	() => UserState | null
getStates	() => Map<number, UserState>
off	(type: "update", cb: () => void) => void
on	(type: "update", cb: () => void) => void
setLocalState	(arg0: UserState) => void
setLocalStateField	(field: string, value: unknown) => void

Defined in

packages/lexical-yjs/src/index.ts:30

---

SyncCursorPositionsFn

Ƭ SyncCursorPositionsFn: (binding: Binding, provider: Provider) => void

Type declaration

▸ (binding, provider): void

Parameters

Name	Type
binding	Binding
provider	Provider

Returns

void

Defined in

packages/lexical-yjs/src/SyncCursors.ts:413

---

UserState

Ƭ UserState: Object

Index signature

▪ [key: string]: unknown

Type declaration

Name	Type
anchorPos	null | RelativePosition
awarenessData	object
color	string
focusPos	null | RelativePosition
focusing	boolean
name	string

Defined in

packages/lexical-yjs/src/index.ts:16

---

YjsEvent

Ƭ YjsEvent: Record<string, unknown>

Defined in

packages/lexical-yjs/src/index.ts:59

---

YjsNode

Ƭ YjsNode: Record<string, unknown>

Defined in

packages/lexical-yjs/src/index.ts:58

Variables

CONNECTED_COMMAND

• Const CONNECTED_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical-yjs/src/index.ts:25

---

TOGGLE_CONNECT_COMMAND

• Const TOGGLE_CONNECT_COMMAND: LexicalCommand<boolean>

Defined in

packages/lexical-yjs/src/index.ts:27

Functions

createBinding

▸ createBinding(editor, provider, id, doc, docMap, excludedProperties?): Binding

Parameters

Name	Type
editor	LexicalEditor
provider	Provider
id	string
doc	undefined | null | Doc
docMap	Map<string, Doc>
excludedProperties?	ExcludedProperties

Returns

Binding

Defined in

packages/lexical-yjs/src/Bindings.ts:46

---

createUndoManager

▸ createUndoManager(binding, root): UndoManager

Parameters

Name	Type
binding	Binding
root	YXmlText

Returns

UndoManager

Defined in

packages/lexical-yjs/src/index.ts:64

---

getAnchorAndFocusCollabNodesForUserState

▸ getAnchorAndFocusCollabNodesForUserState(binding, userState): Object

Parameters

Name	Type
binding	Binding
userState	UserState

Returns

Object

Name	Type
anchorCollabNode	null | AnyCollabNode
anchorOffset	number
focusCollabNode	null | AnyCollabNode
focusOffset	number

Defined in

packages/lexical-yjs/src/SyncCursors.ts:304

---

initLocalState

▸ initLocalState(provider, name, color, focusing, awarenessData): void

Parameters

Name	Type
provider	Provider
name	string
color	string
focusing	boolean
awarenessData	object

Returns

void

Defined in

packages/lexical-yjs/src/index.ts:73

---

setLocalStateFocus

▸ setLocalStateFocus(provider, name, color, focusing, awarenessData): void

Parameters

Name	Type
provider	Provider
name	string
color	string
focusing	boolean
awarenessData	object

Returns

void

Defined in

packages/lexical-yjs/src/index.ts:90

---

syncCursorPositions

▸ syncCursorPositions(binding, provider): void

Parameters

Name	Type
binding	Binding
provider	Provider

Returns

void

Defined in

packages/lexical-yjs/src/SyncCursors.ts:418

---

syncLexicalUpdateToYjs

▸ syncLexicalUpdateToYjs(binding, provider, prevEditorState, currEditorState, dirtyElements, dirtyLeaves, normalizedNodes, tags): void

Parameters

Name	Type
binding	Binding
provider	Provider
prevEditorState	EditorState
currEditorState	EditorState
dirtyElements	Map<string, boolean>
dirtyLeaves	Set<string>
normalizedNodes	Set<string>
tags	Set<string>

Returns

void

Defined in

packages/lexical-yjs/src/SyncEditorStates.ts:199

---

syncYjsChangesToLexical

▸ syncYjsChangesToLexical(binding, provider, events, isFromUndoManger, syncCursorPositionsFn?): void

Parameters

Name	Type	Default value
binding	Binding	undefined
provider	Provider	undefined
events	YEvent<YText>[]	undefined
isFromUndoManger	boolean	undefined
syncCursorPositionsFn	SyncCursorPositionsFn	syncCursorPositions

Returns

void

Defined in

packages/lexical-yjs/src/SyncEditorStates.ts:82