Skip to Content
Post Canvas
Guides

Guides

Step-by-step guides for uploads, galleries, mentions, embeds, autosave, saving, server rendering, theming, languages and more.

Task-by-task guides. Each one starts from a working editor and adds one thing.

Uploads

Connect an upload adapter to Post Canvas with S3, Cloudinary or a local route, with progress, cancel, retry and HEIC support.

Galleries

Add photo galleries in four layouts (carousel, grid, masonry, collage), set photo limits, and arrange photos with the manager and collage editor.

Mentions and hashtags

Back the @ mention and # hashtag menus with your own search API, and learn how they are stored, rendered and limited.

Embeds and link previews

How a pasted link becomes a video, an embed or a link card, which providers are built in, and how to wire the server resolvers.

Custom embed providers

Add your own embed provider with defineEmbedProvider and registerEmbedProvider, with a full example, the validation rules and where to register it.

Autosave

Keep drafts as writers type, restore them on the next visit, store them in localStorage or your own backend, and clear them after publishing.

Saving and loading

Save the editor's JSON from onChange, check it before publishing, load it back, and convert to and from HTML, Markdown and plain text.

Server rendering

Show saved posts on the server with renderToHTML or PostCanvasView, choose an embed mode, and keep the editor itself on the client.

Theming

Switch between light, dark and automatic themes, and restyle Post Canvas by overriding its CSS custom properties.

Internationalization

Use the six bundled languages, write your own locale, and translate your own interface text with the same translator.

Headless usage

Build your own editor interface on the Post Canvas editor with usePostCanvasEditor, the extensions entry, and your own Tiptap extensions.

Keyboard and accessibility

Every keyboard shortcut in Post Canvas, how focus and screen reader announcements work, and the gaps we know about.

Migrating from TinyMCE or Froala

Move existing HTML content into Post Canvas with fromHTML, check what was lost, and see which TinyMCE and Froala features have an equivalent.