Example: toolbar
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
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 Editor() {
const editor = useMemo(() => {
const extension = defineExtension()
return createEditor({ extension })
}, [])
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 shadow dark:border-zinc-700 flex flex-col bg-white dark:bg-gray-950'>
<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 { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
export function defineExtension() {
return union(defineBasicExtension())
}
export type EditorExtension = ReturnType<typeof defineExtension>
import { useEditor } from 'prosekit/react'
import Button from './button'
import type { EditorExtension } from './extension'
import { ImageUploadPopover } from './image-upload-popover'
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>
<ImageUploadPopover
disabled={!editor.commands.insertImage.canExec()}
tooltip="Insert Image"
>
<div className='i-lucide-image h-5 w-5' />
</ImageUploadPopover>
</div>
)
}
import { useEditor } from 'prosekit/react'
import {
PopoverContent,
PopoverRoot,
PopoverTrigger,
} from 'prosekit/react/popover'
import {
useState,
type FC,
type ReactNode,
} from 'react'
import Button from './button'
import type { EditorExtension } from './extension'
export const ImageUploadPopover: FC<{
tooltip: string
disabled: boolean
children: ReactNode
}> = ({ tooltip, disabled, children }) => {
const [open, setOpen] = useState(false)
const [webUrl, setWebUrl] = useState('')
const [objectUrl, setObjectUrl] = useState('')
const url = webUrl || objectUrl
const editor = useEditor<EditorExtension>()
const handleFileChange: React.ChangeEventHandler<HTMLInputElement> = (
event,
) => {
const file = event.target.files?.[0]
if (file) {
setObjectUrl(URL.createObjectURL(file))
setWebUrl('')
} else {
setObjectUrl('')
}
}
const handleWebUrlChange: React.ChangeEventHandler<HTMLInputElement> = (
event,
) => {
const url = event.target.value
if (url) {
setWebUrl(url)
setObjectUrl('')
} else {
setWebUrl('')
}
}
const deferResetState = () => {
setTimeout(() => {
setWebUrl('')
setObjectUrl('')
}, 300)
}
const handleSubmit = () => {
editor.commands.insertImage({ src: url })
deferResetState()
setOpen(false)
}
const handleOpenChange = (open: boolean) => {
if (!open) {
deferResetState()
}
setOpen(open)
}
return (
<PopoverRoot open={open} onOpenChange={handleOpenChange}>
<PopoverTrigger>
<Button pressed={open} disabled={disabled} tooltip={tooltip}>
{children}
</Button>
</PopoverTrigger>
<PopoverContent className='flex flex-col gap-y-4 p-6 text-sm w-sm z-10 box-border rounded-lg border border-gray-200 dark:border-gray-800 bg-white dark:bg-gray-950 shadow-lg [&: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'>
{objectUrl ? null : (
<>
<label>Embed Link</label>
<input
className='flex h-9 rounded-md w-full bg-white dark:bg-gray-950 px-3 py-2 text-sm placeholder:text-gray-500 dark:placeholder:text-gray-500 transition border box-border border-gray-200 dark:border-gray-800 border-solid ring-0 ring-transparent focus-visible:ring-2 focus-visible:ring-gray-900 dark:focus-visible:ring-gray-300 focus-visible:ring-offset-0 outline-none focus-visible:outline-none file:border-0 file:bg-transparent file:text-sm file:font-medium disabled:cursor-not-allowed disabled:opacity-50'
placeholder="Paste the image link..."
type="url"
value={webUrl}
onChange={handleWebUrlChange}
/>
</>
)}
{webUrl ? null : (
<>
<label>Upload</label>
<input
className='flex h-9 rounded-md w-full bg-white dark:bg-gray-950 px-3 py-2 text-sm placeholder:text-gray-500 dark:placeholder:text-gray-500 transition border box-border border-gray-200 dark:border-gray-800 border-solid ring-0 ring-transparent focus-visible:ring-2 focus-visible:ring-gray-900 dark:focus-visible:ring-gray-300 focus-visible:ring-offset-0 outline-none focus-visible:outline-none file:border-0 file:bg-transparent file:text-sm file:font-medium disabled:cursor-not-allowed disabled:opacity-50'
accept="image/*"
type="file"
onChange={handleFileChange}
/>
</>
)}
{url
? (
<button className='inline-flex items-center justify-center whitespace-nowrap rounded-md text-sm font-medium ring-offset-white dark:ring-offset-gray-950 transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-gray-900 dark:focus-visible:ring-gray-300 focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 border-0 bg-gray-900 dark:bg-gray-50 text-gray-50 dark:text-gray-900 hover:bg-gray-900/90 dark:hover:bg-gray-50/90 h-10 px-4 py-2 w-full' onClick={handleSubmit}>
Insert Image
</button>
)
: null}
</PopoverContent>
</PopoverRoot>
)
}
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>
)
}
<script lang="ts">
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { createEditor } from 'prosekit/core'
import { ProseKit } from 'prosekit/svelte'
import { defineExtension } from './extension'
import Toolbar from './toolbar.svelte'
const extension = defineExtension()
const editor = createEditor({ extension })
const mount = (element: HTMLElement) => {
editor.mount(element)
return { destroy: () => editor.unmount() }
}
</script>
<ProseKit {editor}>
<div class='box-border h-full w-full min-h-36 overflow-y-hidden overflow-x-hidden rounded-md border border-solid border-gray-200 shadow dark:border-zinc-700 flex flex-col bg-white dark:bg-gray-950'>
<div class='relative w-full flex-1 box-border overflow-y-scroll'>
<Toolbar />
<div use:mount class='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 { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
export function defineExtension() {
return union(defineBasicExtension())
}
export type EditorExtension = ReturnType<typeof defineExtension>
<script lang="ts">
import { useEditor } from 'prosekit/svelte'
import Button from './button.svelte'
import type { EditorExtension } from './extension'
const editor = useEditor<EditorExtension>({ update: true })
</script>
<div class='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()}
>
<div class='i-lucide-undo-2 h-5 w-5'></div>
</Button>
<Button
pressed={false}
disabled={!$editor.commands.redo.canExec()}
onClick={() => $editor.commands.redo()}
>
<div class='i-lucide-redo-2 h-5 w-5'></div>
</Button>
<Button
pressed={$editor.marks.bold.isActive()}
disabled={!$editor.commands.toggleBold.canExec()}
onClick={() => $editor.commands.toggleBold()}
>
<div class='i-lucide-bold h-5 w-5'></div>
</Button>
<Button
pressed={$editor.marks.italic.isActive()}
disabled={!$editor.commands.toggleItalic.canExec()}
onClick={() => $editor.commands.toggleItalic()}
>
<div class='i-lucide-italic h-5 w-5'></div>
</Button>
<Button
pressed={$editor.nodes.heading.isActive({ level: 1 })}
disabled={!$editor.commands.toggleHeading.canExec({ level: 1 })}
onClick={() => $editor.commands.toggleHeading({ level: 1 })}
>
<div class='i-lucide-heading-1 h-5 w-5'></div>
</Button>
<Button
pressed={$editor.nodes.heading.isActive({ level: 2 })}
disabled={!$editor.commands.toggleHeading.canExec({ level: 2 })}
onClick={() => $editor.commands.toggleHeading({ level: 2 })}
>
<div class='i-lucide-heading-2 h-5 w-5'></div>
</Button>
<Button
pressed={$editor.nodes.heading.isActive({ level: 3 })}
disabled={!$editor.commands.toggleHeading.canExec({ level: 3 })}
onClick={() => $editor.commands.toggleHeading({ level: 3 })}
>
<div class='i-lucide-heading-3 h-5 w-5'></div>
</Button>
</div>
<script lang="ts">
import {
TooltipContent,
TooltipRoot,
TooltipTrigger,
} from 'prosekit/svelte/tooltip'
import type { Snippet } from 'svelte'
interface Props {
pressed?: boolean
disabled?: boolean
tooltip?: string
onClick?: VoidFunction
children?: Snippet
}
let {
pressed = false,
disabled = false,
tooltip = '',
onClick = undefined,
children,
}: Props = $props()
</script>
<TooltipRoot>
<TooltipTrigger class='block'>
<button
data-state={pressed ? 'on' : 'off'}
{disabled}
onclick={() => onClick?.()}
onmousedown={(event) => event.preventDefault()}
class='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'
>
{@render children?.()}
{#if tooltip}
<span class="sr-only">{tooltip}</span>
{/if}
</button>
</TooltipTrigger>
{#if tooltip}
<TooltipContent class='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>
{/if}
</TooltipRoot>
<script setup lang="ts">
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { createEditor } from 'prosekit/core'
import { ProseKit } from 'prosekit/vue'
import {
ref,
watchPostEffect,
} from 'vue'
import { defineExtension } from './extension'
import Toolbar from './toolbar.vue'
const editor = createEditor({ extension: defineExtension() })
const editorRef = ref<HTMLDivElement | null>(null)
watchPostEffect((onCleanup) => {
editor.mount(editorRef.value)
onCleanup(() => editor.unmount())
})
</script>
<template>
<ProseKit :editor="editor">
<div class='box-border h-full w-full min-h-36 overflow-y-hidden overflow-x-hidden rounded-md border border-solid border-gray-200 shadow dark:border-zinc-700 flex flex-col bg-white dark:bg-gray-950'>
<Toolbar />
<div class='relative w-full flex-1 box-border overflow-y-scroll'>
<div ref="editorRef" class='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>
</ProseKit>
</template>
import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
export function defineExtension() {
return union(defineBasicExtension())
}
export type EditorExtension = ReturnType<typeof defineExtension>
<script setup lang="ts">
import { useEditor } from 'prosekit/vue'
import Button from './button.vue'
import type { EditorExtension } from './extension'
const editor = useEditor<EditorExtension>({ update: true })
</script>
<template>
<div class='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()"
@click="() => editor.commands.undo()"
>
<div class='i-lucide-undo-2 h-5 w-5' />
</Button>
<Button
:pressed="false"
:disabled="!editor.commands.redo.canExec()"
@click="() => editor.commands.redo()"
>
<div class='i-lucide-redo-2 h-5 w-5' />
</Button>
<Button
:pressed="editor.marks.bold.isActive()"
:disabled="!editor.commands.toggleBold.canExec()"
@click="() => editor.commands.toggleBold()"
>
<div class='i-lucide-bold h-5 w-5' />
</Button>
<Button
:pressed="editor.marks.italic.isActive()"
:disabled="!editor.commands.toggleItalic.canExec()"
@click="() => editor.commands.toggleItalic()"
>
<div class='i-lucide-italic h-5 w-5' />
</Button>
<Button
:pressed="editor.nodes.heading.isActive({ level: 1 })"
:disabled="!editor.commands.toggleHeading.canExec({ level: 1 })"
@click="() => editor.commands.toggleHeading({ level: 1 })"
>
<div class='i-lucide-heading-1 h-5 w-5' />
</Button>
<Button
:pressed="editor.nodes.heading.isActive({ level: 2 })"
:disabled="!editor.commands.toggleHeading.canExec({ level: 2 })"
@click="() => editor.commands.toggleHeading({ level: 2 })"
>
<div class='i-lucide-heading-2 h-5 w-5' />
</Button>
<Button
:pressed="editor.nodes.heading.isActive({ level: 3 })"
:disabled="!editor.commands.toggleHeading.canExec({ level: 3 })"
@click="() => editor.commands.toggleHeading({ level: 3 })"
>
<div class='i-lucide-heading-3 h-5 w-5' />
</Button>
</div>
</template>
<script setup lang="ts">
import {
TooltipContent,
TooltipRoot,
TooltipTrigger,
} from 'prosekit/vue/tooltip'
defineProps<{
pressed?: Boolean
disabled?: Boolean
tooltip?: string
}>()
const emit = defineEmits<{
click: []
}>()
</script>
<template>
<TooltipRoot>
<TooltipTrigger class='block'>
<button
:data-state="pressed ? 'on' : 'off'"
:disabled="disabled ? true : undefined"
class='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'
@click="() => emit('click')"
@mousedown.prevent
>
<slot />
<span v-if="tooltip" class="sr-only">{{ tooltip }}</span>
</button>
</TooltipTrigger>
<TooltipContent v-if="tooltip" class='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>
</TooltipRoot>
</template>