Skip to content
aq-ui
Back to HooksHook

Use Rich Text Editor

Open-code aq-ui React hook for Use Rich Text Editor.

Installation

pnpm dlx aq-ui@alpha add use-rich-text-editor

API reference

Client moduleView full source

Quick start

"use client"

import { useRichTextEditor } from "@/hooks/use-rich-text-editor"

const result = useRichTextEditor()

Exports

  • attachmentNode const
  • createRichTextExtensions function
  • CreateRichTextExtensionsOptions interface
  • emptyRichTextDocument const
  • RichTextDocument type
  • RichTextMentionItem interface
  • RichTextMentionProvider type
  • RichTextUpload interface
  • RichTextUploadStatus type
  • safeEditorAssetUrl function
  • safeEditorLinkUrl function
  • useRichTextEditor function
  • UseRichTextEditorOptions interface

Registry dependencies

code-highlighter, upload

Package dependencies

@tiptap/core@^3.30.1, @tiptap/extension-code-block-lowlight@^3.30.1, @tiptap/extension-file-handler@^3.30.1, @tiptap/extension-highlight@^3.30.1, @tiptap/extension-image@^3.30.1, @tiptap/extension-list@^3.30.1, @tiptap/extension-mention@^3.30.1, @tiptap/extension-table@^3.30.1, @tiptap/extension-text-align@^3.30.1, @tiptap/extensions@^3.30.1, @tiptap/react@^3.30.1, @tiptap/starter-kit@^3.30.1

Files

  • hooks/use-rich-text-editor.ts

Source