Example: readonly
import 'prosekit/basic/style.css' import 'prosekit/basic/typography.css' import { useMemo } from 'preact/hooks' import { createEditor } from 'prosekit/core' import { ProseKit } from 'prosekit/preact' import { defineExtension } from './extension' import Toolbar from './toolbar' export default function Editor() { const editor = useMemo(() => { return createEditor({ extension: defineExtension() }) }, []) 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 { defineBasicExtension } from 'prosekit/basic' export function defineExtension() { return defineBasicExtension() } export type EditorExtension = ReturnType<typeof defineExtension>
import Button from './button' import { useReadonly } from './use-readonly' export default function Toolbar() { const { readonly, setReadonly } = useReadonly() return ( <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={readonly} onClick={() => setReadonly(true)}> Readonly </Button> <Button pressed={!readonly} onClick={() => setReadonly(false)}> Editable </Button> </div> ) }
import { useMemo, useState, } from 'preact/hooks' import { defineReadonly } from 'prosekit/extensions/readonly' import { useExtension } from 'prosekit/preact' export function useReadonly() { const [readonly, setReadonly] = useState(true) const extension = useMemo(() => { return readonly ? defineReadonly() : null }, [readonly]) useExtension(extension) return { readonly, setReadonly } }
import type { ComponentChild } from 'preact' export default function Button({ pressed, disabled, onClick, children, }: { pressed?: boolean disabled?: boolean onClick: VoidFunction children: ComponentChild }) { return ( <button data-state={pressed ? 'on' : 'off'} disabled={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' > {children} </button> ) }
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(() => { return createEditor({ extension: defineExtension(), defaultContent: 'The content is readonly. Press the buttons above to toggle the readonly mode.', }) }, []) 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 { defineBasicExtension } from 'prosekit/basic' export function defineExtension() { return defineBasicExtension() } export type EditorExtension = ReturnType<typeof defineExtension>
import Button from './button' import { useReadonly } from './use-readonly' export default function Toolbar() { const { readonly, setReadonly } = useReadonly() 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={readonly} onClick={() => setReadonly(true)}> Readonly </Button> <Button pressed={!readonly} onClick={() => setReadonly(false)}> Editable </Button> </div> ) }
import { defineReadonly } from 'prosekit/extensions/readonly' import { useExtension } from 'prosekit/react' import { useMemo, useState, } from 'react' export function useReadonly() { const [readonly, setReadonly] = useState(true) const extension = useMemo(() => { return readonly ? defineReadonly() : null }, [readonly]) useExtension(extension) return { readonly, setReadonly } }
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> ) }
import 'prosekit/basic/style.css' import 'prosekit/basic/typography.css' import { createEditor } from 'prosekit/core' import { ProseKit } from 'prosekit/solid' import { defineExtension } from './extension' import Toolbar from './toolbar' export default function Editor() { const editor = createEditor({ extension: defineExtension(), defaultContent: 'The content is readonly. Press the buttons above to toggle the readonly mode.', }) return ( <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 dark:border-gray-700 shadow flex flex-col bg-white dark:bg-gray-950 color-black dark:color-white'> <Toolbar /> <div class='relative w-full flex-1 box-border overflow-y-scroll'> <div ref={editor.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' export function defineExtension() { return defineBasicExtension() } export type EditorExtension = ReturnType<typeof defineExtension>
import Button from './button' import { useReadonly } from './use-readonly' export default function Toolbar() { const { getReadonly, setReadonly } = useReadonly() return ( <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={getReadonly} disabled={() => !true} onClick={() => setReadonly(true)} > Readonly </Button> <Button pressed={() => !getReadonly()} disabled={() => !true} onClick={() => setReadonly(false)} > Editable </Button> </div> ) }
import { defineReadonly } from 'prosekit/extensions/readonly' import { useExtension } from 'prosekit/solid' import { createSignal } from 'solid-js' export function useReadonly() { const [getReadonly, setReadonly] = createSignal(true) const getExtension = () => (getReadonly() ? defineReadonly() : null) useExtension(getExtension) return { getReadonly, setReadonly } }
import type { ParentProps } from 'solid-js' export default function Button({ pressed, disabled, onClick, children, }: ParentProps<{ pressed: () => boolean disabled?: () => boolean onClick: () => void }>) { return ( <button data-state={pressed() ? 'on' : 'off'} disabled={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' > {children} </button> ) }
<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 editor = createEditor({ extension: defineExtension(), defaultContent: 'The content is readonly. Press the buttons above to toggle the readonly mode.', }) 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 dark:border-gray-700 shadow flex flex-col bg-white dark:bg-gray-950 color-black dark:color-white'> <Toolbar /> <div class='relative w-full flex-1 box-border overflow-y-scroll'> <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' export function defineExtension() { return defineBasicExtension() } export type EditorExtension = ReturnType<typeof defineExtension>
<script lang="ts"> import Button from './button.svelte' import { useReadonly } from './use-readonly' const { readonly } = useReadonly() </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={$readonly} onClick={() => ($readonly = true)}> Readonly </Button> <Button pressed={!$readonly} onClick={() => ($readonly = false)}> Editable </Button> </div>
import { defineReadonly } from 'prosekit/extensions/readonly' import { useExtension } from 'prosekit/svelte' import { derived, writable, type Writable, } from 'svelte/store' export function useReadonly() { const readonly: Writable<boolean> = writable(true) const extension = derived(readonly, ($readonly) => $readonly ? defineReadonly() : null) useExtension(extension) return { readonly } }
<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(), defaultContent: 'The content is readonly. Press the buttons above to toggle the readonly mode.', }) 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 dark:border-gray-700 shadow flex flex-col bg-white dark:bg-gray-950 color-black dark:color-white'> <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' export function defineExtension() { return defineBasicExtension() } export type EditorExtension = ReturnType<typeof defineExtension>
<script setup lang="ts"> import Button from './button.vue' import { useReadonly } from './use-readonly' const { readonly } = useReadonly() </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="readonly" @click="() => (readonly = true)"> Readonly </Button> <Button :pressed="!readonly" @click="() => (readonly = false)"> Editable </Button> </div> </template>
import { defineReadonly } from 'prosekit/extensions/readonly' import { useExtension } from 'prosekit/vue' import { computed, ref, } from 'vue' export function useReadonly() { const readonly = ref(true) const extension = computed(() => (readonly.value ? defineReadonly() : null)) useExtension(extension) return { readonly } }
<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>