Loro

Make the editor collaborative by integrating Loro with ProseKit.

import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import 'prosekit/extensions/loro/style.css'

import type {
  CursorAwareness,
  LoroDocType,
} from 'loro-prosemirror'
import { createEditor } from 'prosekit/core'
import { ProseKit } from 'prosekit/react'
import { useMemo } from 'react'

import { defineExtension } from './extension'
import Toolbar from './toolbar'

export default function EditorComponent(props: {
  loro: LoroDocType
  awareness: CursorAwareness
}) {
  const editor = useMemo(() => {
    const extension = defineExtension(props.loro, props.awareness)
    return createEditor({ extension })
  }, [props.loro, props.awareness])

  return (
    <ProseKit editor={editor}>
      <div className='box-border h-full w-full min-h-36 overflow-y-hidden overflow-x-hidden rounded-md border border-solid border-gray-200 dark:border-gray-700 shadow flex flex-col bg-white dark:bg-gray-950 color-black dark:color-white'>
        <Toolbar />
        <div className='relative w-full flex-1 box-border overflow-y-scroll'>
          <div ref={editor.mount} className='ProseMirror box-border min-h-full px-[max(4rem,_calc(50%-20rem))] py-8 outline-none outline-0 [&_span[data-mention="user"]]:text-blue-500 [&_span[data-mention="tag"]]:text-violet-500'></div>
        </div>
      </div>
    </ProseKit>
  )
}

import { LoroDoc } from 'loro-crdt'
import {
  CursorAwareness,
  type LoroDocType,
} from 'loro-prosemirror'
import {
  useEffect,
  useRef,
} from 'react'

import EditorComponent from './editor-component'

export default function Page() {
  const { loroARef, awarenessA, loroBRef, awarenessB } = useLoroExample()

  return (
    <div className="h-full flex flex-col gap-2">
      <EditorComponent loro={loroARef.current} awareness={awarenessA.current} />
      <EditorComponent loro={loroBRef.current} awareness={awarenessB.current} />
    </div>
  )
}

function useLoroExample() {
  const loroARef = useRef<LoroDocType>(new LoroDoc())
  const idA = loroARef.current.peerIdStr
  const awarenessA = useRef<CursorAwareness>(new CursorAwareness(idA))
  const loroBRef = useRef<LoroDocType>(new LoroDoc())
  const idB = loroBRef.current.peerIdStr
  const awarenessB = useRef<CursorAwareness>(new CursorAwareness(idB))
  useEffect(() => {
    loroARef.current.subscribe((event) => {
      if (event.by === 'local') {
        loroBRef.current.import(
          loroARef.current.exportFrom(loroBRef.current.oplogVersion()),
        )
      }
    })
    loroBRef.current.subscribe((event) => {
      if (event.by === 'local') {
        loroARef.current.import(
          loroBRef.current.exportFrom(loroARef.current.oplogVersion()),
        )
      }
    })
    awarenessA.current.addListener((_state, origin) => {
      if (origin === 'local') {
        awarenessB.current.apply(awarenessA.current.encode([idA]))
      }
    })
    awarenessB.current.addListener((_state, origin) => {
      if (origin === 'local') {
        awarenessA.current.apply(awarenessB.current.encode([idB]))
      }
    })

    // eslint-disable-next-line react-hooks/exhaustive-deps
  }, [])

  return {
    loroARef,
    awarenessA,
    loroBRef,
    awarenessB,
  }
}

import type {
  CursorAwareness,
  LoroDocType,
} from 'loro-prosemirror'
import {
  defineBaseCommands,
  defineBaseKeymap,
  defineDoc,
  defineParagraph,
  defineText,
  union,
} from 'prosekit/core'
import { defineBlockquote } from 'prosekit/extensions/blockquote'
import { defineBold } from 'prosekit/extensions/bold'
import { defineCode } from 'prosekit/extensions/code'
import { defineDropCursor } from 'prosekit/extensions/drop-cursor'
import { defineHeading } from 'prosekit/extensions/heading'
import { defineImage } from 'prosekit/extensions/image'
import { defineItalic } from 'prosekit/extensions/italic'
import { defineLink } from 'prosekit/extensions/link'
import { defineList } from 'prosekit/extensions/list'
import { defineLoro } from 'prosekit/extensions/loro'
import { defineModClickPrevention } from 'prosekit/extensions/mod-click-prevention'
import { defineStrike } from 'prosekit/extensions/strike'
import { defineTable } from 'prosekit/extensions/table'
import { defineUnderline } from 'prosekit/extensions/underline'
import { defineVirtualSelection } from 'prosekit/extensions/virtual-selection'

