prosekit/extensions/yjs

YjsCursorOptions

Options for y-prosemirror's yCursorPlugin.

awareness: Awareness

YjsOptions

awareness: Awareness

The Awareness instance.

cursor?: {}

Options for y-prosemirror's yCursorPlugin.

doc: Doc

The Yjs instance handles the state of shared data.

fragment?: YXmlFragment

The Yjs XmlFragment to use. If not provided, doc.getXmlFragment('prosemirror') will be used.

sync?: YSyncOpts

Options for y-prosemirror's ySyncPlugin.

undo?: {}

Options for the y-prosemirror's yUndoPlugin.

YjsSyncOptions

Options for y-prosemirror's ySyncPlugin.

fragment: YXmlFragment

YjsUndoOptions

Options for the y-prosemirror's yUndoPlugin.

YjsCursorPluginOptions

Options for y-prosemirror's yCursorPlugin.

Type: NonNullable<Parameters<typeof yCursorPlugin>[1]>

YjsSyncPluginOptions

Options for y-prosemirror's ySyncPlugin.

Type: NonNullable<Parameters<typeof ySyncPlugin>[1]>

YjsUndoPluginOptions

Options for the y-prosemirror's yUndoPlugin.

Type: NonNullable<Parameters<typeof originalYUndoPlugin>[0]>

defineYjs

function defineYjs(options: YjsOptions): YjsExtension

defineYjsCommands

function defineYjsCommands(): YjsCommandsExtension

defineYjsCursorPlugin

function defineYjsCursorPlugin(options: YjsCursorOptions): PlainExtension

defineYjsKeymap

function defineYjsKeymap(): PlainExtension

defineYjsSyncPlugin

function defineYjsSyncPlugin(options: YjsSyncOptions): PlainExtension

defineYjsUndoPlugin

function defineYjsUndoPlugin(options: YjsUndoOptions): PlainExtension