Composable puck

[chrisvxd]

Merge blocked by #41, but ready for review regardless.

Description

This PR

• adds compositional Puck via children
• adds a usePuck hook for building custom components within compositional Puck
• adds an overrides prop to override specific parts of the interface, replacing renderHeader and renderHeaderActions
• adds a ui prop to set the initial UI state
• adds an isDragging boolean in the UI state
• makes onPublish optional
• removes the renderComponentList prop (breaking change)
• updates the plugin API to align with the overrides functionality (breaking change, but not listed as feat so won't appear in changelog - might want to revisit)

👉 See an example page with custom overrides 👈

Rather than reimplement the docs here, I suggest reading the new Extending Puck section in the docs.

Additional reading:

• Updated components API reference
• New Overrides API reference
• New usePuck API reference
• Updated Plugin API reference

Tasks

• Rename customUi to skin, outfit or theme?
• Rename Puck.fields to Puck.form?
• Document
• Add children to overrides.headerActions for plugin currying
• Ensure Plugin API supports customUi.fields
• Consider adding an explicit feat for breaking the plugin API
• Finalise naming for appState (vs state) in usePuck hook
• Remove padding and border from Puck fields by default?
• Add experimental warning to overrides?

Closes #224

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
puck-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2023 6:43pm
puck-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 11, 2023 6:43pm