@puckeditor/cli 0.24.0-canary.301a0304

package/dist/docs/api-reference/components/rich-text-menu-control.md

@@ -0,0 +1,87 @@
+# \<RichTextMenu.Control\>
+
+Render a custom rich text control. Always use inside [`<RichTextMenu.Group>`](/docs/api-reference/components/rich-text-menu-group). See [included controls](/docs/api-reference/components/rich-text-menu#included-controls).
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+/>
+```
+
+## Control Props
+
+| Prop                    | Example     | Type      | Status   |
+| ----------------------- | ----------- | --------- | -------- |
+| [`icon`](#icon)         | `<Quote />` | ReactNode | Required |
+| [`title`](#title)       | `"Quote"`   | string    | Required |
+| [`onClick`](#onclick)   | `() => {}`  | Function  | Required |
+| [`active`](#active)     | `true`      | Boolean   | -        |
+| [`disabled`](#disabled) | `true`      | Boolean   | -        |
+
+## Required props
+
+### icon
+
+The icon to render for the control, as a React node. Puck uses [lucide-react](https://lucide.dev/guide/packages/lucide-react) internally.
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+/>
+```
+
+### title
+
+An title for the icon control, for accessibility.
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+/>
+```
+
+### onClick
+
+A callback to trigger when the control is clicked.
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+/>
+```
+
+## Optional props
+
+### active
+
+Whether or not this control is currently active.
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+  active={editorState?.isBlockquote}
+/>
+```
+
+### disabled
+
+Whether or not this control is currently disabled.
+
+```tsx
+<RichTextMenu.Control
+  icon={<Quote />}
+  title="Quote"
+  onClick={() => editor.chain().focus().toggleBlockquote().run()}
+  disabled={editorState?.canBlockquote}
+/>
+```

package/dist/docs/api-reference/components/rich-text-menu-group.md

@@ -0,0 +1,27 @@
+# \<RichTextMenu.Group\>
+
+Render a group of rich text controls. Always use inside `<RichTextMenu>`.
+
+```tsx
+<RichTextMenu.Group>
+  <RichTextMenu.Bold />
+  <RichTextMenu.Italic />
+  <RichTextMenu.Underline />
+</RichTextMenu.Group>
+```
+
+## Props
+
+| Prop                    | Example                 | Type      | Status   |
+| ----------------------- | ----------------------- | --------- | -------- |
+| [`children`](#children) | `<RichTextMenu.Bold />` | ReactNode | Required |
+
+## Required Props
+
+### children
+
+The controls to render in this group, including:
+
+- [included controls](#included-controls)
+- custom controls using [`<RichTextMenu.Control>`](/docs/api-reference/components/rich-text-menu-control)
+- additional custom UI

package/dist/docs/api-reference/components/rich-text-menu.md

@@ -0,0 +1,99 @@
+# \<RichTextMenu\>
+
+A menu of rich text controls for the [`richtext`](/docs/api-reference/fields/richtext) field.
+
+```tsx
+<RichTextMenu>
+  <RichTextMenu.Group>
+    <RichTextMenu.Bold />
+    <RichTextMenu.Italic />
+    <RichTextMenu.Underline />
+  </RichTextMenu.Group>
+</RichTextMenu>
+```
+
+## Props
+
+| Prop                    | Example   | Type      | Status   |
+| ----------------------- | --------- | --------- | -------- |
+| [`children`](#children) | `<div />` | ReactNode | Required |
+
+## Required Props
+
+### `children`
+
+A fragment of [`<RichTextMenu.Group>`](/docs/api-reference/components/rich-text-group) components, each containing:
+
+- [included controls](#included-controls),
+- custom controls using [`<RichTextMenu.Control>`](/docs/api-reference/components/rich-text-menu-control), or
+- additional custom UI
+
+## Included controls
+
+### \<RichTextMenu.AlignCenter\>
+
+Align the text to the center. Configured by the [`textAlign`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.AlignJustify\>
+
+Justify the text. Configured by the [`textAlign`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.AlignLeft\>
+
+Align the text to the left. Configured by the [`textAlign`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.AlignRight\>
+
+Align the text to the right. Configured by the [`textAlign`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.AlignSelect\>
+
+A select dropdown with all text alignment options. Configured by the [`textAlign`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.Blockquote\>
+
+Wrap the text with `<blockquote>`. Configured by the [`blockquote`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.Bold\>
+
+Mark the text as bold. Configured by the [`bold`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.BulletList\>
+
+Wrap the text with an unordered list (`<ul>`). Configured by the [`bulletList`](/docs/api-reference/fields/richtext#options) and [`listItem`](/docs/api-reference/fields/richtext#options) options.
+
+### \<RichTextMenu.CodeBlock\>
+
+Wrap the text with a code block (`<pre>` and `<code>`). Configured by the [`codeBlock`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.HeadingSelect\>
+
+A select dropdown to set the text as a heading (`h1`, `h2`, `h3`, etc). Configured by the [`heading`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.HorizontalRule\>
+
+Insert a horizontal rule (`<hr>`). Configured by the [`horizontalRule`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.InlineCode\>
+
+Wrap the text with `<code>`. Configured by the [`code`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.Italic\>
+
+Mark the text as italic. Configured by the [`italic`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.ListSelect\>
+
+A select dropdown with all list options (`ul`, `ol`). Configured by the [`bulletList`](/docs/api-reference/fields/richtext#options), [`orderedList`](/docs/api-reference/fields/richtext#options) and [`listItem`](/docs/api-reference/fields/richtext#options) options.
+
+### \<RichTextMenu.OrderedList\>
+
+Wrap the text with an ordered list (`<ol>`). Configured by the [`orderedList`](/docs/api-reference/fields/richtext#options) and [`listItem`](/docs/api-reference/fields/richtext#options) options.
+
+### \<RichTextMenu.Strikethrough\>
+
+Mark the text as struck-through. Configured by the [`strike`](/docs/api-reference/fields/richtext#options) option.
+
+### \<RichTextMenu.Underline\>
+
+Mark the text as underlined. Configured by the [`underline`](/docs/api-reference/fields/richtext#options) option.

package/dist/docs/api-reference/components.md

@@ -0,0 +1,32 @@
+# Components
+
+Puck provides several components to support different integration approaches.
+
+## Core
+
+- [\<DropZone\>](/docs/api-reference/components/drop-zone) - Place droppable regions (zones) inside other components to enable nested components.
+- [\<Puck\>](/docs/api-reference/components/puck) - Render the Puck editor.
+- [\<Render\>](/docs/api-reference/components/render) - Render a [`Data`](/docs/api-reference/data-model/data) object for a given [`Config`](/docs/api-reference/configuration/config).
+
+## Compositional
+
+- [\<Puck.Components\>](/docs/api-reference/components/puck-components) - A draggable list of components when composing a custom Puck UI.
+- [\<Puck.Fields\>](/docs/api-reference/components/puck-fields) - The fields for the currently selected item when composing a custom Puck UI.
+- [\<Puck.Layout\>](/docs/api-reference/components/puck-layout) - The standard Puck layout.
+- [\<Puck.Outline\>](/docs/api-reference/components/puck-outline) - An interactive outline when composing a custom Puck UI.
+- [\<Puck.Preview\>](/docs/api-reference/components/puck-preview) - A drag-and-drop preview when composing a custom Puck UI.
+
+## Helper
+
+- [\<ActionBar\>](/docs/api-reference/components/action-bar) - An action bar containing a series of actions, normally used with the [actionBar override](/docs/api-reference/overrides/action-bar).
+- [\<ActionBar.Action\>](/docs/api-reference/components/action-bar-action) - An action for use within the ActionBar component.
+- [\<ActionBar.Group\>](/docs/api-reference/components/action-bar-group) - A group of actions for use within the ActionBar component.
+- [\<ActionBar.Label\>](/docs/api-reference/components/action-bar-label) - A label for use within the ActionBar component.
+- [\<ActionBar.Separator\>](/docs/api-reference/components/action-bar-separator) - A separator to divide elements in the ActionBar component.
+- [\<Drawer\>](/docs/api-reference/components/drawer) - A reference list of items that can be dragged into a droppable area, normally [`<Puck.Preview>`](/docs/api-reference/components/puck-preview).
+- [\<Drawer.Item\>](/docs/api-reference/components/drawer-item) - An item that can be dragged from a [`<Drawer>`](/docs/api-reference/components/drawer).
+- [\<FieldLabel\>](/docs/api-reference/components/field-label) - Render a styled `label` when creating [`custom` fields](/docs/api-reference/fields/custom).
+- [\<InlineTextField\>](/docs/api-reference/components/inline-text-field) - Render an inline-editable text element from a [field transform](/docs/api-reference/field-transforms).
+- [\<RichTextMenu\>](/docs/api-reference/components/rich-text-menu) - A menu containing a series of controls for the rich text field.
+- [\<RichTextMenu.Control\>](/docs/api-reference/components/rich-text-menu-control) - A control for custom behavior within the RichTextMenu component.
+- [\<RichTextMenu.Group\>](/docs/api-reference/components/rich-text-menu-group) - A group of controls for use within the RichTextMenu component.