@measured/puck NPM

Puck

The visual editor for React.

Demo

Documentation

Visit https://puckeditor.com to view the full documentation.

Quick start

Install the package:

npm i @measured/puck --save # or npx create-puck-app my-app

Render the editor:

// Editor.jsx
import { Puck } from "@measured/puck";
import "@measured/puck/puck.css";

// Create Puck component config
const config = {
  components: {
    HeadingBlock: {
      fields: {
        children: {
          type: "text",
        },
      },
      render: ({ children }) => {
        return <h1>{children}</h1>;
      },
    },
  },
};

// Describe the initial data
const initialData = {};

// Save the data to your database
const save = (data) => {};

// Render Puck editor
export function Editor() {
  return <Puck config={config} data={initialData} onPublish={save} />;
}

Render the page:

// Page.jsx
import { Render } from "@measured/puck";
import "@measured/puck/puck.css";

export function Page() {
  return <Render config={config} data={data} />;
}

Recipes

Use create-puck-app to quickly spin up a a pre-configured app based on our provided recipes:

npx create-puck-app my-app

Available recipes include:

next: Next.js example, using App Router and static page generation
remix: Remix Run v2 example, using dynamic routes at root-level
react-router: React Router v7 app example, using dynamic routes to create pages at any level

Community

Discord server for discussions
awesome-puck community repo for plugins, custom fields & more

Get support

If you have any questions about Puck, please open a GitHub issue or join us on Discord.

Or book a discovery call for hands-on support and consultancy.

License

9 months ago

9 months ago

9 months ago

9 months ago

7 months ago

5 months ago

5 months ago

6 months ago

12 months ago

6 months ago

10 months ago

9 months ago

12 months ago

10 months ago

5 months ago

5 months ago

9 months ago

6 months ago

9 months ago

9 months ago

9 months ago

7 months ago

6 months ago

9 months ago

11 months ago

7 months ago

7 months ago

10 months ago

10 months ago

9 months ago

9 months ago

7 months ago

5 months ago

5 months ago

6 months ago

9 months ago

9 months ago

9 months ago

10 months ago

11 months ago

6 months ago

10 months ago

5 months ago

9 months ago

10 months ago

5 months ago

9 months ago

6 months ago

5 months ago

5 months ago

9 months ago

8 months ago

9 months ago

9 months ago

5 months ago

6 months ago

7 months ago

6 months ago

12 months ago

11 months ago

9 months ago

5 months ago

9 months ago

7 months ago

7 months ago

10 months ago

6 months ago

9 months ago

6 months ago

10 months ago

9 months ago

9 months ago

9 months ago

7 months ago

5 months ago

6 months ago

12 months ago

5 months ago

10 months ago

10 months ago

7 months ago

12 months ago

10 months ago

5 months ago

6 months ago

7 months ago

11 months ago

6 months ago

10 months ago

11 months ago

6 months ago

9 months ago

10 months ago

10 months ago

9 months ago

12 months ago

8 months ago

8 months ago

7 months ago

8 months ago

9 months ago

11 months ago

7 months ago

10 months ago

5 months ago

9 months ago

7 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

9 months ago

9 months ago

9 months ago

10 months ago

7 months ago

10 months ago

10 months ago

11 months ago

6 months ago

10 months ago

12 months ago

5 months ago

7 months ago

5 months ago

7 months ago

7 months ago

7 months ago

5 months ago

9 months ago

9 months ago

7 months ago

6 months ago

11 months ago

5 months ago

6 months ago

9 months ago

5 months ago

10 months ago

9 months ago

11 months ago

10 months ago

6 months ago

7 months ago

9 months ago

7 months ago

10 months ago

11 months ago

6 months ago

6 months ago

10 months ago

7 months ago

10 months ago

7 months ago

9 months ago

5 months ago

9 months ago

7 months ago

10 months ago

9 months ago

10 months ago

6 months ago

5 months ago

5 months ago

11 months ago

12 months ago

7 months ago

7 months ago

7 months ago

5 months ago

10 months ago

9 months ago

7 months ago

9 months ago

6 months ago

7 months ago

7 months ago

12 months ago

10 months ago

9 months ago

9 months ago

5 months ago

9 months ago

9 months ago

9 months ago

7 months ago

5 months ago

9 months ago

5 months ago

9 months ago

6 months ago

5 months ago

5 months ago

5 months ago

9 months ago

6 months ago

9 months ago

6 months ago

11 months ago

9 months ago

9 months ago

5 months ago

7 months ago

5 months ago

10 months ago

10 months ago

5 months ago

6 months ago

5 months ago

12 months ago

9 months ago

9 months ago

11 months ago

11 months ago

11 months ago