Reference
Export reference
Every entry point of @delmaredigital/payload-puck and what it exports.
The package is split into entry points so server code never imports client-only modules. Import from the narrowest one that has what you need.
| Entry point | Exports |
|---|---|
@delmaredigital/payload-puck | createPuckPlugin, getPuckFields, field definitions (puckDataField, editorVersionField, pageLayoutField, isHomepageField, seoFieldGroup, conversionFieldGroup and their factories), generatePagesCollection, TemplatesCollection, types |
@delmaredigital/payload-puck/plugin | createPuckPlugin, getPuckCollectionConfig, getPuckFields, createIsHomepageUniqueHook, unsetHomepage, HomepageConflictError, generatePagesCollection, generatePuckEditField, TemplatesCollection |
@delmaredigital/payload-puck/config | baseConfig, createConfig(), extendConfig() / mergeConfigs(), applyIntegrations, DEFAULT_LAYOUTS, createLayout, PuckIntegration type |
@delmaredigital/payload-puck/config/editor | editorConfig, fullConfig, minimalConfig, defaultRoot, pageTreeRoot, extendConfig() / mergeConfigs(), applyIntegrations, PuckIntegration type |
@delmaredigital/payload-puck/client | PuckEditor, PuckConfigProvider, usePuckConfig, EditWithPuckButton, EditWithPuckLink, page-tree utilities, applyIntegrations, PuckIntegration type |
@delmaredigital/payload-puck/editor | PuckEditor, PuckEditorView, HeaderActions, editor components, hooks and plugins; see Editor props |
@delmaredigital/payload-puck/rsc | PuckEditorView for Payload admin views |
@delmaredigital/payload-puck/render | PageRenderer, HybridPageRenderer, toHybridPageData, createRenderLayouts |
@delmaredigital/payload-puck/fields | Custom Puck fields, createFieldLayout, CSS helpers, value types |
@delmaredigital/payload-puck/components | Individual component configs, editor and server variants, AnimatedWrapper |
@delmaredigital/payload-puck/theme | ThemeProvider, useTheme, theme defaults and utilities |
@delmaredigital/payload-puck/layouts | Layout definitions, createLayout, mergeLayouts, createRenderLayouts, LayoutWrapper, DEFAULT_LAYOUTS, EXTENDED_LAYOUTS |
@delmaredigital/payload-puck/api | API route factories for custom implementations |
@delmaredigital/payload-puck/ai | AI plugins, hooks, config utilities, tools and API routes |
@delmaredigital/payload-puck/email | EmailRenderer, renderToEmailHtml, getEmailDocumentParts, emailBaseConfig, emailEditorConfig, email utilities |
@delmaredigital/payload-puck/email/components | Individual email component configs (server, editor, types) |
@delmaredigital/payload-puck/admin/client | EditWithPuckButton, EditWithPuckCell |
Which config where
- Server components and
PageRenderer:/config,/render,/layouts. Read individual built-in server configs frombaseConfig.componentson/config. - The editor and anything with
'use client':/config/editor,/clientor/editor,/fields.
/components is a client entry point, including its *ServerConfig exports. Those exports become client references in a Server Component and cannot be passed as configs to PageRenderer.