Visual Editor

About

The Visual Editor plugin allows users to edit text fields directly within the live preview of Payload CMS. It synchronizes changes back to the admin document form when a user clicks 'Done', saving the changes as a draft. Supported field types for editing include text, textarea, number, and richText. The plugin eliminates the need for additional data attributes or manual field wrappers, simplifying integration with existing content structures. To use the plugin, developers must register it in the Payload configuration, specifying which collections and fields are editable. The configuration supports allowlists and blocklists for field paths, providing flexibility in editing capabilities. Installation requires the peer dependencies `@payloadcms/ui` and `@payloadcms/live-preview` to be set up. Live preview must also be configured for each collection where the plugin is applied. Edits made in the visual editor are maintained in the admin form immediately. The plugin includes a `VisualEditorListener` that manages syncing and updates, ensuring that content remains current in real-time during sessions. Developers should ensure that their frontend layout mounts the listener to facilitate proper functionality.

Package info

Package name

payload-plugin-visual-editor

Latest version

1.0.4

Unpacked size

236 kB

License

MIT

Weekly downloads

235

Last publish

Jun 16, 2026