Skip to content

Tiptap Rich Text Editor — Developer Guide & Admin UI

Terminal window
pnpm add @vicacha-devs/strapi-plugin-tiptap-editor

2. Server Configuration (config/plugins.ts)

Section titled “2. Server Configuration (config/plugins.ts)”

Add the plugin configuration to your Strapi v5 config/plugins.ts file:

config/plugins.ts
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({
"tiptap-editor": {
enabled: true,
config: {
presets: {
editorial: { bold: true, italic: true, heading: { levels: [1, 2, 3] }, link: true, mediaLibrary: true, table: true },
},
settings: {
defaultPreset: "editorial",
defaultOutputFormat: "json",
enableRelationalSync: true,
},
},
},
});

Tiptap Rich Text Editor — Strapi v5 Settings Panel

Once enabled, the plugin registers its workspace and settings inside the Strapi v5 Admin panel using Strapi Design System v2 components:

Tiptap Rich Text Editor — Strapi v5 Admin UI

Translation Key Rendered UI Label
tiptap-editor.noPreset.message No editor preset configured — showing minimal editor
tiptap-editor.loading Loading editor…
tiptap-editor.more More
tiptap-editor.error.message The editor encountered an error and could not render.
tiptap-editor.error.retry Retry
tiptap-editor.richText.label Rich Text (Tiptap)
tiptap-editor.richText.description Use this field to create formatted text via Tiptap editor.
tiptap-editor.section.format.label Output & Content Format

4. Content-Type Entities, Locations & Schemas (strapi.documents)

Section titled “4. Content-Type Entities, Locations & Schemas (strapi.documents)”

Registers the plugin::tiptap-editor.RichText custom field in Content-Type Builder & Content Manager alongside Strapi core-store runtime settings (settings), optional links.links internal reference sync, and companion <FieldName>Media relational media tracking.

Where to Find Content-Type Entities in Strapi v5

Section titled “Where to Find Content-Type Entities in Strapi v5”
  • Content Manager Rich-Text Fields: /admin/content-manager (any Collection Type or Single Type field configured with custom field plugin::tiptap-editor.RichText)
  • Content-Type Builder Preset Selector: /admin/plugins/content-type-builder (PresetSelect, output format json | html | markdown, character limit, and placeholder options)
  • Global Settings Panel: /admin/settings/tiptap-editor (Settings -> Global Settings -> Tiptap Editor — runtime preset overrides, iframe domain allowlist, and relational sync)

This plugin operates dynamically across existing Strapi api::* and plugin::* Content-Type entities without creating separate collection tables.

Strapi v5 Content Manager Integration (/admin/content-manager)

Section titled “Strapi v5 Content Manager Integration (/admin/content-manager)”

Content Manager Sidebar Group: Operates Inside Every Content Manager Entry Using plugin::tiptap-editor.RichText

  • Custom Field plugin::tiptap-editor.RichText (attached to api::article.article, api::page.page, or any Collection/Single Type in /admin/content-manager)
  • Companion <FieldName>Media & <FieldName>Links fields automatically synchronized on edit (enableRelationalSync)
  • Settings Store plugin::tiptap-editor.settings (core-store managed via /admin/settings/tiptap-editor)

Tiptap Rich Text Editor — Strapi v5 Content Manager Entities & Editorial View

Why This Plugin Creates & Integrates Content Manager Entities

Section titled “Why This Plugin Creates & Integrates Content Manager Entities”

@vicacha-devs/strapi-plugin-tiptap-editor delivers a WCAG 2.1 AA WYSIWYG editing workspace directly inside Strapi v5 Content Manager edit views via custom field plugin::tiptap-editor.RichText without creating intrusive standalone tables:

  • Hybrid Code + Runtime Presets: Fields inherit code-first presets (minimal, default, full, edifice, or custom config/plugins.ts presets) and respect live overrides saved at /admin/settings/tiptap-editor.
  • Automatic Relational Media & Document Linker Sync: useRelationalSync extracts embedded Media Library assets (<FieldName>Media) and internal linker document references (<FieldName>Links) as editors type.
  • Zero-Data-Loss Fallback: Disabling an extension renders existing nodes read-only rather than dropping structured content on publish.

How to Use in Strapi Content Manager (Step-by-Step)

Section titled “How to Use in Strapi Content Manager (Step-by-Step)”
  1. Add the Custom Field in Content-Type Builder: Open /admin/plugins/content-type-builder, add custom field Rich Text (Tiptap) (plugin::tiptap-editor.RichText), and pick a preset and output format (json, html, or markdown).
  2. Edit Content in Content Manager: Open /admin/content-manager for the entry, format text using the roving toolbar, / slash menu, HTML5 Canvas image studio, voice recorder, or custom components, and click Publish.
  3. Review Global Overrides: Visit /admin/settings/tiptap-editor (Settings -> Global Settings -> Tiptap Editor) to tune allowed iframe domains and runtime feature toggles.

