@puckeditor/cli 0.24.0-canary.10b39dc7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +54 -0
- package/dist/bin.mjs +10343 -0
- package/dist/docs/api-reference/actions.md +63 -0
- package/dist/docs/api-reference/components/action-bar-action.md +35 -0
- package/dist/docs/api-reference/components/action-bar-group.md +24 -0
- package/dist/docs/api-reference/components/action-bar-label.md +25 -0
- package/dist/docs/api-reference/components/action-bar-separator.md +16 -0
- package/dist/docs/api-reference/components/action-bar.md +32 -0
- package/dist/docs/api-reference/components/auto-field.md +63 -0
- package/dist/docs/api-reference/components/drawer-item.md +75 -0
- package/dist/docs/api-reference/components/drawer.md +29 -0
- package/dist/docs/api-reference/components/drop-zone.md +232 -0
- package/dist/docs/api-reference/components/field-label.md +138 -0
- package/dist/docs/api-reference/components/inline-text-field.md +77 -0
- package/dist/docs/api-reference/components/puck-components.md +19 -0
- package/dist/docs/api-reference/components/puck-fields.md +39 -0
- package/dist/docs/api-reference/components/puck-layout.md +27 -0
- package/dist/docs/api-reference/components/puck-outline.md +19 -0
- package/dist/docs/api-reference/components/puck-preview.md +39 -0
- package/dist/docs/api-reference/components/puck.md +561 -0
- package/dist/docs/api-reference/components/render.md +94 -0
- package/dist/docs/api-reference/components/rich-text-menu-control.md +87 -0
- package/dist/docs/api-reference/components/rich-text-menu-group.md +27 -0
- package/dist/docs/api-reference/components/rich-text-menu.md +99 -0
- package/dist/docs/api-reference/components.md +32 -0
- package/dist/docs/api-reference/configuration/component-config.md +569 -0
- package/dist/docs/api-reference/configuration/config.md +108 -0
- package/dist/docs/api-reference/configuration.md +4 -0
- package/dist/docs/api-reference/data-model/app-state.md +168 -0
- package/dist/docs/api-reference/data-model/component-data.md +62 -0
- package/dist/docs/api-reference/data-model/data.md +95 -0
- package/dist/docs/api-reference/data-model/item-selector.md +34 -0
- package/dist/docs/api-reference/data-model/root-data.md +59 -0
- package/dist/docs/api-reference/data-model.md +8 -0
- package/dist/docs/api-reference/dictionary.md +172 -0
- package/dist/docs/api-reference/field-transforms.md +51 -0
- package/dist/docs/api-reference/fields/array.md +211 -0
- package/dist/docs/api-reference/fields/base.md +96 -0
- package/dist/docs/api-reference/fields/custom.md +193 -0
- package/dist/docs/api-reference/fields/external.md +413 -0
- package/dist/docs/api-reference/fields/number.md +132 -0
- package/dist/docs/api-reference/fields/object.md +78 -0
- package/dist/docs/api-reference/fields/radio.md +82 -0
- package/dist/docs/api-reference/fields/richtext.md +422 -0
- package/dist/docs/api-reference/fields/select.md +79 -0
- package/dist/docs/api-reference/fields/slot.md +302 -0
- package/dist/docs/api-reference/fields/text.md +93 -0
- package/dist/docs/api-reference/fields/textarea.md +93 -0
- package/dist/docs/api-reference/fields.md +16 -0
- package/dist/docs/api-reference/functions/migrate.md +204 -0
- package/dist/docs/api-reference/functions/register-overlay-portal.md +45 -0
- package/dist/docs/api-reference/functions/resolve-all-data.md +27 -0
- package/dist/docs/api-reference/functions/set-deep.md +55 -0
- package/dist/docs/api-reference/functions/transform-props.md +51 -0
- package/dist/docs/api-reference/functions/use-get-puck.md +24 -0
- package/dist/docs/api-reference/functions/use-puck.md +43 -0
- package/dist/docs/api-reference/functions/walk-tree.md +88 -0
- package/dist/docs/api-reference/functions.md +8 -0
- package/dist/docs/api-reference/overrides/action-bar.md +35 -0
- package/dist/docs/api-reference/overrides/component-overlay.md +41 -0
- package/dist/docs/api-reference/overrides/drawer-item.md +24 -0
- package/dist/docs/api-reference/overrides/drawer.md +19 -0
- package/dist/docs/api-reference/overrides/field-label.md +18 -0
- package/dist/docs/api-reference/overrides/field-types.md +51 -0
- package/dist/docs/api-reference/overrides/fields.md +19 -0
- package/dist/docs/api-reference/overrides/header-actions.md +24 -0
- package/dist/docs/api-reference/overrides/header.md +29 -0
- package/dist/docs/api-reference/overrides/iframe.md +32 -0
- package/dist/docs/api-reference/overrides/outline.md +19 -0
- package/dist/docs/api-reference/overrides/preview.md +19 -0
- package/dist/docs/api-reference/overrides/puck.md +19 -0
- package/dist/docs/api-reference/overrides.md +28 -0
- package/dist/docs/api-reference/permissions.md +55 -0
- package/dist/docs/api-reference/plugin.md +112 -0
- package/dist/docs/api-reference/plugins/blocks-plugin.md +57 -0
- package/dist/docs/api-reference/plugins/fields-plugin.md +68 -0
- package/dist/docs/api-reference/plugins/legacy-side-bar-plugin.md +54 -0
- package/dist/docs/api-reference/plugins/outline-plugin.md +57 -0
- package/dist/docs/api-reference/puck-api.md +278 -0
- package/dist/docs/api-reference/theming/action-bar.md +32 -0
- package/dist/docs/api-reference/theming/button.md +65 -0
- package/dist/docs/api-reference/theming/canvas.md +20 -0
- package/dist/docs/api-reference/theming/computed-values.md +194 -0
- package/dist/docs/api-reference/theming/drawer.md +34 -0
- package/dist/docs/api-reference/theming/fields.md +70 -0
- package/dist/docs/api-reference/theming/global.md +127 -0
- package/dist/docs/api-reference/theming/header.md +19 -0
- package/dist/docs/api-reference/theming/icon-button.md +28 -0
- package/dist/docs/api-reference/theming/outline.md +35 -0
- package/dist/docs/api-reference/theming/plugin-bar.md +24 -0
- package/dist/docs/api-reference/theming/sidebar.md +19 -0
- package/dist/docs/api-reference/theming/slot.md +27 -0
- package/dist/docs/cli.md +284 -0
- package/dist/docs/extending-puck/composition.md +54 -0
- package/dist/docs/extending-puck/custom-fields.md +133 -0
- package/dist/docs/extending-puck/field-transforms.md +89 -0
- package/dist/docs/extending-puck/internal-puck-api.md +96 -0
- package/dist/docs/extending-puck/plugins.md +159 -0
- package/dist/docs/extending-puck/theming.md +88 -0
- package/dist/docs/extending-puck/ui-overrides.md +134 -0
- package/dist/docs/getting-started.md +68 -0
- package/dist/docs/guides/migrations/dropzones-to-slots.md +138 -0
- package/dist/docs/index.json +466 -0
- package/dist/docs/index.md +37 -0
- package/dist/docs/integrating-puck/categories.md +92 -0
- package/dist/docs/integrating-puck/component-configuration.md +159 -0
- package/dist/docs/integrating-puck/data-migration.md +86 -0
- package/dist/docs/integrating-puck/dynamic-fields.md +86 -0
- package/dist/docs/integrating-puck/dynamic-props.md +137 -0
- package/dist/docs/integrating-puck/external-data-sources.md +149 -0
- package/dist/docs/integrating-puck/feature-toggling.md +121 -0
- package/dist/docs/integrating-puck/localization.md +228 -0
- package/dist/docs/integrating-puck/multi-column-layouts.md +226 -0
- package/dist/docs/integrating-puck/overlay-portals.md +25 -0
- package/dist/docs/integrating-puck/rich-text-editing.md +230 -0
- package/dist/docs/integrating-puck/root-configuration.md +171 -0
- package/dist/docs/integrating-puck/server-components.md +199 -0
- package/dist/docs/integrating-puck/styling.md +117 -0
- package/dist/docs/integrating-puck/viewports.md +75 -0
- package/dist/templates/astro/README.md +52 -0
- package/dist/templates/astro/_gitignore +24 -0
- package/dist/templates/astro/astro.config.mjs +14 -0
- package/dist/templates/astro/database.json +1 -0
- package/dist/templates/astro/package.json +25 -0
- package/dist/templates/astro/public/favicon.svg +9 -0
- package/dist/templates/astro/src/lib/pages.ts +21 -0
- package/dist/templates/astro/src/lib/resolve-puck-path.ts +19 -0
- package/dist/templates/astro/src/pages/[...puckPath].astro +25 -0
- package/dist/templates/astro/src/pages/api/pages.ts +18 -0
- package/dist/templates/astro/src/puck/editor.tsx +32 -0
- package/dist/templates/astro/src/puck/pages.ts +15 -0
- package/dist/templates/astro/src/puck/render.tsx +9 -0
- package/dist/templates/astro/src/puck.config.tsx +23 -0
- package/dist/templates/astro/tsconfig.json +14 -0
- package/dist/templates/astro-ai/README.md +64 -0
- package/dist/templates/astro-ai/_gitignore +24 -0
- package/dist/templates/astro-ai/astro.config.mjs +21 -0
- package/dist/templates/astro-ai/database.json +1 -0
- package/dist/templates/astro-ai/package.json +27 -0
- package/dist/templates/astro-ai/public/favicon.svg +9 -0
- package/dist/templates/astro-ai/src/lib/pages.ts +21 -0
- package/dist/templates/astro-ai/src/lib/resolve-puck-path.ts +19 -0
- package/dist/templates/astro-ai/src/pages/[...puckPath].astro +25 -0
- package/dist/templates/astro-ai/src/pages/api/pages.ts +18 -0
- package/dist/templates/astro-ai/src/pages/api/puck/[...all].ts +36 -0
- package/dist/templates/astro-ai/src/puck/editor.tsx +53 -0
- package/dist/templates/astro-ai/src/puck/pages.ts +15 -0
- package/dist/templates/astro-ai/src/puck/render.tsx +10 -0
- package/dist/templates/astro-ai/src/puck.config.tsx +23 -0
- package/dist/templates/astro-ai/tsconfig.json +14 -0
- package/dist/templates/express/README.md +66 -0
- package/dist/templates/express/_gitignore +16 -0
- package/dist/templates/express/database.json +1 -0
- package/dist/templates/express/package.json +20 -0
- package/dist/templates/express/src/index.ts +15 -0
- package/dist/templates/express/src/puck/pages.ts +44 -0
- package/dist/templates/express/tsconfig.json +12 -0
- package/dist/templates/express-ai/README.md +81 -0
- package/dist/templates/express-ai/_gitignore +16 -0
- package/dist/templates/express-ai/database.json +1 -0
- package/dist/templates/express-ai/package.json +22 -0
- package/dist/templates/express-ai/src/index.ts +17 -0
- package/dist/templates/express-ai/src/puck/cloud.ts +71 -0
- package/dist/templates/express-ai/src/puck/pages.ts +44 -0
- package/dist/templates/express-ai/tsconfig.json +12 -0
- package/dist/templates/hono/README.md +66 -0
- package/dist/templates/hono/_gitignore +32 -0
- package/dist/templates/hono/database.json +1 -0
- package/dist/templates/hono/package.json +20 -0
- package/dist/templates/hono/src/index.ts +21 -0
- package/dist/templates/hono/src/puck/pages.ts +32 -0
- package/dist/templates/hono/tsconfig.json +13 -0
- package/dist/templates/hono-ai/README.md +81 -0
- package/dist/templates/hono-ai/_gitignore +32 -0
- package/dist/templates/hono-ai/database.json +1 -0
- package/dist/templates/hono-ai/package.json +22 -0
- package/dist/templates/hono-ai/src/index.ts +23 -0
- package/dist/templates/hono-ai/src/puck/cloud.ts +30 -0
- package/dist/templates/hono-ai/src/puck/pages.ts +32 -0
- package/dist/templates/hono-ai/tsconfig.json +13 -0
- package/dist/templates/manifest.json +7 -0
- package/dist/templates/next/README.md +112 -0
- package/dist/templates/next/_gitignore +35 -0
- package/dist/templates/next/app/[...puckPath]/client.tsx +9 -0
- package/dist/templates/next/app/[...puckPath]/page.tsx +49 -0
- package/dist/templates/next/app/favicon.ico +0 -0
- package/dist/templates/next/app/layout.tsx +13 -0
- package/dist/templates/next/app/page.tsx +1 -0
- package/dist/templates/next/app/puck/[...puckPath]/client.tsx +20 -0
- package/dist/templates/next/app/puck/[...puckPath]/page.tsx +55 -0
- package/dist/templates/next/app/puck/api/route.ts +25 -0
- package/dist/templates/next/app/puck/page.tsx +3 -0
- package/dist/templates/next/app/styles.css +3 -0
- package/dist/templates/next/database.json +1 -0
- package/dist/templates/next/lib/get-page.ts +11 -0
- package/dist/templates/next/next.config.js +3 -0
- package/dist/templates/next/package.json +25 -0
- package/dist/templates/next/proxy.ts +27 -0
- package/dist/templates/next/puck.config.tsx +25 -0
- package/dist/templates/next/tsconfig/base.json +20 -0
- package/dist/templates/next/tsconfig/nextjs.json +21 -0
- package/dist/templates/next/tsconfig.json +8 -0
- package/dist/templates/next-ai/README.md +169 -0
- package/dist/templates/next-ai/_gitignore +35 -0
- package/dist/templates/next-ai/app/[...puckPath]/client.tsx +12 -0
- package/dist/templates/next-ai/app/[...puckPath]/page.tsx +49 -0
- package/dist/templates/next-ai/app/api/pages/route.ts +26 -0
- package/dist/templates/next-ai/app/api/puck/[...all]/route.ts +31 -0
- package/dist/templates/next-ai/app/layout.tsx +13 -0
- package/dist/templates/next-ai/app/page.tsx +1 -0
- package/dist/templates/next-ai/app/puck/[...puckPath]/client.tsx +38 -0
- package/dist/templates/next-ai/app/puck/[...puckPath]/page.tsx +57 -0
- package/dist/templates/next-ai/app/puck/page.tsx +3 -0
- package/dist/templates/next-ai/app/styles.css +3 -0
- package/dist/templates/next-ai/database.json +1 -0
- package/dist/templates/next-ai/lib/get-page.ts +11 -0
- package/dist/templates/next-ai/next.config.js +3 -0
- package/dist/templates/next-ai/package.json +27 -0
- package/dist/templates/next-ai/proxy.ts +27 -0
- package/dist/templates/next-ai/public/favicon.ico +0 -0
- package/dist/templates/next-ai/puck.config.tsx +25 -0
- package/dist/templates/next-ai/tsconfig/base.json +20 -0
- package/dist/templates/next-ai/tsconfig/nextjs.json +21 -0
- package/dist/templates/next-ai/tsconfig.json +8 -0
- package/dist/templates/react-router/README.md +113 -0
- package/dist/templates/react-router/_gitignore +6 -0
- package/dist/templates/react-router/app/components/puck-render.tsx +8 -0
- package/dist/templates/react-router/app/lib/pages.server.ts +29 -0
- package/dist/templates/react-router/app/lib/resolve-puck-path.server.ts +19 -0
- package/dist/templates/react-router/app/root.tsx +65 -0
- package/dist/templates/react-router/app/routes/_index.tsx +31 -0
- package/dist/templates/react-router/app/routes/puck-splat.tsx +95 -0
- package/dist/templates/react-router/app/routes.ts +7 -0
- package/dist/templates/react-router/database.json +1 -0
- package/dist/templates/react-router/package.json +33 -0
- package/dist/templates/react-router/public/favicon.ico +0 -0
- package/dist/templates/react-router/puck.config.tsx +23 -0
- package/dist/templates/react-router/react-router.config.ts +7 -0
- package/dist/templates/react-router/tsconfig.json +29 -0
- package/dist/templates/react-router/vite.config.ts +10 -0
- package/dist/templates/react-router-ai/README.md +172 -0
- package/dist/templates/react-router-ai/_gitignore +6 -0
- package/dist/templates/react-router-ai/app/components/puck-render.tsx +11 -0
- package/dist/templates/react-router-ai/app/lib/pages.server.ts +29 -0
- package/dist/templates/react-router-ai/app/lib/resolve-puck-path.server.ts +19 -0
- package/dist/templates/react-router-ai/app/root.tsx +65 -0
- package/dist/templates/react-router-ai/app/routes/_index.tsx +31 -0
- package/dist/templates/react-router-ai/app/routes/api.puck.ts +34 -0
- package/dist/templates/react-router-ai/app/routes/puck-splat.tsx +119 -0
- package/dist/templates/react-router-ai/app/routes.ts +8 -0
- package/dist/templates/react-router-ai/database.json +1 -0
- package/dist/templates/react-router-ai/package.json +35 -0
- package/dist/templates/react-router-ai/public/favicon.ico +0 -0
- package/dist/templates/react-router-ai/puck.config.tsx +25 -0
- package/dist/templates/react-router-ai/react-router.config.ts +7 -0
- package/dist/templates/react-router-ai/tsconfig.json +29 -0
- package/dist/templates/react-router-ai/vite.config.ts +10 -0
- package/dist/templates/tanstack-start/README.md +113 -0
- package/dist/templates/tanstack-start/_gitignore +12 -0
- package/dist/templates/tanstack-start/database.json +1 -0
- package/dist/templates/tanstack-start/package.json +26 -0
- package/dist/templates/tanstack-start/puck.config.tsx +23 -0
- package/dist/templates/tanstack-start/src/components/puck-render.tsx +8 -0
- package/dist/templates/tanstack-start/src/lib/pages.server.ts +26 -0
- package/dist/templates/tanstack-start/src/lib/pages.ts +39 -0
- package/dist/templates/tanstack-start/src/lib/resolve-puck-path.ts +19 -0
- package/dist/templates/tanstack-start/src/routeTree.gen.ts +86 -0
- package/dist/templates/tanstack-start/src/router.tsx +19 -0
- package/dist/templates/tanstack-start/src/routes/$.tsx +41 -0
- package/dist/templates/tanstack-start/src/routes/__root.tsx +42 -0
- package/dist/templates/tanstack-start/src/routes/index.tsx +18 -0
- package/dist/templates/tanstack-start/src/styles.css +13 -0
- package/dist/templates/tanstack-start/tsconfig.json +24 -0
- package/dist/templates/tanstack-start/vite.config.ts +15 -0
- package/dist/templates/tanstack-start-ai/README.md +171 -0
- package/dist/templates/tanstack-start-ai/_gitignore +12 -0
- package/dist/templates/tanstack-start-ai/database.json +1 -0
- package/dist/templates/tanstack-start-ai/package.json +28 -0
- package/dist/templates/tanstack-start-ai/puck.config.tsx +23 -0
- package/dist/templates/tanstack-start-ai/src/components/puck-render.tsx +11 -0
- package/dist/templates/tanstack-start-ai/src/lib/pages.server.ts +26 -0
- package/dist/templates/tanstack-start-ai/src/lib/pages.ts +39 -0
- package/dist/templates/tanstack-start-ai/src/lib/resolve-puck-path.ts +19 -0
- package/dist/templates/tanstack-start-ai/src/routeTree.gen.ts +104 -0
- package/dist/templates/tanstack-start-ai/src/router.tsx +19 -0
- package/dist/templates/tanstack-start-ai/src/routes/$.tsx +73 -0
- package/dist/templates/tanstack-start-ai/src/routes/__root.tsx +42 -0
- package/dist/templates/tanstack-start-ai/src/routes/api/puck/$.ts +39 -0
- package/dist/templates/tanstack-start-ai/src/routes/index.tsx +18 -0
- package/dist/templates/tanstack-start-ai/src/styles.css +13 -0
- package/dist/templates/tanstack-start-ai/tsconfig.json +24 -0
- package/dist/templates/tanstack-start-ai/vite.config.ts +15 -0
- package/dist/templates/vinext/README.md +112 -0
- package/dist/templates/vinext/_gitignore +33 -0
- package/dist/templates/vinext/app/[...puckPath]/client.tsx +9 -0
- package/dist/templates/vinext/app/[...puckPath]/page.tsx +49 -0
- package/dist/templates/vinext/app/favicon.ico +0 -0
- package/dist/templates/vinext/app/layout.tsx +13 -0
- package/dist/templates/vinext/app/page.tsx +1 -0
- package/dist/templates/vinext/app/puck/[...puckPath]/client.tsx +20 -0
- package/dist/templates/vinext/app/puck/[...puckPath]/page.tsx +55 -0
- package/dist/templates/vinext/app/puck/api/route.ts +25 -0
- package/dist/templates/vinext/app/puck/page.tsx +3 -0
- package/dist/templates/vinext/app/styles.css +3 -0
- package/dist/templates/vinext/database.json +1 -0
- package/dist/templates/vinext/lib/get-page.ts +11 -0
- package/dist/templates/vinext/package.json +30 -0
- package/dist/templates/vinext/proxy.ts +27 -0
- package/dist/templates/vinext/puck.config.tsx +25 -0
- package/dist/templates/vinext/tsconfig.json +30 -0
- package/dist/templates/vinext/vite.config.ts +6 -0
- package/dist/templates/vinext-ai/README.md +169 -0
- package/dist/templates/vinext-ai/_gitignore +33 -0
- package/dist/templates/vinext-ai/app/[...puckPath]/client.tsx +12 -0
- package/dist/templates/vinext-ai/app/[...puckPath]/page.tsx +49 -0
- package/dist/templates/vinext-ai/app/api/pages/route.ts +26 -0
- package/dist/templates/vinext-ai/app/api/puck/[...all]/route.ts +31 -0
- package/dist/templates/vinext-ai/app/layout.tsx +13 -0
- package/dist/templates/vinext-ai/app/page.tsx +1 -0
- package/dist/templates/vinext-ai/app/puck/[...puckPath]/client.tsx +38 -0
- package/dist/templates/vinext-ai/app/puck/[...puckPath]/page.tsx +57 -0
- package/dist/templates/vinext-ai/app/puck/page.tsx +3 -0
- package/dist/templates/vinext-ai/app/styles.css +3 -0
- package/dist/templates/vinext-ai/database.json +1 -0
- package/dist/templates/vinext-ai/lib/get-page.ts +11 -0
- package/dist/templates/vinext-ai/package.json +32 -0
- package/dist/templates/vinext-ai/proxy.ts +27 -0
- package/dist/templates/vinext-ai/public/favicon.ico +0 -0
- package/dist/templates/vinext-ai/puck.config.tsx +25 -0
- package/dist/templates/vinext-ai/tsconfig.json +30 -0
- package/dist/templates/vinext-ai/vite.config.ts +9 -0
- package/dist/templates/vite/README.md +56 -0
- package/dist/templates/vite/_gitignore +24 -0
- package/dist/templates/vite/database.json +1 -0
- package/dist/templates/vite/index.html +12 -0
- package/dist/templates/vite/package.json +29 -0
- package/dist/templates/vite/server/index.ts +13 -0
- package/dist/templates/vite/server/prod.ts +18 -0
- package/dist/templates/vite/server/puck/pages.ts +32 -0
- package/dist/templates/vite/src/App.tsx +11 -0
- package/dist/templates/vite/src/main.tsx +12 -0
- package/dist/templates/vite/src/puck/editor.tsx +28 -0
- package/dist/templates/vite/src/puck/page.tsx +27 -0
- package/dist/templates/vite/src/puck/pages.ts +15 -0
- package/dist/templates/vite/src/puck/root.tsx +27 -0
- package/dist/templates/vite/src/puck.config.tsx +23 -0
- package/dist/templates/vite/tsconfig.app.json +26 -0
- package/dist/templates/vite/tsconfig.json +7 -0
- package/dist/templates/vite/tsconfig.node.json +23 -0
- package/dist/templates/vite/vite.config.ts +14 -0
- package/dist/templates/vite-ai/README.md +67 -0
- package/dist/templates/vite-ai/_gitignore +24 -0
- package/dist/templates/vite-ai/database.json +1 -0
- package/dist/templates/vite-ai/index.html +12 -0
- package/dist/templates/vite-ai/package.json +31 -0
- package/dist/templates/vite-ai/server/index.ts +15 -0
- package/dist/templates/vite-ai/server/prod.ts +18 -0
- package/dist/templates/vite-ai/server/puck/cloud.ts +30 -0
- package/dist/templates/vite-ai/server/puck/pages.ts +32 -0
- package/dist/templates/vite-ai/src/App.tsx +11 -0
- package/dist/templates/vite-ai/src/main.tsx +12 -0
- package/dist/templates/vite-ai/src/puck/editor.tsx +49 -0
- package/dist/templates/vite-ai/src/puck/page.tsx +28 -0
- package/dist/templates/vite-ai/src/puck/pages.ts +15 -0
- package/dist/templates/vite-ai/src/puck/root.tsx +27 -0
- package/dist/templates/vite-ai/src/puck.config.tsx +23 -0
- package/dist/templates/vite-ai/tsconfig.app.json +26 -0
- package/dist/templates/vite-ai/tsconfig.json +7 -0
- package/dist/templates/vite-ai/tsconfig.node.json +23 -0
- package/dist/templates/vite-ai/vite.config.ts +14 -0
- package/package.json +52 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# Plugin API
|
|
2
|
+
|
|
3
|
+
The [plugin API](/docs/api-reference/plugins) enables developers to share extensions to Puck.
|
|
4
|
+
|
|
5
|
+
Plugins can display dedicated UI in the **Plugin Rail** on the left-hand side of the screen (bottom on mobile), configure their own [overrides](/docs/extending-puck/ui-overrides), or apply [field transforms](/docs/extending-puck/field-transforms).
|
|
6
|
+
|
|
7
|
+
## Official plugins
|
|
8
|
+
|
|
9
|
+
### Core plugins
|
|
10
|
+
|
|
11
|
+
These plugins are included in the core package:
|
|
12
|
+
|
|
13
|
+
- [`blocks`](/docs/api-reference/plugins/blocks-plugin): show the component drawer for dragging components onto the canvas
|
|
14
|
+
- [`fields`](/docs/api-reference/plugins/fields-plugin): render the fields for the currently selected component
|
|
15
|
+
- [`outline`](/docs/api-reference/plugins/outline-plugin): display an outline of the current page structure
|
|
16
|
+
- [`legacy-side-bar`](/docs/api-reference/plugins/legacy-side-bar-plugin): disable the plugin rail in favor of stacked "Components" / "Outline" sections
|
|
17
|
+
|
|
18
|
+
### Enhancements
|
|
19
|
+
|
|
20
|
+
Puck provides official plugins that can be installed for common use-cases:
|
|
21
|
+
|
|
22
|
+
- [`ai`](https://puckeditor.com/docs/ai/overview): Use AI to generate pages using your own components.
|
|
23
|
+
- [`emotion-cache`](https://github.com/puckeditor/puck/tree/main/packages/plugin-emotion-cache): Inject emotion cache into the Puck iframe.
|
|
24
|
+
- [`heading-analyzer`](https://github.com/puckeditor/puck/tree/main/packages/plugin-heading-analyzer): Analyze the heading outline of your page and be warned when you're not respecting WCAG 2 accessibility standards.
|
|
25
|
+
|
|
26
|
+
Please see the [awesome-puck repo](https://github.com/puckeditor/awesome-puck) for a full list of community plugins.
|
|
27
|
+
|
|
28
|
+
## Loading a Plugin
|
|
29
|
+
|
|
30
|
+
To load a plugin, provide it to the [`plugins` prop](/docs/api-reference/components/puck#plugins) on the `<Puck>` component.
|
|
31
|
+
|
|
32
|
+
```tsx
|
|
33
|
+
import { Puck } from "@puckeditor/core";
|
|
34
|
+
import myPlugin from "my-puck-plugin";
|
|
35
|
+
|
|
36
|
+
export function Editor() {
|
|
37
|
+
return (
|
|
38
|
+
<Puck
|
|
39
|
+
// ...
|
|
40
|
+
plugins={[myPlugin]}
|
|
41
|
+
/>
|
|
42
|
+
);
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Developing a Plugin
|
|
47
|
+
|
|
48
|
+
If you're familiar with Puck, you can likely already build a Puck plugin. See the [Plugin API reference](/docs/api-reference/plugins) for a full breakdown of available APIs.
|
|
49
|
+
|
|
50
|
+
### Rendering UI in the Plugin Rail
|
|
51
|
+
|
|
52
|
+
Plugins can render dedicated UI in a panel shown by the Plugin Rail. To add a plugin to the rail, create a new plugin and provide some parameters:
|
|
53
|
+
|
|
54
|
+
```tsx
|
|
55
|
+
import { Coffee } from "lucide-react";
|
|
56
|
+
|
|
57
|
+
const myPlugin = {
|
|
58
|
+
name: "my-plugin", // Globally unique name
|
|
59
|
+
label: "My Plugin", // Human-readable name shown in the rail
|
|
60
|
+
icon: <Coffee />, // Icon shown in the rail (use lucide to match Puck)
|
|
61
|
+
render: () => <div>My plugin UI</div>, // Component rendered in plugin panel
|
|
62
|
+
};
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
You can leverage the [internal Puck API](/docs/extending-puck/internal-puck-api) to integrate Puck behavior with your plugin:
|
|
66
|
+
|
|
67
|
+
```tsx
|
|
68
|
+
import { Coffee } from "lucide-react";
|
|
69
|
+
import { createUsePuck } from "@puckeditor/core";
|
|
70
|
+
|
|
71
|
+
const usePuck = createUsePuck();
|
|
72
|
+
|
|
73
|
+
const myPlugin = {
|
|
74
|
+
name: "my-plugin",
|
|
75
|
+
label: "My Plugin",
|
|
76
|
+
icon: <Coffee />,
|
|
77
|
+
render: () => {
|
|
78
|
+
const type = usePuck((s) => s.selectedItem?.type || "Nothing");
|
|
79
|
+
|
|
80
|
+
return <h2>{type} selected</h2>;
|
|
81
|
+
},
|
|
82
|
+
};
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Transforming fields
|
|
86
|
+
|
|
87
|
+
Plugins support [Field Transforms](/docs/extending-puck/field-transforms), enabling you to modify prop data before it's rendered in the `<Puck>` preview.
|
|
88
|
+
|
|
89
|
+
```tsx
|
|
90
|
+
const plugin = {
|
|
91
|
+
fieldTransforms: {
|
|
92
|
+
// Make all props powered by "text" field pink in the canvas
|
|
93
|
+
text: ({ value }) => <span style={{ color: "hotpink" }}>{value}</span>,
|
|
94
|
+
},
|
|
95
|
+
};
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Overriding the UI
|
|
99
|
+
|
|
100
|
+
Plugins support [UI Overrides](/docs/extending-puck/ui-overrides), enabling you to override discrete section of the Puck interface.
|
|
101
|
+
|
|
102
|
+
```tsx
|
|
103
|
+
const plugin = {
|
|
104
|
+
overrides: {
|
|
105
|
+
// Make all drawer items pink
|
|
106
|
+
drawerItem: ({ name }) => <div style={{ color: "hotpink" }}>{name}</div>,
|
|
107
|
+
},
|
|
108
|
+
};
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
> **Note:** Override currying
|
|
112
|
+
>
|
|
113
|
+
> Plugin overrides are rendered in the order they are defined. Unless otherwise specified, all overrides are _curried_, meaning that the return node of one plugin will be passed as `children` to the next plugin.
|
|
114
|
+
>
|
|
115
|
+
> This may result in some incompatible plugin combinations. To improve your chance of building a widely compatible plugin, consider:
|
|
116
|
+
>
|
|
117
|
+
> 1. Implementing as few override methods as you need
|
|
118
|
+
> 2. Always rendering `children` if possible
|
|
119
|
+
|
|
120
|
+
### Introducing new field types
|
|
121
|
+
|
|
122
|
+
Both the field transforms and overrides let you introduce [entirely new field types](/docs/extending-puck/ui-overrides#introducing-new-field-types). Plugins can combine this functionality to bundle up new field behavior in a convenient package.
|
|
123
|
+
|
|
124
|
+
This example uses [Overlay Portals](/docs/extending-puck/overlay-portals) to create an interactive rich text field that can be modified directly in the editor preview.
|
|
125
|
+
|
|
126
|
+
```tsx
|
|
127
|
+
import { useCallback } from "react";
|
|
128
|
+
import { registerOverlayPortal } from "@puckeditor/core";
|
|
129
|
+
|
|
130
|
+
const InlineRichText = ({ value }) => {
|
|
131
|
+
const handleInput = useCallback(() => {}, []); // Implement your input behavior
|
|
132
|
+
|
|
133
|
+
return (
|
|
134
|
+
// Wrap the value in a span, create an overlay portal, and make it editable
|
|
135
|
+
<span ref={registerOverlayPortal} contentEditable onInput={handleInput}>
|
|
136
|
+
{value}
|
|
137
|
+
</span>
|
|
138
|
+
);
|
|
139
|
+
};
|
|
140
|
+
|
|
141
|
+
const plugin = {
|
|
142
|
+
overrides: {
|
|
143
|
+
// Add a richText field type
|
|
144
|
+
fieldTypes: {
|
|
145
|
+
richText: ({ name, value }) => <input name={name} value={value} />,
|
|
146
|
+
},
|
|
147
|
+
},
|
|
148
|
+
fieldTransforms: {
|
|
149
|
+
// Make the richText field editable inline
|
|
150
|
+
richText: (props) => <InlineRichText {...props} />,
|
|
151
|
+
},
|
|
152
|
+
};
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Further reading
|
|
156
|
+
|
|
157
|
+
- [Plugin API reference](/docs/api-reference/plugin)
|
|
158
|
+
- [FieldTransforms API reference](/docs/api-reference/field-transforms)
|
|
159
|
+
- [UI Overrides](/docs/extending-puck/ui-overrides)
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Theming
|
|
2
|
+
|
|
3
|
+
Puck's default interface is styled with CSS custom properties (design tokens). You can override these tokens to create a custom theme that matches your brand or product, or to implement dark mode.
|
|
4
|
+
|
|
5
|
+
See the theming API reference for the full list of tokens:
|
|
6
|
+
|
|
7
|
+
- [Global tokens](/docs/api-reference/theming/global): Tokens that restyle the whole interface at once.
|
|
8
|
+
- [Action bar](/docs/api-reference/theming/action-bar): Tokens that style the action bar shown when selecting a component.
|
|
9
|
+
- [Button](/docs/api-reference/theming/button): Tokens that style the text buttons.
|
|
10
|
+
- [Canvas](/docs/api-reference/theming/canvas): Tokens that style the canvas preview area.
|
|
11
|
+
- [Drawer](/docs/api-reference/theming/drawer): Tokens that style the component drawer.
|
|
12
|
+
- [Fields](/docs/api-reference/theming/fields): Tokens that style the puck [fields](/docs/api-reference/fields).
|
|
13
|
+
- [Header](/docs/api-reference/theming/header): Tokens that style the editor header.
|
|
14
|
+
- [Icon button](/docs/api-reference/theming/icon-button): Tokens that style the icon buttons.
|
|
15
|
+
- [Outline](/docs/api-reference/theming/outline): Tokens that style the outline panel.
|
|
16
|
+
- [Plugin bar](/docs/api-reference/theming/plugin-bar): Tokens that style the side navigation for switching plugins.
|
|
17
|
+
- [Sidebar](/docs/api-reference/theming/sidebar): Tokens that style the left and right sidebar panels.
|
|
18
|
+
- [Slot](/docs/api-reference/theming/slot): Tokens that style the slots.
|
|
19
|
+
- [Computed values](/docs/api-reference/theming/computed-values): Tokens that define default computed values for all component-level tokens.
|
|
20
|
+
|
|
21
|
+
## Applying a theme
|
|
22
|
+
|
|
23
|
+
To apply a theme override the token you want in any element above the editor in the DOM tree:
|
|
24
|
+
|
|
25
|
+
```css
|
|
26
|
+
@import "@puckeditor/core/puck.css";
|
|
27
|
+
|
|
28
|
+
.Container {
|
|
29
|
+
--puck-color-interactive: #0f5fff;
|
|
30
|
+
--puck-radius-m: 8px;
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Global tokens
|
|
35
|
+
|
|
36
|
+
[Global tokens](/docs/api-reference/theming/global) restyle the whole interface at once, covering color, spacing, radius, motion and typography.
|
|
37
|
+
|
|
38
|
+
For example, to change the palette to match the interactive colors of your brand:
|
|
39
|
+
|
|
40
|
+
```css
|
|
41
|
+
.Container {
|
|
42
|
+
--puck-color-interactive: #0d9488;
|
|
43
|
+
--puck-color-interactive-hover: #0f766e;
|
|
44
|
+
--puck-color-interactive-active: #115e59;
|
|
45
|
+
--puck-color-interactive-subtle: #ccfbf1;
|
|
46
|
+
--puck-color-interactive-soft: #f0fdfa;
|
|
47
|
+
--puck-color-interactive-soft-hover: #ccfbf1;
|
|
48
|
+
--puck-color-focus-ring: #14b8a6;
|
|
49
|
+
--puck-color-selection-bg: color-mix(in srgb, #14b8a6 20%, transparent);
|
|
50
|
+
--puck-color-selection-border: #14b8a6;
|
|
51
|
+
--puck-slot-component-color-placeholder: #99f6e4;
|
|
52
|
+
--puck-slot-component-color-border-dragging: #5eead4;
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The [API reference](/docs/api-reference/theming/global) lists where each global token is used.
|
|
57
|
+
|
|
58
|
+
## Component tokens
|
|
59
|
+
|
|
60
|
+
When you need finer control, component tokens restyle a single part of the UI and override global tokens.
|
|
61
|
+
|
|
62
|
+
For example, to set the header and plugin bar background:
|
|
63
|
+
|
|
64
|
+
```css
|
|
65
|
+
.Container {
|
|
66
|
+
--puck-header-color-bg: #fff4e6;
|
|
67
|
+
--puck-pluginbar-color-bg: #fff4e6;
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Load your own font file
|
|
72
|
+
|
|
73
|
+
By default, Puck loads the [Inter typeface family](https://rsms.me/inter/) from a CDN. To host your own copy of Inter, or load a different font file, switch Puck to the `no-external` runtime bundle:
|
|
74
|
+
|
|
75
|
+
```css
|
|
76
|
+
/* @import "@puckeditor/core/puck.css"; */
|
|
77
|
+
@import "@puckeditor/core/no-external.css";
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Going further
|
|
81
|
+
|
|
82
|
+
CSS tokens restyle the default interface. To change its behavior or visuals not covered by tokens, use the [composition](/docs/extending-puck/composition) or [UI overrides](/docs/extending-puck/ui-overrides) APIs.
|
|
83
|
+
|
|
84
|
+
## Further reading
|
|
85
|
+
|
|
86
|
+
- [Theming API reference](/docs/api-reference/theming)
|
|
87
|
+
- [Composition](/docs/extending-puck/composition)
|
|
88
|
+
- [UI overrides](/docs/extending-puck/ui-overrides)
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# UI overrides
|
|
2
|
+
|
|
3
|
+
> **Note:** The overrides API is highly experimental and is likely to experience breaking
|
|
4
|
+
> changes.
|
|
5
|
+
|
|
6
|
+
Overrides allow you to change how Puck renders its default interface. It can be used with or without [composition](/docs/extending-puck/composition).
|
|
7
|
+
|
|
8
|
+
There are many different overrides available. See the [`overrides` API reference](/docs/api-reference/overrides) for the full list.
|
|
9
|
+
|
|
10
|
+
## Implementing an override
|
|
11
|
+
|
|
12
|
+
Use the [`overrides` prop](/docs/api-reference/components/puck#overrides) to implement an override:
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
import { Puck } from "@puckeditor/core";
|
|
16
|
+
|
|
17
|
+
export function Editor() {
|
|
18
|
+
return (
|
|
19
|
+
<Puck
|
|
20
|
+
// ...
|
|
21
|
+
overrides={{
|
|
22
|
+
// Render a custom element for each item in the component list
|
|
23
|
+
drawerItem: ({ name }) => (
|
|
24
|
+
<div style={{ backgroundColor: "hotpink" }}>{name}</div>
|
|
25
|
+
),
|
|
26
|
+
}}
|
|
27
|
+
/>
|
|
28
|
+
);
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Overriding field types
|
|
33
|
+
|
|
34
|
+
You can override all fields of certain type by specifying the [`fieldTypes` override](/docs/api-reference/overrides/field-types).
|
|
35
|
+
|
|
36
|
+
```tsx
|
|
37
|
+
import { Puck } from "@puckeditor/core";
|
|
38
|
+
|
|
39
|
+
export function Editor() {
|
|
40
|
+
return (
|
|
41
|
+
<Puck
|
|
42
|
+
// ...
|
|
43
|
+
overrides={{
|
|
44
|
+
fieldTypes: {
|
|
45
|
+
// Override all text fields with a custom input
|
|
46
|
+
text: ({ name, onChange, value }) => (
|
|
47
|
+
<input
|
|
48
|
+
defaultValue={value}
|
|
49
|
+
name={name}
|
|
50
|
+
onChange={(e) => onChange(e.currentTarget.value)}
|
|
51
|
+
style={{ border: "1px solid black", padding: 4 }}
|
|
52
|
+
/>
|
|
53
|
+
),
|
|
54
|
+
},
|
|
55
|
+
}}
|
|
56
|
+
/>
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Introducing new field types
|
|
62
|
+
|
|
63
|
+
Specify new field types to expose new fields to your components.
|
|
64
|
+
|
|
65
|
+
```tsx
|
|
66
|
+
import { Puck } from "@puckeditor/core";
|
|
67
|
+
|
|
68
|
+
export function Editor() {
|
|
69
|
+
return (
|
|
70
|
+
<Puck
|
|
71
|
+
// ...
|
|
72
|
+
overrides={{
|
|
73
|
+
fieldTypes: {
|
|
74
|
+
myField: ({ name, onChange, value }) => <div />,
|
|
75
|
+
},
|
|
76
|
+
}}
|
|
77
|
+
/>
|
|
78
|
+
);
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
> **Note:** TypeScript consideration: When introducing new field types with
|
|
83
|
+
> TypeScript, you'll need to extend the available field types with the `fields`
|
|
84
|
+
> key in your `Config` type generic.
|
|
85
|
+
|
|
86
|
+
## Examples
|
|
87
|
+
|
|
88
|
+
### Custom publish button
|
|
89
|
+
|
|
90
|
+
A common use case is to override the Puck header. You can either use the [`header` override](/docs/api-reference/overrides/header) to change the entire header, or use the [`headerActions` override](/docs/api-reference/overrides/header-actions) to inject new controls into the header and change the publish button.
|
|
91
|
+
|
|
92
|
+
Here's an example that also leverage the [internal Puck API](/docs/extending-puck/internal-puck-api) to replace the default publish button with a custom one:
|
|
93
|
+
|
|
94
|
+
```tsx
|
|
95
|
+
import { Puck, createUsePuck } from "@puckeditor/core";
|
|
96
|
+
|
|
97
|
+
const usePuck = createUsePuck();
|
|
98
|
+
|
|
99
|
+
const save = () => {};
|
|
100
|
+
|
|
101
|
+
export function Editor() {
|
|
102
|
+
return (
|
|
103
|
+
<Puck
|
|
104
|
+
// ...
|
|
105
|
+
overrides={{
|
|
106
|
+
headerActions: ({ children }) => {
|
|
107
|
+
const appState = usePuck((s) => s.appState);
|
|
108
|
+
|
|
109
|
+
return (
|
|
110
|
+
<>
|
|
111
|
+
<button
|
|
112
|
+
onClick={() => {
|
|
113
|
+
save(appState.data);
|
|
114
|
+
}}
|
|
115
|
+
>
|
|
116
|
+
Save
|
|
117
|
+
</button>
|
|
118
|
+
|
|
119
|
+
{/* Render default header actions, such as the default Button */}
|
|
120
|
+
{/*{children}*/}
|
|
121
|
+
</>
|
|
122
|
+
);
|
|
123
|
+
},
|
|
124
|
+
}}
|
|
125
|
+
/>
|
|
126
|
+
);
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Further reading
|
|
131
|
+
|
|
132
|
+
- [`overrides` API reference](/docs/api-reference/overrides)
|
|
133
|
+
- [Composition](/docs/extending-puck/composition)
|
|
134
|
+
- [Internal Puck API](/docs/extending-puck/internal-puck-api)
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Getting Started
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
Install the package
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i @puckeditor/core --save
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or set up Puck and Puck Cloud in a new or existing Next.js, React Router, TanStack Start, vinext, Vite or Astro app, or a Hono or Express server using the [CLI](/docs/cli)
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npx @puckeditor/cli init
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Or generate a Puck application using a [recipe](https://github.com/puckeditor/puck#recipes)
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npx create-puck-app my-app
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Render the editor
|
|
24
|
+
|
|
25
|
+
File: `Editor.jsx`
|
|
26
|
+
|
|
27
|
+
```jsx
|
|
28
|
+
import { Puck } from "@puckeditor/core";
|
|
29
|
+
|
|
30
|
+
// Create Puck component config
|
|
31
|
+
const config = {
|
|
32
|
+
components: {
|
|
33
|
+
HeadingBlock: {
|
|
34
|
+
fields: {
|
|
35
|
+
children: {
|
|
36
|
+
type: "text",
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
render: ({ children }) => {
|
|
40
|
+
return <h1>{children}</h1>;
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
// Describe the initial data
|
|
47
|
+
const initialData = {};
|
|
48
|
+
|
|
49
|
+
// Save the data to your database
|
|
50
|
+
const save = (data) => {};
|
|
51
|
+
|
|
52
|
+
// Render Puck editor
|
|
53
|
+
export function Editor() {
|
|
54
|
+
return <Puck config={config} data={initialData} onPublish={save} />;
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Render the page
|
|
59
|
+
|
|
60
|
+
File: `Page.jsx`
|
|
61
|
+
|
|
62
|
+
```jsx
|
|
63
|
+
import { Render } from "@puckeditor/core";
|
|
64
|
+
|
|
65
|
+
export function Page() {
|
|
66
|
+
return <Render config={config} data={data} />;
|
|
67
|
+
}
|
|
68
|
+
```
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# How to migrate from DropZones to Slots
|
|
2
|
+
|
|
3
|
+
This guide will help you migrate from [`DropZones`](/docs/api-reference/components/drop-zone) to [Slots](/docs/api-reference/fields/slot).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
[Slot fields](/docs/api-reference/fields/slot) replace the [`<DropZone>` component](/docs/api-reference/components/drop-zone), introducing an inline data model that supports [`defaultProps`](/docs/api-reference/configuration/component-config#defaultprops), [`resolveData`](/docs/api-reference/configuration/component-config#resolvedatadata-params) and [Server Components](/docs/integrating-puck/server-components) out-of-the-box.
|
|
8
|
+
|
|
9
|
+
## Replace DropZone instances
|
|
10
|
+
|
|
11
|
+
Replace your `<DropZone>` instances with [slot fields](/docs/api-reference/fields/slot) and the slot [render function](/docs/api-reference/fields/slot#render-function).
|
|
12
|
+
|
|
13
|
+
**Before**
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
const config = {
|
|
17
|
+
components: {
|
|
18
|
+
Example: {
|
|
19
|
+
render: () => {
|
|
20
|
+
return <DropZone zone="items" allow={["HeadingBlock"]} />;
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
},
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**After**
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
const config = {
|
|
31
|
+
components: {
|
|
32
|
+
Example: {
|
|
33
|
+
fields: {
|
|
34
|
+
items: {
|
|
35
|
+
type: "slot",
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
defaultProps: {
|
|
39
|
+
items: [], // Slots support defaultProps and other APIs like resolveData
|
|
40
|
+
},
|
|
41
|
+
render: ({ items: Items }) => {
|
|
42
|
+
return <Items allow={["HeadingBlock"]} />; // Slots support most DropZone APIs
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## The data model
|
|
50
|
+
|
|
51
|
+
The slot data model is inline and recursive. This means that instead of storing data in a global `zones` object, data is stored as arrays of [ComponentData](/docs/api-reference/data-model/component-data) as a prop.
|
|
52
|
+
|
|
53
|
+
**Before**
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"content": [
|
|
58
|
+
{
|
|
59
|
+
"type": "Grid",
|
|
60
|
+
"props": {
|
|
61
|
+
"id": "Grid-12345"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
],
|
|
65
|
+
"zones": {
|
|
66
|
+
"Grid-12345:items": [
|
|
67
|
+
{
|
|
68
|
+
"type": "HeadingBlock",
|
|
69
|
+
"props": {
|
|
70
|
+
"id": "Heading-12345",
|
|
71
|
+
"title": "Hello, world"
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
]
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**After**
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"content": [
|
|
84
|
+
{
|
|
85
|
+
"type": "Grid",
|
|
86
|
+
"props": {
|
|
87
|
+
"id": "Grid-12345",
|
|
88
|
+
"items": [
|
|
89
|
+
{
|
|
90
|
+
"type": "HeadingBlock",
|
|
91
|
+
"props": {
|
|
92
|
+
"id": "Heading-12345",
|
|
93
|
+
"title": "Hello, world"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
]
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Migrating legacy data
|
|
104
|
+
|
|
105
|
+
For new slots, you don't need to do anything. If you're migrating existing DropZones to slots, you will need to migrate your the data accordingly. Puck provides the [`migrate()` helper](/docs/api-reference/functions/migrate) to help with this:
|
|
106
|
+
|
|
107
|
+
```tsx
|
|
108
|
+
import { migrate } from "@puckeditor/core";
|
|
109
|
+
import config from "puck.config.tsx";
|
|
110
|
+
|
|
111
|
+
const newData = migrate(legacyData, config);
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
This will migrate any existing zone in `zones` where you have defined a `slot` with the same name.
|
|
115
|
+
|
|
116
|
+
### Migrating dynamic zones to slots
|
|
117
|
+
|
|
118
|
+
To migrate DropZone data with dynamic zone names (e.g., those generated when rendering DropZones in a loop), use the [`migrateDynamicZonesForComponent`](/docs/api-reference/functions/migrate#migratedynamiczonesforcomponent) option in the [`migrate()` helper](/docs/api-reference/functions/migrate).
|
|
119
|
+
|
|
120
|
+
```tsx
|
|
121
|
+
const newData = migrate(legacyData, config, {
|
|
122
|
+
migrateDynamicZonesForComponent: {
|
|
123
|
+
Columns: (props, zones) => {
|
|
124
|
+
return {
|
|
125
|
+
...props,
|
|
126
|
+
columns: Object.values(zones).map((zone) => ({
|
|
127
|
+
column: zone,
|
|
128
|
+
})),
|
|
129
|
+
};
|
|
130
|
+
},
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Further reading
|
|
136
|
+
|
|
137
|
+
- [The `slot` field API](/docs/api-reference/fields/slot)
|
|
138
|
+
- [The `DropZone` component](/docs/api-reference/components/drop-zone)
|