prosekit/extensions/yjs
YjsCursorOptions
Options for y-prosemirror's yCursorPlugin.
awarenessType:
Awareness
YjsOptions
awarenessThe Awareness instance.
Type:
AwarenesscursorOptions for
y-prosemirror'syCursorPlugin.Type:
{}docThe Yjs instance handles the state of shared data.
Type:
DocfragmentThe Yjs XmlFragment to use. If not provided,
doc.getXmlFragment('prosemirror')will be used.Type:
YXmlFragmentsyncOptions for
y-prosemirror'sySyncPlugin.Type:
YSyncOptsundoOptions for the
y-prosemirror'syUndoPlugin.Type:
{}
YjsSyncOptions
Options for y-prosemirror's ySyncPlugin.
fragmentType:
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): YjsExtensiondefineYjsCommands
function defineYjsCommands(): YjsCommandsExtensiondefineYjsCursorPlugin
function defineYjsCursorPlugin(options: YjsCursorOptions): PlainExtensiondefineYjsKeymap
function defineYjsKeymap(): PlainExtensiondefineYjsSyncPlugin
function defineYjsSyncPlugin(options: YjsSyncOptions): PlainExtensiondefineYjsUndoPlugin
function defineYjsUndoPlugin(options: YjsUndoOptions): PlainExtension