Content Manager & Plugin Workspace Synchronization

Section titled “Content Manager & Plugin Workspace Synchronization”

Content Manager Use Cases & Editorial Workflows

Section titled “Content Manager Use Cases & Editorial Workflows”

Content Manager Use Case 1 — Authoring Accessible Multilingual Rich Content & Linked Assets

Section titled “Content Manager Use Case 1 — Authoring Accessible Multilingual Rich Content & Linked Assets”
  • Why & What it is for: Compose localized articles in /admin/content-manager with WCAG language spans (dir='rtl'|'ltr'), semantic headings, internal document links, cropped images, and automatic relational asset tracking.
  • How to use in Content Manager: Open an entry in /admin/content-manager, switch locale via i18n, insert media/links/blocks in the RichText field, verify the inspector preview (JSON/HTML/Markdown), and click Publish.

Use Case 1 — Configuring Preset-Driven Rich-Text Fields & Output Formats (json, html, markdown)

Section titled “Use Case 1 — Configuring Preset-Driven Rich-Text Fields & Output Formats (json, html, markdown)”
  • What it is for: Bind fields on api::article.article or api::page.page to tailored TipTap presets (minimal, default, full, edifice, or custom presets in config/plugins.ts) with strict DOMPurify + URL sanitization.
  • How it works: Assign custom field plugin::tiptap-editor.RichText in Content-Type Builder (or fieldBindings in config), choose preset & output format, and edit richly in /admin/content-manager.

Tiptap Rich Text Editor — Strapi v5 Admin Workspace

Use Case 2 — Schema-Driven Custom Components, Multimedia Studio & Slash Commands

Section titled “Use Case 2 — Schema-Driven Custom Components, Multimedia Studio & Slash Commands”
  • What it is for: Let editors insert button CTA atoms, callouts (informationPane), accordions, multi-column grids, LaTeX math, HTML5 Canvas-cropped images, voice recordings, and / slash commands cleanly.
  • How it works: Register reusable components via registerRichTextComponent() or use built-in Edifice IO blocks inside /admin/content-manager with zero-data-loss fallback for unknown nodes.

Tiptap Rich Text Editor — Strapi v5 Content Manager Entities

Use Case 3 — Runtime Governance, Allowed Iframe Domains & SSRF-Safe Media Ingestion

Section titled “Use Case 3 — Runtime Governance, Allowed Iframe Domains & SSRF-Safe Media Ingestion”
  • What it is for: Manage global editor defaults, trusted iframe host allowlists, per-preset overrides (PUT /tiptap-editor/settings), link previews (GET /tiptap-editor/link-preview), and remote uploads (POST /tiptap-editor/upload-by-url) safely.
  • How it works: Open /admin/settings/tiptap-editor to toggle runtime overrides and configure allowedIframeDomains; remote URL lookups enforce DNS-pinned SSRF checks (isSsrfSafeUrl).

Tiptap Rich Text Editor — Strapi v5 Settings Panel

6. REST API Endpoints (content-api & admin)

Section titled “6. REST API Endpoints (content-api & admin)”
Method Endpoint Path Scope Controller Handler Auth
GET /tiptap-editor/presets admin preset.find Bearer JWT
GET /tiptap-editor/presets/{name} admin preset.findOne Bearer JWT
GET /tiptap-editor/theme admin theme.find Bearer JWT
GET /tiptap-editor/settings admin settings.find Bearer JWT
PUT /tiptap-editor/settings admin settings.update Bearer JWT
GET /tiptap-editor/search admin search.search Bearer JWT
GET /tiptap-editor/get/{collectionName}/{documentId} admin search.getDocument Bearer JWT
GET /tiptap-editor/identify/{collectionName} admin search.identify Bearer JWT
GET /tiptap-editor/link-preview admin media.linkPreview Bearer JWT
POST /tiptap-editor/upload-by-url admin media.uploadByUrl Bearer JWT

7. Programmatic Server Usage (strapi.plugin & strapi.documents)

Section titled “7. Programmatic Server Usage (strapi.plugin & strapi.documents)”
// Registered services on plugin "tiptap-editor": "preset", "theme", "settings", "search", "media"
const pluginService = strapi.plugin("tiptap-editor")?.service("preset");
// Retrieving plugin settings via Strapi plugin store
const store = strapi.store({ type: "plugin", name: "tiptap-editor" });
const settings = await store.get({ key: "settings" });
  • Admin panel changes not visible: Run pnpm strapi build after modifying config/plugins.ts.
  • Peer dependency isolation: Keep hoistPattern: ["*", "!@strapi/*"] in pnpm-workspace.yaml so @strapi/* contexts are never duplicated.
  • TypeScript type-checking: Validate both admin/tsconfig.json and server/tsconfig.json via pnpm --filter <pkg> test:ts.