Example: list-custom-checkbox
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import {
createEditor,
type NodeJSON,
} from 'prosekit/core'
import { ProseKit } from 'prosekit/react'
import { useMemo } from 'react'
import { defineExtension } from './extension'
import Toolbar from './toolbar'
export default function Editor() {
const editor = useMemo(() => {
return createEditor({ extension: defineExtension(), defaultContent })
}, [])
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>
)
}
const defaultContent: NodeJSON = {
type: 'doc',
content: [
{
type: 'paragraph',
content: [{ type: 'text', text: 'Custom list checkbox design and strikethrough for completed tasks.' }],
},
{
type: 'list',
attrs: { kind: 'task', checked: true },
content: [
{ type: 'paragraph', content: [{ type: 'text', text: 'Completed Task' }] },
],
},
{
type: 'list',
attrs: { kind: 'task', checked: false },
content: [
{ type: 'paragraph', content: [{ type: 'text', text: 'Incomplete Task' }] },
],
},
],
}
import { defineBaseKeymap } from 'prosekit/core'
import { union } from 'prosekit/core'
import { defineDoc } from 'prosekit/extensions/doc'
import { defineList } from 'prosekit/extensions/list'
import { defineParagraph } from 'prosekit/extensions/paragraph'
import { defineText } from 'prosekit/extensions/text'
import { defineCustomList } from './custom-list'
export function defineExtension() {
return union(
defineBaseKeymap(),
defineDoc(),
defineText(),
defineParagraph(),
defineList(),
defineCustomList(),
)
}
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 {
bullet: {
isActive: editor.nodes.list.isActive({ kind: 'bullet' }),
canExec: editor.commands.toggleList.canExec({ kind: 'bullet' }),
command: () => editor.commands.toggleList({ kind: 'bullet' }),
},
ordered: {
isActive: editor.nodes.list.isActive({ kind: 'ordered' }),
canExec: editor.commands.toggleList.canExec({ kind: 'ordered' }),
command: () => editor.commands.toggleList({ kind: 'ordered' }),
},
task: {
isActive: editor.nodes.list.isActive({ kind: 'task' }),
canExec: editor.commands.toggleList.canExec({ kind: 'task' }),
command: () => editor.commands.toggleList({ kind: 'task' }),
},
toggle: {
isActive: editor.nodes.list.isActive({ kind: 'toggle' }),
canExec: editor.commands.toggleList.canExec({ kind: 'toggle' }),
command: () => editor.commands.toggleList({ kind: 'toggle' }),
},
}
}
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.bullet.isActive}
disabled={!items.bullet.canExec}
onClick={items.bullet.command}
>
<div className="i-lucide-list h-5 w-5" />
</Button>
<Button
pressed={items.ordered.isActive}
disabled={!items.ordered.canExec}
onClick={items.ordered.command}
>
<div className="i-lucide-list-ordered h-5 w-5" />
</Button>
<Button
pressed={items.task.isActive}
disabled={!items.task.canExec}
onClick={items.task.command}
>
<div className="i-lucide-list-checks h-5 w-5" />
</Button>
<Button
pressed={items.toggle.isActive}
disabled={!items.toggle.canExec}
onClick={items.toggle.command}
>
<div className="i-lucide-list-collapse h-5 w-5" />
</Button>
</div>
)
}
.ProseMirror .prosemirror-flat-list[data-list-kind="task"][data-list-checked] {
color: rgb(150, 150, 150);
text-decoration: line-through;
text-decoration-color: rgb(150, 150, 150, 0.5);
}
import './custom-list.css'
import { defineNodeSpec } from 'prosekit/core'
import type {
DOMOutputSpec,
ProseMirrorNode,
} from 'prosekit/pm/model'
import { listToDOM } from 'prosemirror-flat-list'
import type { ListAttributes } from 'prosemirror-flat-list'
export function defineCustomList() {
return defineNodeSpec({
name: 'list',
toDOM: (node) => {
const { kind } = node.attrs as ListAttributes
if (kind === 'task') {
return listToDOM({ node, getMarkers: getTaskMarkers })
} else {
return listToDOM({ node })
}
},
})
}
export function getTaskMarkers(node: ProseMirrorNode): DOMOutputSpec[] {
const { checked } = node.attrs as ListAttributes
return [
[
'div',
{ class: 'inline-flex items-center box-border relative' },
[
'label',
{
class: 'flex items-center cursor-pointer relative box-border -bottom-0.5 -left-1 hover:scale-110 transition',
},
[
'input',
{
type: 'checkbox',
checked: checked ? '' : undefined,
class:
'size-5 cursor-pointer transition-all appearance-none rounded-md shadow-sm hover:shadow-md border border-solid border-gray-300 dark:border-gray-600 checked:bg-red-500 checked:border-red-500 box-border m-0',
},
],
[
'span',
{
'data-checked': checked ? 'true' : 'false',
'class': 'absolute text-white opacity-0 data-[checked=true]:opacity-100',
},
['div', { class: 'i-lucide-check size-5' }],
],
],
],
]
}
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>
)
}