Live Preview

Client SDK that streams live Payload draft edits into a frontend preview

Official 45,915 527.3k/wk MIT v3.94.0

Installation

pnpm add @payloadcms/live-preview

About

Live Preview is the browser-side SDK that lets a frontend show unsaved changes from the Payload admin panel as the editor types. The frontend listens for messages from the admin view, and each change is merged into the document the page already loaded. Editors see their edits on the real page layout before saving.

When a message refers to a related document, such as a relationship or a populated field, the SDK fetches the missing data from Payload so the preview matches what will be published. You can supply your own request handler if your API lives behind a custom route or needs extra headers. The SDK does not render anything itself, so your existing components do the drawing.

Package info

Package name
@payloadcms/live-preview
Latest version
3.94.0
Unpacked size
25 kB
License
MIT
Weekly downloads
527.3k
Last publish
Nov 17, 2026

More from payloadcms

View profile

Stores Payload upload files in Cloudflare R2 buckets instead of local disk

Adds a parent field and breadcrumbs to collections so documents can nest inside each other

Sends Payload server errors and selected HTTP errors to Sentry with user context

Adds an SEO tab with meta title, description, image and search preview to collections

Stores collection uploads in Vercel Blob Storage instead of local disk

Lets one Payload admin panel manage content for many separate tenants

React hook and refresh component for Payload Live Preview in frontend apps

Vue composable that wires a Payload Live Preview into a Vue frontend

React admin bar that puts Payload editing controls on your frontend pages

Renders Lexical rich text content from Payload in Astro sites

Manifest, linter and Payload block generator for a design system's components

CLI and registry that installs wired Payload blocks into Next.js projects