export function defineExtension(doc: LoroDocType, awareness: CursorAwareness) {
  return union([
    defineDoc(),
    defineText(),
    defineHeading(),
    defineList(),
    defineBlockquote(),
    defineBaseKeymap(),
    defineBaseCommands(),
    defineItalic(),
    defineBold(),
    defineUnderline(),
    defineStrike(),
    defineCode(),
    defineLink(),
    defineImage(),
    defineParagraph(),
    defineDropCursor(),
    defineVirtualSelection(),
    defineModClickPrevention(),
    defineTable(),
    defineLoro({ doc, awareness }),
  ])
}

export type EditorExtension = ReturnType<typeof defineExtension>

import { useEditor } from 'prosekit/react'

import Button from './button'
import type { EditorExtension } from './extension'

export default function Toolbar() {
  const editor = useEditor<EditorExtension>({ update: true })

  return (
    <div className='z-2 box-border border-gray-200 dark:border-gray-800 border-solid border-l-0 border-r-0 border-t-0 border-b flex flex-wrap gap-1 p-2 items-center'>
      <Button
        pressed={false}
        disabled={!editor.commands.undo.canExec()}
        onClick={editor.commands.undo}
        tooltip="Undo"
      >
        <div className='i-lucide-undo-2 h-5 w-5' />
      </Button>

      <Button
        pressed={false}
        disabled={!editor.commands.redo.canExec()}
        onClick={editor.commands.redo}
        tooltip="Redo"
      >
        <div className='i-lucide-redo-2 h-5 w-5' />
      </Button>

      <Button
        pressed={editor.marks.bold.isActive()}
        disabled={!editor.commands.toggleBold.canExec()}
        onClick={editor.commands.toggleBold}
        tooltip="Bold"
      >
        <div className='i-lucide-bold h-5 w-5' />
      </Button>

      <Button
        pressed={editor.marks.italic.isActive()}
        disabled={!editor.commands.toggleItalic.canExec()}
        onClick={editor.commands.toggleItalic}
        tooltip="Italic"
      >
        <div className='i-lucide-italic h-5 w-5' />
      </Button>

      <Button
        pressed={editor.nodes.heading.isActive({ level: 1 })}
        disabled={!editor.commands.toggleHeading.canExec({ level: 1 })}
        onClick={() => editor.commands.toggleHeading({ level: 1 })}
        tooltip="Heading 1"
      >
        <div className='i-lucide-heading-1 h-5 w-5' />
      </Button>

      <Button
        pressed={editor.nodes.heading.isActive({ level: 2 })}
        disabled={!editor.commands.toggleHeading.canExec({ level: 2 })}
        onClick={() => editor.commands.toggleHeading({ level: 2 })}
        tooltip="Heading 2"
      >
        <div className='i-lucide-heading-2 h-5 w-5' />
      </Button>

      <Button
        pressed={editor.nodes.heading.isActive({ level: 3 })}
        disabled={!editor.commands.toggleHeading.canExec({ level: 3 })}
        onClick={() => editor.commands.toggleHeading({ level: 3 })}
        tooltip="Heading 3"
      >
        <div className='i-lucide-heading-3 h-5 w-5' />
      </Button>
    </div>
  )
}

import {
  TooltipContent,
  TooltipRoot,
  TooltipTrigger,
} from 'prosekit/react/tooltip'
import type { ReactNode } from 'react'

