API ReferencePlugin

Plugin

💡

The plugin API is highly experimental and is likely to experience breaking changes.

A plugins is an extensions that enhances the capabilities of Puck.

import { Puck } from "@measured/puck"; const MyPlugin = { overrides: { drawerItem: ({ name }) => ( <div style={{ backgroundColor: "hotpink" }}>{name}</div> ), }, }; export function Editor() { return ( <Puck // ... plugins={[MyPlugin]} /> ); }

Params

PropExampleTypeStatus
fieldTransformsfieldTransforms: { text: () => <div /> }FieldTransforms-
overridesoverrides: { fields: () => <div /> }Overrides-

fieldTransforms

Transform the value of a field before rendering in the editor.Implements the Field Transforms API.

overrides

Override the render functions for specific portions of the Puck UI. Implements the overrides API.