API Reference Tiptapex v#0.1.2

Copy Markdown View Source

Modules

Tiptap v3 rich-text editing for Phoenix LiveView.

Realtime collaboration helpers.

A Phoenix Channel implementing the Tiptapex collaboration wire protocol.

HEEx function components for the Tiptap editor and viewer.

Print-ready HTML and PDF engine options for Tiptapex documents.

Page setup for paginated documents: paper size, orientation, margins, running headers/footers and page numbering.

Renders Tiptap/ProseMirror JSON documents to safe HTML on the server.

Safe HTML building blocks for Tiptapex.Renderer.

Built-in mark renderers for Tiptapex.Renderer.

A small allow-listed HTML subset, for the one place the document's own JSON→HTML pipeline does not reach: header and footer slots, which are typed as text rather than edited as a Tiptap document.

Behaviour for custom node (or mark) renderers passed to Tiptapex.Renderer.to_html/2 via the :nodes / :marks options.

Built-in node renderers for Tiptapex.Renderer.

URL and CSS value sanitization for Tiptapex.Renderer.

An Ecto.Type for Tiptap/ProseMirror JSON documents.

Behaviour for storing editor uploads.

Drop-in controller action for editor uploads.

A ready-made Tiptapex.Upload handler that writes files to local disk. Intended for development, demos, and single-node deployments — for production prefer a handler backed by object storage.

Server-side validation for editor uploads: size limit, content-type verification via magic-byte sniffing, and filename sanitization.