Example: emoji-rules
Install this example with
shadcn:npx shadcn@latest add @prosekit/react-example-emoji-rulesnpx shadcn@latest add @prosekit/preact-example-emoji-rulesnpx shadcn@latest add @prosekit/solid-example-emoji-rulesnpx shadcn@latest add @prosekit/svelte-example-emoji-rulesnpx shadcn@latest add @prosekit/vue-example-emoji-rulesimport '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'
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 dark:border-gray-700 shadow-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<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>
</div>
</ProseKit>
)
}import { defineEnterRule } from 'prosekit/extensions/enter-rule'
/**
* Converts the text before the text cursor into an emoji when pressing `Enter`.
*/
export function defineEmojiEnterRule() {
return defineEnterRule({
regex: /:(apple|banana):$/,
handler: ({ match, from, to, state }) => {
const text = match[1] as 'apple' | 'banana'
const emoji = text === 'apple' ? '🍎' : '🍌'
return state.tr.replaceWith(from, to, state.schema.text(emoji))
},
})
}import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineEmojiEnterRule } from './emoji'
export function defineExtension() {
return union(
defineBasicExtension(),
defineEmojiEnterRule(),
definePlaceholder({ placeholder: 'Try typing :apple: then press Enter' }),
)
}
export type EditorExtension = ReturnType<typeof defineExtension>export { default as ExampleEditor } from './editor'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'
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 dark:border-gray-700 shadow-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<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>
</div>
</ProseKit>
)
}import { defineEnterRule } from 'prosekit/extensions/enter-rule'
/**
* Converts the text before the text cursor into an emoji when pressing `Enter`.
*/
export function defineEmojiEnterRule() {
return defineEnterRule({
regex: /:(apple|banana):$/,
handler: ({ match, from, to, state }) => {
const text = match[1] as 'apple' | 'banana'
const emoji = text === 'apple' ? '🍎' : '🍌'
return state.tr.replaceWith(from, to, state.schema.text(emoji))
},
})
}import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineEmojiEnterRule } from './emoji'
export function defineExtension() {
return union(
defineBasicExtension(),
defineEmojiEnterRule(),
definePlaceholder({ placeholder: 'Try typing :apple: then press Enter' }),
)
}
export type EditorExtension = ReturnType<typeof defineExtension>'use client'
export { default as ExampleEditor } from './editor'import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'
import { createEditor } from 'prosekit/core'
import { ProseKit } from 'prosekit/solid'
import type { JSX } from 'solid-js'
import { defineExtension } from './extension'
export default function Editor(): JSX.Element {
const extension = defineExtension()
const editor = createEditor({ extension })
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-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<div class="relative w-full flex-1 box-border overflow-y-auto">
<div ref={editor.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>
</div>
</ProseKit>
)
}import { defineEnterRule } from 'prosekit/extensions/enter-rule'
/**
* Converts the text before the text cursor into an emoji when pressing `Enter`.
*/
export function defineEmojiEnterRule() {
return defineEnterRule({
regex: /:(apple|banana):$/,
handler: ({ match, from, to, state }) => {
const text = match[1] as 'apple' | 'banana'
const emoji = text === 'apple' ? '🍎' : '🍌'
return state.tr.replaceWith(from, to, state.schema.text(emoji))
},
})
}import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineEmojiEnterRule } from './emoji'
export function defineExtension() {
return union(
defineBasicExtension(),
defineEmojiEnterRule(),
definePlaceholder({ placeholder: 'Try typing :apple: then press Enter' }),
)
}
export type EditorExtension = ReturnType<typeof defineExtension>export { default as ExampleEditor } from './editor'<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'
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 dark:border-gray-700 shadow-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<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>
</div>
</ProseKit>import { defineEnterRule } from 'prosekit/extensions/enter-rule'
/**
* Converts the text before the text cursor into an emoji when pressing `Enter`.
*/
export function defineEmojiEnterRule() {
return defineEnterRule({
regex: /:(apple|banana):$/,
handler: ({ match, from, to, state }) => {
const text = match[1] as 'apple' | 'banana'
const emoji = text === 'apple' ? '🍎' : '🍌'
return state.tr.replaceWith(from, to, state.schema.text(emoji))
},
})
}import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineEmojiEnterRule } from './emoji'
export function defineExtension() {
return union(
defineBasicExtension(),
defineEmojiEnterRule(),
definePlaceholder({ placeholder: 'Try typing :apple: then press Enter' }),
)
}
export type EditorExtension = ReturnType<typeof defineExtension>export { default as ExampleEditor } from './editor.svelte'<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'
const extension = defineExtension()
const editor = createEditor({ extension })
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-sm flex flex-col bg-white dark:bg-gray-950 text-black dark:text-white">
<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>
</template>import { defineEnterRule } from 'prosekit/extensions/enter-rule'
/**
* Converts the text before the text cursor into an emoji when pressing `Enter`.
*/
export function defineEmojiEnterRule() {
return defineEnterRule({
regex: /:(apple|banana):$/,
handler: ({ match, from, to, state }) => {
const text = match[1] as 'apple' | 'banana'
const emoji = text === 'apple' ? '🍎' : '🍌'
return state.tr.replaceWith(from, to, state.schema.text(emoji))
},
})
}import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineEmojiEnterRule } from './emoji'
export function defineExtension() {
return union(
defineBasicExtension(),
defineEmojiEnterRule(),
definePlaceholder({ placeholder: 'Try typing :apple: then press Enter' }),
)
}
export type EditorExtension = ReturnType<typeof defineExtension>export { default as ExampleEditor } from './editor.vue'