Skip to content
ProseKit
GitHubDiscord

prosekit/extensions/loro

Interfaces

Section titled “Interfaces”

LoroCursorOptions

Section titled “LoroCursorOptions”

Properties

Section titled “Properties”

awareness?: CursorAwareness

presence?: CursorEphemeralStore

LoroOptions

Section titled “LoroOptions”

Properties

Section titled “Properties”

doc: LoroDocType

The Loro instance handles the state of shared data.

awareness?: CursorAwareness

The (legacy) Awareness instance. One of awareness or presence must be provided.

presence?: CursorEphemeralStore

The CursorEphemeralStore instance. One of awareness or presence must be provided.

sync?: Omit<LoroSyncPluginProps, "doc">

Extra options for LoroSyncPlugin.

undo?: Omit<LoroUndoPluginProps, "doc">

Extra options for the LoroUndoPlugin.

cursor?: CursorPluginOptions

Extra options for LoroCursorPlugin or LoroEphemeralCursorPlugin.

Functions

Section titled “Functions”

defineLoroCommands()

Section titled “defineLoroCommands()”

function defineLoroCommands(): LoroCommandsExtension

defineLoroCursorPlugin()

Section titled “defineLoroCursorPlugin()”

function defineLoroCursorPlugin(options: LoroCursorOptions): PlainExtension

defineLoroKeymap()

Section titled “defineLoroKeymap()”

function defineLoroKeymap(): PlainExtension

defineLoroSyncPlugin()

Section titled “defineLoroSyncPlugin()”

function defineLoroSyncPlugin(options: LoroSyncPluginProps): PlainExtension

defineLoroUndoPlugin()

Section titled “defineLoroUndoPlugin()”

function defineLoroUndoPlugin(options: LoroUndoPluginProps): PlainExtension

defineLoro()

Section titled “defineLoro()”

function defineLoro(options: LoroOptions): LoroExtension