Example: loro
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,
type AwarenessListener,
} from 'loro-crdt'
import {
CursorAwareness,
type LoroDocType,
} from 'loro-prosemirror'
import {
useEffect,
useState,
} from 'react'
import EditorComponent from './editor-component'
export default function Page() {
const { loroA, awarenessA, loroB, awarenessB } = useLoroDocs()
return (
<div className="h-full flex flex-col gap-2">
<EditorComponent loro={loroA} awareness={awarenessA} />
<EditorComponent loro={loroB} awareness={awarenessB} />
</div>
)
}
function useLoroDocs() {
const [loroState] = useState(() => {
const loroA: LoroDocType = new LoroDoc()
const loroB: LoroDocType = new LoroDoc()
const idA = loroA.peerIdStr
const idB = loroB.peerIdStr
const awarenessA = new CursorAwareness(idA)
const awarenessB = new CursorAwareness(idB)
return { loroA, loroB, idA, idB, awarenessA, awarenessB }
})
useEffect(() => {
const { loroA, loroB, idA, idB, awarenessA, awarenessB } = loroState
const unsubscribeA = loroA.subscribeLocalUpdates((updates) => {
loroB.import(updates)
})
const unsubscribeB = loroB.subscribeLocalUpdates((updates) => {
loroA.import(updates)
})
const awarenessAListener: AwarenessListener = (_, origin) => {
if (origin === 'local') {
awarenessB.apply(awarenessA.encode([idA]))
}
}
const awarenessBListener: AwarenessListener = (_, origin) => {
if (origin === 'local') {
awarenessA.apply(awarenessB.encode([idB]))
}
}
awarenessA.addListener(awarenessAListener)
awarenessB.addListener(awarenessBListener)
return () => {
awarenessA.removeListener(awarenessAListener)
awarenessB.removeListener(awarenessBListener)
unsubscribeA()
unsubscribeB()
}
}, [loroState])
return loroState
}
import type {
CursorAwareness,
LoroDocType,
} from 'loro-prosemirror'
import {
defineBaseCommands,
defineBaseKeymap,
} from 'prosekit/core'
import { union } from 'prosekit/core'
import { defineBlockquote } from 'prosekit/extensions/blockquote'
import { defineBold } from 'prosekit/extensions/bold'
import { defineCode } from 'prosekit/extensions/code'
import { defineDoc } from 'prosekit/extensions/doc'
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 { defineParagraph } from 'prosekit/extensions/paragraph'
import { defineStrike } from 'prosekit/extensions/strike'
import { defineTable } from 'prosekit/extensions/table'
import { defineText } from 'prosekit/extensions/text'
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 type { Editor } from 'prosekit/core'
import { useEditorDerivedValue } from 'prosekit/react'
import Button from './button'
import type { EditorExtension } from './extension'
function getToolbarItems(editor: Editor<EditorExtension>) {
return {
undo: {
isActive: false,
canExec: editor.commands.undo.canExec(),
command: editor.commands.undo,
},
redo: {
isActive: false,
canExec: editor.commands.redo.canExec(),
command: editor.commands.redo,
},
bold: {
isActive: editor.marks.bold.isActive(),
canExec: editor.commands.toggleBold.canExec(),
command: editor.commands.toggleBold,
},
italic: {
isActive: editor.marks.italic.isActive(),
canExec: editor.commands.toggleItalic.canExec(),
command: editor.commands.toggleItalic,
},
heading1: {
isActive: editor.nodes.heading.isActive({ level: 1 }),
canExec: editor.commands.toggleHeading.canExec({ level: 1 }),
command: () => editor.commands.toggleHeading({ level: 1 }),
},
heading2: {
isActive: editor.nodes.heading.isActive({ level: 2 }),
canExec: editor.commands.toggleHeading.canExec({ level: 2 }),
command: () => editor.commands.toggleHeading({ level: 2 }),
},
heading3: {
isActive: editor.nodes.heading.isActive({ level: 3 }),
canExec: editor.commands.toggleHeading.canExec({ level: 3 }),
command: () => editor.commands.toggleHeading({ level: 3 }),
},
}
}
export default function Toolbar() {
const items = useEditorDerivedValue(getToolbarItems)
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={items.undo.isActive}
disabled={!items.undo.canExec}
onClick={items.undo.command}
tooltip="Undo"
>
<div className="i-lucide-undo-2 h-5 w-5" />
</Button>
<Button
pressed={items.redo.isActive}
disabled={!items.redo.canExec}
onClick={items.redo.command}
tooltip="Redo"
>
<div className="i-lucide-redo-2 h-5 w-5" />
</Button>
<Button
pressed={items.bold.isActive}
disabled={!items.bold.canExec}
onClick={items.bold.command}
tooltip="Bold"
>
<div className="i-lucide-bold h-5 w-5" />
</Button>
<Button
pressed={items.italic.isActive}
disabled={!items.italic.canExec}
onClick={items.italic.command}
tooltip="Italic"
>
<div className="i-lucide-italic h-5 w-5" />
</Button>
<Button
pressed={items.heading1.isActive}
disabled={!items.heading1.canExec}
onClick={items.heading1.command}
tooltip="Heading 1"
>
<div className="i-lucide-heading-1 h-5 w-5" />
</Button>
<Button
pressed={items.heading2.isActive}
disabled={!items.heading2.canExec}
onClick={items.heading2.command}
tooltip="Heading 2"
>
<div className="i-lucide-heading-2 h-5 w-5" />
</Button>
<Button
pressed={items.heading3.isActive}
disabled={!items.heading3.canExec}
onClick={items.heading3.command}
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>
)
}