Skip to Content
Post Canvas
Reference

Reference

The API reference for every Post Canvas entry point: the component, hooks, commands, nodes, renderers, server helpers and types.

Every export, by entry point. The tables come from the TSDoc in the package source.

PostCanvas component

Props, ref handle, slots, theme and provider of the PostCanvas React component, with the behaviour of each option.

React hooks

The React hooks of post-canvas: build your own editor chrome, read the editor context, translate strings and drag blocks.

Commands and block helpers

Editor commands for media, embeds and text, plus the block helpers that move, copy, delete and convert blocks.

Nodes and marks

Every node and mark in a Post Canvas document, with its attributes, its feature flag and what the sanitizer clamps or drops.

Render entry

The post-canvas/render entry: show saved documents as HTML or React, convert to Markdown and text, read HTML, and sanitize JSON.

Server entry

The post-canvas/server entry: validate saved documents, resolve embed and link-card previews safely, and check addresses for SSRF.

Vanilla and CDN entry

The post-canvas/vanilla entry and the CDN bundle: mount the editor on any page without writing React, with the PostCanvas global.

Extensions entry

The post-canvas/extensions entry: Tiptap kits, schemas, node classes, sanitizers and paste helpers for custom editors and servers.

Embed providers

The embed provider registry: built-in providers with their link forms and sizes, plus functions to parse links and add your own.

Helpers and utilities

Helper functions, constants and small components exported from post-canvas: presets, stats, limits, autosave, uploads, URLs and UI parts.

Shared types

The shared TypeScript types of post-canvas: document attributes, features, adapters, translation, insert items, problems and views.