export default function Button({
  pressed,
  disabled,
  onClick,
  tooltip,
  children,
}: {
  pressed?: boolean
  disabled?: boolean
  onClick?: VoidFunction
  tooltip?: string
  children: ReactNode
}) {
  return (
    <TooltipRoot>
      <TooltipTrigger className='block'>
        <button
          data-state={pressed ? 'on' : 'off'}
          disabled={disabled}
          onClick={() => onClick?.()}
          onMouseDown={(event) => event.preventDefault()}
          className='outline-unset focus-visible:outline-unset flex items-center justify-center rounded-md p-2 font-medium transition focus-visible:ring-2 text-sm focus-visible:ring-gray-900 dark:focus-visible:ring-gray-300 disabled:pointer-events-none min-w-9 min-h-9 disabled:opacity-50 hover:disabled:opacity-50 bg-transparent hover:bg-gray-100 dark:hover:bg-gray-800 data-[state=on]:bg-gray-200 dark:data-[state=on]:bg-gray-700'
        >
          {children}
          {tooltip ? <span className="sr-only">{tooltip}</span> : null}
        </button>
      </TooltipTrigger>
      {tooltip
        ? (
          <TooltipContent className='z-50 overflow-hidden rounded-md border border-solid bg-gray-900 dark:bg-gray-50 px-3 py-1.5 text-xs text-gray-50 dark:text-gray-900 shadow-sm [&:not([data-state])]:hidden will-change-transform data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=open]:fade-in-0 data-[state=closed]:fade-out-0 data-[state=open]:zoom-in-95 data-[state=closed]:zoom-out-95 data-[state=open]:animate-duration-150 data-[state=closed]:animate-duration-200 data-[side=bottom]:slide-in-from-top-2 data-[side=bottom]:slide-out-to-top-2 data-[side=left]:slide-in-from-right-2 data-[side=left]:slide-out-to-right-2 data-[side=right]:slide-in-from-left-2 data-[side=right]:slide-out-to-left-2 data-[side=top]:slide-in-from-bottom-2 data-[side=top]:slide-out-to-bottom-2'>
            {tooltip}
          </TooltipContent>
        )
        : null}
    </TooltipRoot>
  )
}

Usage

You need to install loro-crdt and loro-prosemirror to use this extension.

pnpm add loro-crdt loro-prosemirror

npm install loro-crdt loro-prosemirror

yarn add loro-crdt loro-prosemirror

bun add loro-crdt loro-prosemirror

import 'prosekit/extensions/loro/style.css'
import { LoroDocclass LoroDoc<T extends Record<string, Container> = Record<string, Container>>
interface LoroDoc<T extends Record<string, Container> = Record<string, Container>>The CRDTs document. Loro supports different CRDTs include [**List**](LoroList),
[**RichText**](LoroText), [**Map**](LoroMap) and [**Movable Tree**](LoroTree),
you could build all kind of applications by these.

**Important:** Loro is a pure library and does not handle network protocols.
It is the responsibility of the user to manage the storage, loading, and synchronization
of the bytes exported by Loro in a manner suitable for their specific environment.
@example```ts
import { LoroDoc } from "loro-crdt"

const loro = new LoroDoc();
const text = loro.getText("text");
const list = loro.getList("list");
const map = loro.getMap("Map");
const tree = loro.getTree("tree");
``` } from 'loro-crdt'
import {
  CursorAwarenessclass CursorAwareness,
  type LoroDocTypetype LoroDocType = LoroDoc<{
    doc: LoroMap<LoroNodeContainerType>;
    data: LoroMap;
}>,
} from 'loro-prosemirror'
import { defineLorofunction defineLoro(options: LoroOptions): LoroExtension@public } from 'prosekit/extensions/loro'

const docconst doc: LoroDocType: LoroDocTypetype LoroDocType = LoroDoc<{
    doc: LoroMap<LoroNodeContainerType>;
    data: LoroMap;
}> = new LoroDocnew LoroDoc<{
    doc: LoroMap<LoroNodeContainerType>;
    data: LoroMap;
}>(): LoroDoc<{
    doc: LoroMap<LoroNodeContainerType>;
    data: LoroMap;
}>Create a new loro document.

New document will have a random peer id.()
const awarenessconst awareness: CursorAwareness = new CursorAwarenessnew CursorAwareness(peer: PeerID, timeout?: number): CursorAwareness(docconst doc: LoroDocType.peerIdStrLoroDoc<{ doc: LoroMap<LoroNodeContainerType>; data: LoroMap; }>.peerIdStr: `${number}`Get peer id in decimal string.)
const extensionconst extension: LoroExtension = defineLorofunction defineLoro(options: LoroOptions): LoroExtension@public({ docLoroOptions.doc: LoroDocTypeThe Loro instance handles the state of shared data., awarenessLoroOptions.awareness: CursorAwarenessThe Awareness instance. })

API Reference

prosekit/extensions/loro