svelte-example-keymap

PreviousNext

Custom keyboard shortcuts and key bindings.

Docs
prosekitblock

Preview

Loading preview…
registry/src/svelte/examples/keymap/editor.svelte
<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 })

let submissions = $state<string[]>([])

function pushSubmission(hotkey: string) {
  const docString = JSON.stringify(editor.getDocJSON())
  const submission = `${new Date().toISOString()}\t${hotkey}\n${docString}`
  submissions = [...submissions, submission]
}
</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">
    <Toolbar onSubmit={pushSubmission} />
    <div class="relative w-full flex-1 box-border overflow-y-auto">
      <div {@attach 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>
  <fieldset class="mt-4 box-border flex max-w-full w-full overflow-x-auto border p-4 rounded-md shadow-sm min-w-0">
    <legend>Submit Records</legend>
    <ol>
      {#each submissions as submission, index (index)}
        <li>
          <pre>{submission}</pre>
        </li>
      {/each}
    </ol>
    {#if submissions.length === 0}
      <div>No submissions yet</div>
    {/if}
  </fieldset>
</ProseKit>

Installation

npx shadcn@latest add @prosekit/svelte-example-keymap

Usage

import { SvelteExampleKeymap } from "@/components/svelte-example-keymap"
<SvelteExampleKeymap />