prosekit/extensions/yjs
Options for y-prosemirror
’s yCursorPlugin
.
-
awareness: Awareness
-
awareness: Awareness
-
The Awareness instance.
-
cursor?: {}
-
Options for
y-prosemirror
’syCursorPlugin
. -
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
’sySyncPlugin
. -
undo?: {}
-
Options for the
y-prosemirror
’syUndoPlugin
.
Options for y-prosemirror
’s ySyncPlugin
.
-
fragment: YXmlFragment
Options for the y-prosemirror
’s yUndoPlugin
.
Options for y-prosemirror
’s yCursorPlugin
.
Type: NonNullable<Parameters<typeof yCursorPlugin>[1]>
Options for y-prosemirror
’s ySyncPlugin
.
Type: NonNullable<Parameters<typeof ySyncPlugin>[1]>
Options for the y-prosemirror
’s yUndoPlugin
.
Type: NonNullable<Parameters<typeof originalYUndoPlugin>[0]>
function defineYjs(options: YjsOptions): YjsExtension
function defineYjsCommands(): YjsCommandsExtension
function defineYjsCursorPlugin(options: YjsCursorOptions): PlainExtension
function defineYjsKeymap(): PlainExtension
function defineYjsSyncPlugin(options: YjsSyncOptions): PlainExtension