prosekit/extensions/yjs
YjsCursorOptions
Options for y-prosemirror
's yCursorPlugin
.
Extends
Properties
awareness
awareness:
Awareness
YjsOptions
Properties
awareness
awareness:
Awareness
The Awareness instance.
cursor?
optional
cursor:object
Options for y-prosemirror
's yCursorPlugin
.
doc
doc:
Doc
The Yjs instance handles the state of shared data.
fragment?
optional
fragment:YXmlFragment
The Yjs XmlFragment to use. If not provided, doc.getXmlFragment('prosemirror')
will be used.
sync?
optional
sync:YSyncOpts
Options for y-prosemirror
's ySyncPlugin
.
undo?
optional
undo:object
Options for the y-prosemirror
's yUndoPlugin
.
YjsSyncOptions
Options for y-prosemirror
's ySyncPlugin
.
Extends
Properties
fragment
fragment:
YXmlFragment
YjsUndoOptions
Options for the y-prosemirror
's yUndoPlugin
.
Extends
YjsCursorPluginOptions
YjsCursorPluginOptions:
NonNullable
<Parameters
<typeofyCursorPlugin
>[1
]>
Options for y-prosemirror
's yCursorPlugin
.
YjsSyncPluginOptions
YjsSyncPluginOptions:
NonNullable
<Parameters
<typeofySyncPlugin
>[1
]>
Options for y-prosemirror
's ySyncPlugin
.
YjsUndoPluginOptions
YjsUndoPluginOptions:
NonNullable
<Parameters
<typeoforiginalYUndoPlugin
>[0
]>
Options for the y-prosemirror
's yUndoPlugin
.
defineYjs()
defineYjs(
options
):YjsExtension
Parameters
• options: YjsOptions
Returns
YjsExtension
defineYjsCommands()
defineYjsCommands():
YjsCommandsExtension
Returns
YjsCommandsExtension
defineYjsCursorPlugin()
defineYjsCursorPlugin(
options
):PlainExtension
Parameters
• options: YjsCursorOptions
Returns
PlainExtension
defineYjsKeymap()
defineYjsKeymap():
PlainExtension
Returns
PlainExtension
defineYjsSyncPlugin()
defineYjsSyncPlugin(
options
):PlainExtension
Parameters
• options: YjsSyncOptions
Returns
PlainExtension
defineYjsUndoPlugin()
defineYjsUndoPlugin(
options
):PlainExtension
Parameters
• options: YjsUndoOptions
Returns
PlainExtension