Example: save-html
Install this example with
shadcn:npx shadcn@latest add @prosekit/react-example-save-htmlnpx shadcn@latest add @prosekit/preact-example-save-htmlnpx shadcn@latest add @prosekit/svelte-example-save-htmlnpx shadcn@latest add @prosekit/vue-example-save-htmlimport 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import {
useCallback,
useMemo,
useState,
} from 'preact/hooks'
import { defineBasicExtension } from 'prosekit/basic'
import {
createEditor,
jsonFromHTML,
} from 'prosekit/core'
import {
ProseKit,
useDocChange,
} from 'prosekit/preact'
export default function Editor() {
// A list of saved documents, stored as HTML strings
const [records, setRecords] = useState<string[]>([])
// Whether there are unsaved changes
const [hasUnsavedChange, setHasUnsavedChange] = useState(false)
// A key to force a re-render of the editor
const [key, setKey] = useState(1)
const editor = useMemo(() => {
const extension = defineBasicExtension()
return createEditor({ extension })
}, [])
const handleDocChange = useCallback(() => setHasUnsavedChange(true), [])
useDocChange(handleDocChange, { editor })
const handleSave = useCallback(() => {
const record = editor.getDocHTML()
setRecords((prev) => [...prev, record])
setHasUnsavedChange(false)
}, [editor])
const handleLoad = useCallback(
(record: string) => {
editor.setContent(jsonFromHTML(record, { schema: editor.schema }))
setHasUnsavedChange(false)
setKey((prev) => prev + 1)
},
[editor.schema],
)
return (
<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-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<button
onClick={handleSave}
disabled={!hasUnsavedChange}
className="m-1 border border-solid bg-white px-2 py-1 text-sm text-black disabled:cursor-not-allowed disabled:text-gray-500"
>
{hasUnsavedChange ? 'Save' : 'No changes to save'}
</button>
<ul className="border-b border-t border-solid text-sm">
{records.map((record, index) => (
<li key={index} className="m-1 flex gap-2">
<button
className="border border-solid bg-white px-2 py-1 text-black"
onClick={() => handleLoad(record)}
>
Load
</button>
<span className="flex-1 overflow-x-scroll p-2">
<pre>{record}</pre>
</span>
</li>
))}
</ul>
<ProseKit editor={editor} key={key}>
<div className="relative w-full flex-1 box-border overflow-y-auto">
<div ref={editor.mount} className="ProseMirror box-border min-h-full px-[max(4rem,calc(50%-20rem))] py-8 outline-hidden outline-0 [&_span[data-mention=user]]:text-blue-500 [&_span[data-mention=tag]]:text-violet-500"></div>
</div>
</ProseKit>
</div>
)
}export { default as ExampleEditor } from './editor'import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { defineBasicExtension } from 'prosekit/basic'
import {
createEditor,
jsonFromHTML,
} from 'prosekit/core'
import {
ProseKit,
useDocChange,
} from 'prosekit/react'
import {
useCallback,
useMemo,
useState,
} from 'react'
export default function Editor() {
// A list of saved documents, stored as HTML strings
const [records, setRecords] = useState<string[]>([])
// Whether there are unsaved changes
const [hasUnsavedChange, setHasUnsavedChange] = useState(false)
// A key to force a re-render of the editor
const [key, setKey] = useState(1)
const editor = useMemo(() => {
const extension = defineBasicExtension()
return createEditor({ extension })
}, [])
const handleDocChange = useCallback(() => setHasUnsavedChange(true), [])
useDocChange(handleDocChange, { editor })
const handleSave = useCallback(() => {
const record = editor.getDocHTML()
setRecords((prev) => [...prev, record])
setHasUnsavedChange(false)
}, [editor])
const handleLoad = useCallback(
(record: string) => {
editor.setContent(jsonFromHTML(record, { schema: editor.schema }))
setHasUnsavedChange(false)
setKey((prev) => prev + 1)
},
[editor.schema],
)
return (
<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-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<button
onClick={handleSave}
disabled={!hasUnsavedChange}
className="m-1 border border-solid bg-white px-2 py-1 text-sm text-black disabled:cursor-not-allowed disabled:text-gray-500"
>
{hasUnsavedChange ? 'Save' : 'No changes to save'}
</button>
<ul className="border-b border-t border-solid text-sm">
{records.map((record, index) => (
<li key={index} className="m-1 flex gap-2">
<button
className="border border-solid bg-white px-2 py-1 text-black"
onClick={() => handleLoad(record)}
>
Load
</button>
<span className="flex-1 overflow-x-scroll p-2">
<pre>{record}</pre>
</span>
</li>
))}
</ul>
<ProseKit editor={editor} key={key}>
<div className="relative w-full flex-1 box-border overflow-y-auto">
<div ref={editor.mount} className="ProseMirror box-border min-h-full px-[max(4rem,calc(50%-20rem))] py-8 outline-hidden outline-0 [&_span[data-mention=user]]:text-blue-500 [&_span[data-mention=tag]]:text-violet-500"></div>
</div>
</ProseKit>
</div>
)
}'use client'
export { default as ExampleEditor } from './editor'<script lang="ts">
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { defineBasicExtension } from 'prosekit/basic'
import {
createEditor,
jsonFromHTML,
} from 'prosekit/core'
import {
ProseKit,
useDocChange,
} from 'prosekit/svelte'
// A list of saved documents, stored as HTML strings
let records = $state<string[]>([])
// Whether there are unsaved changes
let hasUnsavedChange = $state(false)
// A key to force a re-render of the editor
let key = $state(1)
const extension = defineBasicExtension()
const editor = createEditor({ extension })
function handleDocChange() {
hasUnsavedChange = true
}
useDocChange(handleDocChange, { editor })
function handleSave() {
const record = editor.getDocHTML()
records = [...records, record]
hasUnsavedChange = false
}
function handleLoad(record: string) {
editor.setContent(jsonFromHTML(record, { schema: editor.schema }))
hasUnsavedChange = false
key += 1
}
const mount = (element: HTMLElement) => {
editor.mount(element)
return { destroy: () => editor.unmount() }
}
</script>
<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 dark:border-gray-700 shadow-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<button
disabled={!hasUnsavedChange}
class="m-1 border border-solid bg-white px-2 py-1 text-sm text-black disabled:cursor-not-allowed disabled:text-gray-500"
onclick={handleSave}
>
{hasUnsavedChange ? 'Save' : 'No changes to save'}
</button>
<ul class="border-b border-t border-solid text-sm">
{#each records as record, index (index)}
<li class="m-1 flex gap-2">
<button
class="border border-solid bg-white px-2 py-1 text-black"
onclick={() => handleLoad(record)}
>
Load
</button>
<span class="flex-1 overflow-x-scroll p-2">
<pre>{record}</pre>
</span>
</li>
{/each}
</ul>
{#key key}
<ProseKit {editor}>
<div class="relative w-full flex-1 box-border overflow-y-auto">
<div use:mount class="ProseMirror box-border min-h-full px-[max(4rem,calc(50%-20rem))] py-8 outline-hidden outline-0 [&_span[data-mention=user]]:text-blue-500 [&_span[data-mention=tag]]:text-violet-500"></div>
</div>
</ProseKit>
{/key}
</div>export { default as ExampleEditor } from './editor.svelte'<script setup lang="ts">
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { defineBasicExtension } from 'prosekit/basic'
import {
createEditor,
jsonFromHTML,
} from 'prosekit/core'
import {
ProseKit,
useDocChange,
} from 'prosekit/vue'
import {
ref,
watchPostEffect,
} from 'vue'
// A list of saved documents, stored as HTML strings
const records = ref<string[]>([])
// Whether there are unsaved changes
const hasUnsavedChange = ref(false)
// A key to force a re-render of the editor
const key = ref(1)
const extension = defineBasicExtension()
const editor = createEditor({ extension })
function handleDocChange() {
hasUnsavedChange.value = true
}
useDocChange(handleDocChange, { editor })
function handleSave() {
const record = editor.getDocHTML()
records.value = [...records.value, record]
hasUnsavedChange.value = false
}
function handleLoad(record: string) {
editor.setContent(jsonFromHTML(record, { schema: editor.schema }))
hasUnsavedChange.value = false
key.value += 1
}
const editorRef = ref<HTMLDivElement | null>(null)
watchPostEffect((onCleanup) => {
editor.mount(editorRef.value)
onCleanup(() => editor.unmount())
})
</script>
<template>
<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 dark:border-gray-700 shadow-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<button
:disabled="!hasUnsavedChange"
class="m-1 border border-solid bg-white px-2 py-1 text-sm text-black disabled:cursor-not-allowed disabled:text-gray-500"
@click="handleSave"
>
{{ hasUnsavedChange ? 'Save' : 'No changes to save' }}
</button>
<ul class="border-b border-t border-solid text-sm">
<li
v-for="(record, index) in records"
:key="index"
class="m-1 flex gap-2"
>
<button
class="border border-solid bg-white px-2 py-1 text-black"
@click="handleLoad(record)"
>
Load
</button>
<span class="flex-1 overflow-x-scroll p-2">
<pre>{{ record }}</pre>
</span>
</li>
</ul>
<ProseKit :key="key" :editor="editor">
<div class="relative w-full flex-1 box-border overflow-y-auto">
<div ref="editorRef" class="ProseMirror box-border min-h-full px-[max(4rem,calc(50%-20rem))] py-8 outline-hidden outline-0 [&_span[data-mention=user]]:text-blue-500 [&_span[data-mention=tag]]:text-violet-500"></div>
</div>
</ProseKit>
</div>
</template>export { default as ExampleEditor } from './editor.vue'