Saltearse al contenido

Editor de Texto Enriquecido Tiptap — Guía de Desarrollo y Admin UI

Ventana de terminal
pnpm add @vicacha-devs/strapi-plugin-tiptap-editor

2. Configuración del Servidor (config/plugins.ts)

Sección titulada «2. Configuración del Servidor (config/plugins.ts)»

Agregue la configuración del plugin en el archivo config/plugins.ts de su aplicación Strapi v5:

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,
},
},
},
});

Editor de Texto Enriquecido Tiptap — Strapi v5 Settings Panel

3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)

Sección titulada «3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)»

Una vez habilitado, el plugin registra su espacio de trabajo y ajustes dentro del panel de administración de Strapi v5 utilizando Strapi Design System v2:

Editor de Texto Enriquecido Tiptap — Strapi v5 Admin UI

Etiquetas Localizadas de la Interfaz (Español)

Sección titulada «Etiquetas Localizadas de la Interfaz (Español)»
Clave de Traducción Texto en Interfaz
tiptap-editor.noPreset.message No se ha configurado ningún ajuste preestablecido — mostrando el editor mínimo
tiptap-editor.loading Cargando editor…
tiptap-editor.more Más
tiptap-editor.error.message El editor encontró un error y no pudo renderizarse.
tiptap-editor.error.retry Reintentar
tiptap-editor.richText.label Texto enriquecido (Tiptap)
tiptap-editor.richText.description Utilice este campo para crear texto con formato mediante el editor Tiptap.
tiptap-editor.section.format.label Formato de salida y contenido

4. Entidades Content-Type, Ubicación y Esquemas (strapi.documents)

Sección titulada «4. Entidades Content-Type, Ubicación y Esquemas (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.

Dónde Encontrar las Entidades Content-Type en Strapi v5

Sección titulada «Dónde Encontrar las Entidades Content-Type en 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)

Este plugin opera dinámicamente sobre las entidades Content-Type existentes de Strapi (api::* y plugin::*).

Integración con el Content Manager de Strapi v5 (/admin/content-manager)

Sección titulada «Integración con el Content Manager de Strapi v5 (/admin/content-manager)»

Grupo en la Barra Lateral del Content Manager: Operates Inside Every Content Manager Entry Using plugin::tiptap-editor.RichText

Entidades y Componentes en el Content Manager

Sección titulada «Entidades y Componentes en el Content Manager»
  • 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)

Editor de Texto Enriquecido Tiptap — Vista de Entidades en el Content Manager de Strapi v5

Por Qué Este Plugin Crea e Integra Entidades en el Content Manager

Sección titulada «Por Qué Este Plugin Crea e Integra Entidades en el Content Manager»

@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.

Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)

Sección titulada «Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)»
  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.

Sincronización entre el Content Manager y el Espacio del Plugin

Sección titulada «Sincronización entre el Content Manager y el Espacio del Plugin»

Casos de Uso en el Content Manager y Flujos Editoriales

Sección titulada «Casos de Uso en el Content Manager y Flujos Editoriales»

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

Sección titulada «Content Manager Use Case 1 — Authoring Accessible Multilingual Rich Content & Linked Assets»
  • Para qué sirve y por qué usarlo: 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.
  • Cómo ejecutarlo en el 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)

Sección titulada «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

Sección titulada «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

Sección titulada «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

Método Ruta del Endpoint Ámbito Controlador Autenticación
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. Uso Programático en el Servidor (strapi.plugin y strapi.documents)

Sección titulada «7. Uso Programático en el Servidor (strapi.plugin y 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" });
  • Cambios no visibles en el panel Admin: Ejecute pnpm strapi build después de editar config/plugins.ts.
  • Aislamiento de dependencias peer: Mantenga hoistPattern: ["*", "!@strapi/*"] en pnpm-workspace.yaml para evitar colisiones de contexto en React.
  • Verificación estricta de TypeScript: Ejecute pnpm check para validar admin/tsconfig.json y server/tsconfig.json.