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