Skip to Content
Delmare Digital
Reference

Editor props

Props for PuckConfigProvider and PuckEditor, with types and defaults.

PuckConfigProvider supplies configuration through React context; PuckEditor renders the editor and reads anything you don't pass from that context. Inside the Payload admin, the plugin's editor view fills in the page props for you; you set them yourself only for an editor of your own.

PuckConfigProvider

From @delmaredigital/payload-puck/client. usePuckConfig() reads the same context.

Prop

Type

PuckEditor

From @delmaredigital/payload-puck/client or @delmaredigital/payload-puck/editor.

Page

Prop

Type

Callbacks

Prop

Type

Appearance

Prop

Type

Behaviour and extension

Prop

Type

AI

Prop

Type

Other editor exports

@delmaredigital/payload-puck/editor also exports HeaderActions, IframeWrapper, LoadingState, PreviewModal, VersionHistory, DarkModeStyles, PreviewModeToggle, the hooks useUnsavedChanges, useDarkMode and usePuckPreviewTheme, the headingAnalyzer plugin, and createVersionHistoryPlugin with VersionHistoryPanel.

Edit this page on GitHub

On this page