# react-example-full

> Full-featured editor with most available features enabled.

A shadcn/ui block from the [@prosekit](https://prosekit.dev) registry, listed on [shadcn.exchange](https://shadcn.exchange/r/prosekit/react-example-full).

- Page, with a live preview: https://shadcn.exchange/r/prosekit/react-example-full
- Screenshot: https://abzjhwgwpdpz7ua5.public.blob.vercel-storage.com/shots/prosekit/react-example-full-light-9c59516677174678.png
- Registry item: https://prosekit.dev/r/react-example-full.json
- Listed: 2026-10-13, source last changed 2026-10-13

## Install

```bash
npx shadcn@latest add https://prosekit.dev/r/react-example-full.json
```

Run it in a project that has shadcn/ui set up. It adds the files below and installs what they depend on.

## Dependencies

- npm packages: `prosekit`
- Registry items: `https://unpkg.com/prosekit-registry/dist/r/react-sample-katex.json`, `https://unpkg.com/prosekit-registry/dist/r/react-sample-sample-doc-full.json`, `https://unpkg.com/prosekit-registry/dist/r/react-sample-sample-tag-data.json`, `https://unpkg.com/prosekit-registry/dist/r/react-sample-sample-uploader.json`, `https://unpkg.com/prosekit-registry/dist/r/react-sample-sample-user-data.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-block-handle.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-code-block-view.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-drop-indicator.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-image-view.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-inline-menu.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-slash-menu.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-table-handle.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-tag-menu.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-toolbar.json`, `https://unpkg.com/prosekit-registry/dist/r/react-ui-user-menu.json`

## Files

### `registry/src/react/examples/full/editor.tsx`

```tsx
'use client'

import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'

import { createEditor, type NodeJSON } from 'prosekit/core'
import { ProseKit } from 'prosekit/react'
import { useMemo } from 'react'

import { sampleContent } from '../../sample/sample-doc-full.ts'
import { tags } from '../../sample/sample-tag-data.ts'
import { sampleUploader } from '../../sample/sample-uploader.ts'
import { users } from '../../sample/sample-user-data.ts'
import { BlockHandle } from '../../ui/block-handle/index.ts'
import { DropIndicator } from '../../ui/drop-indicator/index.ts'
import { InlineMenu } from '../../ui/inline-menu/index.ts'
import { SlashMenu } from '../../ui/slash-menu/index.ts'
import { TableHandle } from '../../ui/table-handle/index.ts'
import { TagMenu } from '../../ui/tag-menu/index.ts'
import { Toolbar } from '../../ui/toolbar/index.ts'
import { UserMenu } from '../../ui/user-menu/index.ts'

import { defineExtension } from './extension.ts'

interface EditorProps {
  initialContent?: NodeJSON
}

export default function Editor(props: EditorProps) {
  const defaultContent = props.initialContent ?? sampleContent
  const editor = useMemo(() => {
    const extension = defineExtension()
    return createEditor({ extension, defaultContent })
  }, [defaultContent])

  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-[canvas] text-black dark:text-white">
        <Toolbar uploader={sampleUploader} />
        <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>
          <InlineMenu />
          <SlashMenu />
          <UserMenu users={users} />
          <TagMenu tags={tags} />
          <BlockHandle />
          <TableHandle />
          <DropIndicator />
        </div>
      </div>
    </ProseKit>
  )
}
```

### `registry/src/react/examples/full/extension.ts`

```ts
import { defineBasicExtension } from 'prosekit/basic'
import { union } from 'prosekit/core'
import { defineCodeBlockShiki } from 'prosekit/extensions/code-block'
import { defineHorizontalRule } from 'prosekit/extensions/horizontal-rule'
import { defineImageUploadHandler } from 'prosekit/extensions/image'
import { defineMath } from 'prosekit/extensions/math'
import { defineMention } from 'prosekit/extensions/mention'
import { definePlaceholder } from 'prosekit/extensions/placeholder'

import { renderKaTeXMathBlock, renderKaTeXMathInline } from '../../sample/katex.ts'
import { sampleUploader } from '../../sample/sample-uploader.ts'
import { defineCodeBlockView } from '../../ui/code-block-view/index.ts'
import { defineImageView } from '../../ui/image-view/index.ts'

export function defineExtension() {
  return union(
    defineBasicExtension(),
    definePlaceholder({ placeholder: 'Press / for commands...' }),
    defineMention(),
    defineMath({ renderMathBlock: renderKaTeXMathBlock, renderMathInline: renderKaTeXMathInline }),
    defineCodeBlockShiki(),
    defineHorizontalRule(),
    defineCodeBlockView(),
    defineImageView(),
    defineImageUploadHandler({
      uploader: sampleUploader,
    }),
  )
}

export type EditorExtension = ReturnType<typeof defineExtension>
```

### `registry/src/react/examples/full/html.ts`

````ts
import { createEditor, type NodeJSON } from 'prosekit/core'

import { sampleContent } from '../../sample/sample-doc-full.ts'

import { defineExtension } from './extension.ts'

/**
 * Renders a ProseMirror document JSON object to an HTML string.
 *
 * This is useful for server-side rendering.
 *
 * @example
 *
 * ```js
 * import { JSDOM } from 'jsdom'
 * const dom = new JSDOM('')
 * const document = dom.window.document
 * const html = renderHTML(document, myContentJSON)
 * ```
 */
export function renderHTML(document: Document, content: NodeJSON = sampleContent): string {
  const extension = defineExtension()
  const editor = createEditor({ extension })
  editor.setContent(content)
  const html: string = editor.getDocHTML({ document })
  if (html.startsWith('<div>') && html.endsWith('</div>')) {
    return html.slice(5, -6) // Remove the wrapping <div> tags
  } else {
    console.error('Unexpected HTML format: expected a single <div> wrapper')
    return html
  }
}
````

### `registry/src/react/examples/full/index.ts`

```ts
export { default as ExampleEditor } from './editor.tsx'
export { renderHTML } from './html.ts'
```