@lexical/yjs

Interfaces

Provider

Defined in: packages/lexical-yjs/src/index.ts:38

Properties

awareness

awareness: ProviderAwareness

Defined in: packages/lexical-yjs/src/index.ts:39

Methods

connect()

connect(): void | Promise<void>

Defined in: packages/lexical-yjs/src/index.ts:40

Returns

void | Promise<void>

disconnect()

disconnect(): void

Defined in: packages/lexical-yjs/src/index.ts:41

Returns

void

off()

Call Signature

off(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:42

Parameters

type

"sync"

cb

(isSynced) => void

Returns

void

Call Signature

off(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:43

Parameters

type

"update"

cb

(arg0) => void

Returns

void

Call Signature

off(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:44

Parameters

type

"status"

cb

(arg0) => void

Returns

void

Call Signature

off(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:45

Parameters

type

"reload"

cb

(doc) => void

Returns

void

on()

Call Signature

on(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:46

Parameters

type

"sync"

cb

(isSynced) => void

Returns

void

Call Signature

on(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:47

Parameters

type

"status"

cb

(arg0) => void

Returns

void

Call Signature

on(type, cb): void

Defined in: packages/lexical-yjs/src/index.ts:48

Parameters

type

"update"

cb

(arg0) => void

Returns

void

Call Signature

on(type, cb): void

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

Parameters

type

"reload"

cb

(doc) => void

Returns

void

Type Aliases

Binding

Binding = object

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

Properties

clientID

clientID: number

Defined in: packages/lexical-yjs/src/Bindings.ts:26

collabNodeMap

collabNodeMap: Map<NodeKey, CollabElementNode | CollabTextNode | CollabDecoratorNode | CollabLineBreakNode>

Defined in: packages/lexical-yjs/src/Bindings.ts:27

cursors

cursors: Map<ClientID, Cursor>

Defined in: packages/lexical-yjs/src/Bindings.ts:34

cursorsContainer

cursorsContainer: null | HTMLElement

Defined in: packages/lexical-yjs/src/Bindings.ts:35

doc

doc: Doc

Defined in: packages/lexical-yjs/src/Bindings.ts:36

docMap

docMap: Map<string, Doc>

Defined in: packages/lexical-yjs/src/Bindings.ts:37

editor

editor: LexicalEditor

Defined in: packages/lexical-yjs/src/Bindings.ts:38

excludedProperties

excludedProperties: ExcludedProperties

Defined in: packages/lexical-yjs/src/Bindings.ts:42

id

id: string

Defined in: packages/lexical-yjs/src/Bindings.ts:39

nodeProperties

nodeProperties: Map<string, string[]>

Defined in: packages/lexical-yjs/src/Bindings.ts:40

root

root: CollabElementNode

Defined in: packages/lexical-yjs/src/Bindings.ts:41

---

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

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

Properties

attributes

attributes: object

Defined in: packages/lexical-yjs/src/index.ts:52

__type

__type: string

insert

insert: string | Record<string, unknown>

Defined in: packages/lexical-yjs/src/index.ts:55

---

ProviderAwareness

ProviderAwareness = object

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

Properties

getLocalState()

getLocalState: () => UserState | null

Defined in: packages/lexical-yjs/src/index.ts:31

Returns

UserState | null

getStates()

getStates: () => Map<number, UserState>

Defined in: packages/lexical-yjs/src/index.ts:32

Returns

Map<number, UserState>

off()

off: (type, cb) => void

Defined in: packages/lexical-yjs/src/index.ts:33

Parameters

type

"update"

cb

() => void

Returns

void

on()

on: (type, cb) => void

Defined in: packages/lexical-yjs/src/index.ts:34

Parameters

type

"update"

cb

() => void

Returns

void

setLocalState()

setLocalState: (arg0) => void

Defined in: packages/lexical-yjs/src/index.ts:35

Parameters

arg0

UserState

Returns

void

setLocalStateField()

setLocalStateField: (field, value) => void

Defined in: packages/lexical-yjs/src/index.ts:36

Parameters

field

string

value

unknown

Returns

void

---

SyncCursorPositionsFn()

SyncCursorPositionsFn = (binding, provider, options?) => void

Defined in: packages/lexical-yjs/src/SyncCursors.ts:412

Parameters

binding

Binding

provider

Provider

options?

SyncCursorPositionsOptions

Returns

void

---

UserState

UserState = object

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

Indexable

[key: string]: unknown

Properties

anchorPos

anchorPos: null | RelativePosition

Defined in: packages/lexical-yjs/src/index.ts:17

awarenessData

awarenessData: object

Defined in: packages/lexical-yjs/src/index.ts:22

color

color: string

Defined in: packages/lexical-yjs/src/index.ts:18

focusing

focusing: boolean

Defined in: packages/lexical-yjs/src/index.ts:19

focusPos

focusPos: null | RelativePosition

Defined in: packages/lexical-yjs/src/index.ts:20

name

name: string

Defined in: packages/lexical-yjs/src/index.ts:21

---

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

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

Parameters

editor

LexicalEditor

provider

Provider

id

string

doc

undefined | null | Doc

docMap

Map<string, Doc>

excludedProperties?

ExcludedProperties

Returns

Binding

---

createUndoManager()

createUndoManager(binding, root): UndoManager

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

Parameters

binding

Binding

root

YXmlText

Returns

UndoManager

---

getAnchorAndFocusCollabNodesForUserState()

getAnchorAndFocusCollabNodesForUserState(binding, userState): object

Defined in: packages/lexical-yjs/src/SyncCursors.ts:303

Parameters

binding

Binding

userState

UserState

Returns

object

anchorCollabNode

anchorCollabNode: null | AnyCollabNode

anchorOffset

anchorOffset: number

focusCollabNode

focusCollabNode: null | AnyCollabNode

focusOffset

focusOffset: number

---

initLocalState()

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

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

Parameters

provider

Provider

name

string

color

string

focusing

boolean

awarenessData

object

Returns

void

---

setLocalStateFocus()

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

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

Parameters

provider

Provider

name

string

color

string

focusing

boolean

awarenessData

object

Returns

void

---

syncCursorPositions()

syncCursorPositions(binding, provider, options?): void

Defined in: packages/lexical-yjs/src/SyncCursors.ts:432

Parameters

binding

Binding

provider

Provider

options?

SyncCursorPositionsOptions

Returns

void

---

syncLexicalUpdateToYjs()

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

Defined in: packages/lexical-yjs/src/SyncEditorStates.ts:256

Parameters

binding

Binding

provider

Provider

prevEditorState

EditorState

currEditorState

EditorState

dirtyElements

Map<string, boolean>

dirtyLeaves

Set<string>

normalizedNodes

Set<string>

tags

Set<string>

Returns

void

---

syncYjsChangesToLexical()

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

Defined in: packages/lexical-yjs/src/SyncEditorStates.ts:129

Parameters

binding

Binding

provider

Provider

events

YEvent<YText>[]

isFromUndoManger

boolean

syncCursorPositionsFn

SyncCursorPositionsFn = syncCursorPositions

Returns

void