Skip to main content

Module: @lexical/yjs

Interfaces

Type Aliases

Binding

Ƭ Binding: Object

Type declaration

NameType
clientIDnumber
collabNodeMapMap<NodeKey, CollabElementNode | CollabTextNode | CollabDecoratorNode | CollabLineBreakNode>
cursorsMap<ClientID, Cursor>
cursorsContainernull | HTMLElement
docDoc
docMapMap<string, Doc>
editorLexicalEditor
excludedPropertiesExcludedProperties
idstring
nodePropertiesMap<string, string[]>
rootCollabElementNode

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:55


ExcludedProperties

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

Defined in

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


Operation

Ƭ Operation: Object

Type declaration

NameType
attributes{ __type: string }
attributes.__typestring
insertstring | Record<string, unknown>

Defined in

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


ProviderAwareness

Ƭ ProviderAwareness: Object

Type declaration

NameType
getLocalState() => UserState | null
getStates() => Map<number, UserState>
off(type: "update", cb: () => void) => void
on(type: "update", cb: () => void) => void
setLocalState(arg0: UserState) => void

Defined in

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


UserState

Ƭ UserState: Object

Type declaration

NameType
anchorPosnull | RelativePosition
awarenessDataobject
colorstring
focusPosnull | RelativePosition
focusingboolean
namestring

Defined in

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


YjsEvent

Ƭ YjsEvent: Record<string, unknown>

Defined in

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


YjsNode

Ƭ YjsNode: Record<string, unknown>

Defined in

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

Variables

CONNECTED_COMMAND

Const CONNECTED_COMMAND: LexicalCommand<boolean>

Defined in

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


TOGGLE_CONNECT_COMMAND

Const TOGGLE_CONNECT_COMMAND: LexicalCommand<boolean>

Defined in

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

Functions

createBinding

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

Parameters

NameType
editorLexicalEditor
providerProvider
idstring
docundefined | null | Doc
docMapMap<string, Doc>
excludedProperties?ExcludedProperties

Returns

Binding

Defined in

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


createUndoManager

createUndoManager(binding, root): UndoManager

Parameters

NameType
bindingBinding
rootYXmlText

Returns

UndoManager

Defined in

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


initLocalState

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

Parameters

NameType
providerProvider
namestring
colorstring
focusingboolean
awarenessDataobject

Returns

void

Defined in

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


setLocalStateFocus

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

Parameters

NameType
providerProvider
namestring
colorstring
focusingboolean
awarenessDataobject

Returns

void

Defined in

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


syncCursorPositions

syncCursorPositions(binding, provider): void

Parameters

NameType
bindingBinding
providerProvider

Returns

void

Defined in

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


syncLexicalUpdateToYjs

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

Parameters

NameType
bindingBinding
providerProvider
prevEditorStateEditorState
currEditorStateEditorState
dirtyElementsMap<string, boolean>
dirtyLeavesSet<string>
normalizedNodesSet<string>
tagsSet<string>

Returns

void

Defined in

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


syncYjsChangesToLexical

syncYjsChangesToLexical(binding, provider, events, isFromUndoManger): void

Parameters

NameType
bindingBinding
providerProvider
eventsYEvent<YText>[]
isFromUndoMangerboolean

Returns

void

Defined in

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