@puckeditor/cli 0.24.0-canary.301a0304

package/dist/docs/api-reference/data-model/app-state.md

@@ -0,0 +1,168 @@
+# `AppState`
+
+> **Note:** The application state is unstable and is likely to experience breaking
+> changes.
+
+The internal state of the [`<Puck>`](/docs/api-reference/components/puck) component.
+
+## `data`
+
+The current [`Data`](/docs/api-reference/data-model/data) payload being managed by Puck.
+
+## `ui`
+
+The current state of the Puck editor interface.
+
+| Param                                           | Example                                               | Type                          |
+| ----------------------------------------------- | ----------------------------------------------------- | ----------------------------- |
+| [`arrayState`](#uiarraystate)                   | `{}`                                                  | Object                        |
+| [`componentList`](#uicomponentlist)             | `{ typography: { components: [ "HeadingBlock" ] } }`  | Object                        |
+| [`field.focus`](#fieldfocus)                    | `"title"`                                             | String                        |
+| [`isDragging`](#isdragging)                     | `false`                                               | Boolean                       |
+| [`itemSelector`](#uiitemselector)               | `{ index: 0, zone: "my-content" }`                    | [ItemSelector](/docs/api-reference/data-model/item-selector) |
+| [`leftSideBarVisible`](#uileftsidebarvisible)   | `false`                                               | Boolean                       |
+| [`leftSideBarWidth`](#uileftsidebarwidth)       | `200`                                                 | Number                        |
+| [`mobilePanelExpanded`](#uimobilepanelexpanded) | `true`                                                | Boolean                       |
+| [`plugin`](#uiplugin)                           | `{ current: "blocks" }`                               | Object                        |
+| [`previewMode`](#uipreviewmode)                 | `"edit"`                                              | String                        |
+| [`rightSideBarVisible`](#uirightsidebarvisible) | `false`                                               | Boolean                       |
+| [`rightSideBarWidth`](#uirightsidebarwidth)     | `200`                                                 | Number                        |
+| [`viewports`](#uiviewports)                     | `{ controlsVisible: true, current: {}, options: [] }` | Object                        |
+
+---
+
+### `ui.arrayState`
+
+An object describing the internal state of array items
+
+---
+
+### `ui.componentList`
+
+An object describing the component drawer. Similar shape to the [categories API](/docs/api-reference/configuration/config#categories)
+
+#### `ui.componentList[key].components`
+
+Array containing the names of components in this category.
+
+#### `ui.componentList[key].title`
+
+Title of the category.
+
+#### `ui.componentList[key].visible`
+
+Whether or not the category is visible in the side bar.
+
+#### `ui.componentList[key].expanded`
+
+Whether or not the category is expanded in the side bar.
+
+---
+
+### `ui.field.focus`
+
+The name of the currently focused field.
+
+### `ui.field.metadata`
+
+Metadata for the the currently focused field.
+
+---
+
+### `ui.isDragging`
+
+A boolean stating whether or not the user is currently dragging a component.
+
+---
+
+### `ui.itemSelector`
+
+An [`ItemSelector`](/docs/api-reference/data-model/item-selector) for the currently selected item.
+
+---
+
+### `ui.leftSideBarVisible`
+
+Whether or not the left side bar is visible.
+
+---
+
+### `ui.leftSideBarWidth`
+
+Current width of the left side bar in pixels.
+
+---
+
+### `ui.mobilePanelExpanded`
+
+Indicates whether the mobile plugin panel is expanded when the [`mobilePanelHeight` parameter](/docs/api-reference/plugin#mobilepanelheight) is set to `"toggle"`. Users toggle this value via the maximize/minimize button that appears on smaller viewports.
+
+---
+
+### `ui.plugin`
+
+| Param                         | Example    | Type   |
+| ----------------------------- | ---------- | ------ |
+| [`current`](#uiplugincurrent) | `"blocks"` | String |
+
+#### `ui.plugin.current`
+
+The currently selected plugin in the plugin rail. Matches the plugin [`name` parameter](/docs/api-reference/plugin#name).
+
+---
+
+### `ui.previewMode`
+
+The mode for the preview area, controlling whether or not the user can interact with the underlying component. Accepts the following values:
+
+- **`"edit"` (default)**: Components can be dragged and modified. An overlay prevents interaction with the underlying component.
+- **`"interactive"`**: Editing functionality is disabled. The user can interact with the underlying component.
+
+Puck does not currently provide the UI to control this value, but it can be toggled via the `cmd+i` or `ctrl+i` hotkeys.
+
+---
+
+### `ui.rightSideBarVisible`
+
+Whether or not the right side bar is visible.
+
+---
+
+### `ui.rightSideBarWidth`
+
+Current width of the right side bar in pixels.
+
+---
+
+### `ui.viewports`
+
+| Param                                            | Example                           | Type                                                                 |
+| ------------------------------------------------ | --------------------------------- | -------------------------------------------------------------------- |
+| [`controlsVisible`](#uiviewportscontrolsvisible) | `false`                           | Boolean                                                              |
+| [`current`](#uiviewportscurrent)                 | `{ width: 1440, height: "auto" }` | Object                                                               |
+| [`options`](#uiviewportsoptions)                 | `[]`                              | [Viewports\[\]](/docs/api-reference/components/puck#viewport-params) |
+
+#### `ui.viewports.controlsVisible`
+
+Whether or not the viewport controls are visible.
+
+#### `ui.viewports.current`
+
+The currently selected viewport.
+
+| Param                                 | Example  | Type               |
+| ------------------------------------- | -------- | ------------------ |
+| [`width`](#uiviewportscurrentwidth)   | `1440`   | Number             |
+| [`height`](#uiviewportscurrentheight) | `"auto"` | Number \| `"auto"` |
+
+##### `ui.viewports.current.width`
+
+The width of the current viewport.
+
+##### `ui.viewports.current.height`
+
+The height of the current viewport.
+
+#### `ui.viewports.options`
+
+The available viewport options, as provided via the [`viewports` API](/docs/api-reference/components/puck#viewports).

package/dist/docs/api-reference/data-model/component-data.md

@@ -0,0 +1,62 @@
+# `ComponentData`
+
+An object representing an instance of a component.
+
+```json
+{
+  "type": "HeadingBlock",
+  "props": {
+    "id": "HeadingBlock-1234",
+    "title": "Hello, world"
+  }
+}
+```
+
+## Params
+
+| Param                   | Example                                         | Type   | Status   |
+| ----------------------- | ----------------------------------------------- | ------ | -------- |
+| [`type`](#type)         | `type: "HeadingBlock"`                          | String | Required |
+| [`props`](#props)       | `props: { id: "12345", title: "Hello, world" }` | Object | Required |
+| [`readOnly`](#readonly) | `readOnly: { title: true }`                     | Object | -        |
+
+### Required params
+
+#### `type`
+
+The type of the component, which tells Puck to run the [`render()`](/docs/api-reference/configuration/component-config#renderprops) method for the component of the [same key](/docs/api-reference/configuration/config#components).
+
+#### `props`
+
+The props stored based on the [`component config`](/docs/api-reference/configuration/component-config) that Puck will pass to the [`render()`](/docs/api-reference/configuration/component-config#renderprops) method for the component.
+
+```json
+{
+  "type": "HeadingBlock",
+  "props": {
+    "id": "HeadingBlock-1234", // Auto-generated
+    "title": "Hello, world"
+  }
+}
+```
+
+Requires a unique `id` prop to be defined.
+
+### Optional params
+
+#### `readOnly`
+
+An object describing which fields are set to [read-only](/docs/api-reference/configuration/component-config#datareadonly-1).
+
+```json
+{
+  "type": "HeadingBlock",
+  "props": {
+    "id": "HeadingBlock-1234",
+    "title": "Hello, world"
+  },
+  "readOnly": {
+    "title": true
+  }
+}
+```

package/dist/docs/api-reference/data-model/data.md

@@ -0,0 +1,95 @@
+# `Data`
+
+An object produced by Puck describing the shape of content.
+
+```json
+{
+  "content": [
+    {
+      "type": "HeadingBlock",
+      "props": {
+        "id": "HeadingBlock-1234",
+        "title": "Hello, world"
+      }
+    }
+  ],
+  "root": { "props": { "title": "Puck Example" } },
+  "zones": {}
+}
+```
+
+## Params
+
+| Param                 | Example                                  | Type                                                             | Status   |
+| --------------------- | ---------------------------------------- | ---------------------------------------------------------------- | -------- |
+| [`content`](#content) | `content: []`                            | [ComponentData](/docs/api-reference/data-model/component-data)[] | Required |
+| [`root`](#root)       | `root: { props: { title: "My page" } }`  | [RootData](/docs/api-reference/root-data)                        | Required |
+| [`zones`](#zones)     | `zones: { "HeadingBlock-123:zone": [] }` | Object                                                           | -        |
+
+### `content`
+
+An array of [ComponentData](/docs/api-reference/data-model/component-data) objects representing the component instances in the default content region.
+
+```json
+{
+  "content": [
+    {
+      "type": "HeadingBlock",
+      "props": {
+        "id": "HeadingBlock-1234",
+        "title": "Hello, world"
+      }
+    }
+  ],
+  "root": {},
+  "zones": {}
+}
+```
+
+### `root`
+
+An object describing data for the [`root` config](/docs/api-reference/configuration/config#root). An instance of [`RootData`](/docs/api-reference/root-data).
+
+```json
+{
+  "content": [],
+  "root": {
+    "props": {
+      "title": "My page"
+    }
+  },
+  "zones": {}
+}
+```
+
+### `zones`
+
+> **Note:** This parameter will soon be deprecated, as DropZones have been replaced by
+> [`slot` fields](/docs/api-reference/fields/slot). For migration notes, see
+> [these docs](/docs/guides/migrations/dropzones-to-slots).
+
+An object describing nested content regions for each [DropZone](/docs/api-reference/components/drop-zone).
+
+#### `zones[zoneKey]`
+
+An array of [ComponentData](/docs/api-reference/data-model/component-data) objects representing the components instances in a particular DropZone.
+
+`zoneKey` is a compound of the component `id` and [DropZone `zone`](/docs/api-reference/components/drop-zone#zone).
+
+```json
+{
+  "content": [],
+  "root": {},
+  "zones": {
+    "HeadingBlock-1234:my-content": [
+      {
+        "type": "HeadingBlock",
+        "props": {
+          "id": "HeadingBlock-1234",
+          "title": "Hello, world"
+        }
+      }
+    ]
+  }
+}
+```

package/dist/docs/api-reference/data-model/item-selector.md

@@ -0,0 +1,34 @@
+# `ItemSelector`
+
+An object describing the location of an item in the Puck [data](/docs/api-reference/data-model/data).
+
+```json
+{
+  "index": 0,
+  "zone": "Flex-123:children" // The "children" slot field in the component with id "Flex-123"
+}
+```
+
+## Params
+
+| Param             | Example                       | Type   | Status   |
+| ----------------- | ----------------------------- | ------ | -------- |
+| [`index`](#index) | `index: 0`                    | Number | Required |
+| [`zone`](#zone)   | `zone: "Flex-123:children" }` | String | -        |
+
+### `index`
+
+The index of the item.
+
+### `zone`
+
+An optional string representing the location of the item. It is a concatenation of two values, joined with a colon (`:`):
+
+1. The id of the parent component
+2. The name of the [slot field](/docs/api-reference/fields/slot) or [DropZone `zone`](/docs/api-reference/components/drop-zone#zone) value
+
+The root of the payload is represented by the `root` id. The default content is represented by `default-zone`. When not provided, `zone` will contain the value `root:default-zone`, injecting data into [`content`](/docs/api-reference/data-model/data#content)
+
+> **Note:** DropZones have been replaced by [`slot`
+> fields](/docs/api-reference/fields/slot). For migration notes, see [these
+> docs](/docs/guides/migrations/dropzones-to-slots).

package/dist/docs/api-reference/data-model/root-data.md

@@ -0,0 +1,59 @@
+# `RootData`
+
+An object representing the root data. Similar to [`ComponentData`](/docs/api-reference/data-model/component-data).
+
+```json
+{
+  "props": {
+    "title": "Hello, world"
+  }
+}
+```
+
+## Params
+
+| Param                          | Example                            | Type   | Status   |
+| ------------------------------ | ---------------------------------- | ------ | -------- |
+| [`props`](#contentprops)       | `props: { title: "Hello, world" }` | Object | Required |
+| [`readOnly`](#contentreadonly) | `readOnly: { title: true }`        | Object | -        |
+
+### Required params
+
+#### `type`
+
+The type of the component, which tells Puck to run the [`render()`](/docs/api-reference/configuration/component-config#renderprops) method for the component of the [same key](/docs/api-reference/config#components).
+
+#### `props`
+
+The props stored based on the [`component config`](/docs/api-reference/configuration/component-config) that Puck will pass to the [`render()`](/docs/api-reference/configuration/component-config#renderprops) method for the component of the [same key](/docs/api-reference/config#components).
+
+```json
+{
+  "type": "HeadingBlock",
+  "props": {
+    "id": "HeadingBlock-1234",
+    "title": "Hello, world"
+  }
+}
+```
+
+Requires `id` unless used for [`root`](/docs/api-reference/data-model/data#root).
+
+### Optional params
+
+#### `readOnly`
+
+An object describing which fields are set to [read-only](/docs/api-reference/configuration/component-config#datareadonly-1).
+
+```json
+{
+  "type": "HeadingBlock",
+  "props": {
+    "id": "HeadingBlock-1234",
+    "title": "Hello, world"
+  },
+  "readOnly": {
+    "title": true
+  }
+}
+```

package/dist/docs/api-reference/data-model.md

@@ -0,0 +1,8 @@
+# Data Model
+
+The Puck data model
+
+- [AppState](/docs/api-reference/data-model/app-state) - Puck's internal state.
+- [ComponentData](/docs/api-reference/data-model/component-data) - The data model for each component instance.
+- [Data](/docs/api-reference/data-model/data) - The data model produced by Puck for a page.
+- [RootData](/docs/api-reference/data-model/root-data) - The data model for the root data.

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

@@ -0,0 +1,172 @@
+# Dictionary
+
+The dictionary defines the text strings used throughout Puck's UI.
+
+Use this to implement [localization](/docs/integrating-puck/localization) or to override default messages:
+
+```tsx
+const dictionary = {
+  "header-publish": "Save",
+};
+
+<Puck dictionary={dictionary} />;
+```
+
+When a default string contains a template variable (e.g. `{count}`), you can use that to position the variable in your string:
+
+```tsx
+const dictionary = {
+  "field-external-result-singular": "Total: {count}",
+  "field-external-result-plural": "Total: {count}",
+};
+```
+
+The dictionary also accepts your own keys, which you can read from the [internal Puck API](/docs/api-reference/puck-api#dictionary). See [Custom strings](/docs/integrating-puck/localization#custom-strings).
+
+## Tokens
+
+Tokens follow a `{area}-{name}-{variant}` format.
+
+Many tokens set an element's HTML `title` attribute, a tooltip that only appears on hover, rather than always-visible text. These are marked _(tooltip)_ below.
+
+### Header
+
+| Token                        | Default                  | Used for                         |
+| ---------------------------- | ------------------------ | -------------------------------- |
+| `header-publish`             | `"Publish"`              | Publish button                   |
+| `header-undo`                | `"undo"`                 | Undo button (tooltip)            |
+| `header-redo`                | `"redo"`                 | Redo button (tooltip)            |
+| `header-toggle-leftsidebar`  | `"Toggle left sidebar"`  | Sidebar toggle (tooltip)         |
+| `header-toggle-rightsidebar` | `"Toggle right sidebar"` | Sidebar toggle (tooltip)         |
+| `header-toggle-menubar`      | `"Toggle menu bar"`      | Mobile menu bar toggle (tooltip) |
+
+### Actions
+
+| Token                 | Default           | Used for                       |
+| --------------------- | ----------------- | ------------------------------ |
+| `action-selectparent` | `"Select parent"` | Component action bar (tooltip) |
+| `action-duplicate`    | `"Duplicate"`     | Component action bar (tooltip) |
+| `action-delete`       | `"Delete"`        | Component action bar (tooltip) |
+
+### Labels
+
+| Token             | Default       | Used for                                                |
+| ----------------- | ------------- | ------------------------------------------------------- |
+| `label-page`      | `"Page"`      | Breadcrumbs, fields panel title, header title fallback  |
+| `label-component` | `"Component"` | Outline and breadcrumbs, for unresolved component types |
+
+### Outline
+
+| Token                        | Default          | Used for                               |
+| ---------------------------- | ---------------- | -------------------------------------- |
+| `outline-empty`              | `"No items"`     | Empty zone                             |
+| `outline-header-title`       | `"Outline"`      | Outline header title                   |
+| `outline-header-collapseall` | `"Collapse all"` | Outline header collapse all (tooltip)  |
+| `outline-item-collapse`      | `"Collapse"`     | Outline row toggle (tooltip)           |
+| `outline-item-expand`        | `"Expand"`       | Outline row toggle (tooltip)           |
+| `outline-item-duplicate`     | `"Duplicate"`    | Outline row duplicate action (tooltip) |
+| `outline-item-delete`        | `"Delete"`       | Outline row delete action (tooltip)    |
+
+### Drawer
+
+| Token                      | Default              | Used for                                      |
+| -------------------------- | -------------------- | --------------------------------------------- |
+| `drawer-category-collapse` | `"Collapse {title}"` | Category toggle (tooltip)                     |
+| `drawer-category-expand`   | `"Expand {title}"`   | Category toggle (tooltip)                     |
+| `drawer-category-other`    | `"Other"`            | Default category for uncategorized components |
+
+### Canvas
+
+| Token             | Default                         | Used for                                           |
+| ----------------- | ------------------------------- | -------------------------------------------------- |
+| `canvas-noconfig` | `"No configuration for {type}"` | Placeholder for components missing from the config |
+
+### Fields
+
+| Token            | Default       | Used for                            |
+| ---------------- | ------------- | ----------------------------------- |
+| `field-readonly` | `"Read-only"` | Read-only field lock icon (tooltip) |
+
+#### Array field
+
+| Token                       | Default           | Used for              |
+| --------------------------- | ----------------- | --------------------- |
+| `field-arrayitem-summary`   | `"Item #{index}"` | Item default label    |
+| `field-arrayitem-duplicate` | `"Duplicate"`     | Item action (tooltip) |
+| `field-arrayitem-delete`    | `"Delete"`        | Item action (tooltip) |
+
+#### External field
+
+| Token                            | Default             | Used for                         |
+| -------------------------------- | ------------------- | -------------------------------- |
+| `field-external-selectdata`      | `"Select data"`     | Trigger button and modal heading |
+| `field-external-search`          | `"Search"`          | Modal search                     |
+| `field-external-togglefilters`   | `"Toggle filters"`  | Modal filter toggle (tooltip)    |
+| `field-external-item`            | `"External item"`   | Selected item default label      |
+| `field-external-result-singular` | `"{count} result"`  | Modal footer                     |
+| `field-external-result-plural`   | `"{count} results"` | Modal footer                     |
+
+#### Rich text field
+
+| Token                                | Default             | Used for                    |
+| ------------------------------------ | ------------------- | --------------------------- |
+| `field-richtext-bold`                | `"Bold"`            | Formatting button (tooltip) |
+| `field-richtext-italic`              | `"Italic"`          | Formatting button (tooltip) |
+| `field-richtext-underline`           | `"Underline"`       | Formatting button (tooltip) |
+| `field-richtext-strikethrough`       | `"Strikethrough"`   | Formatting button (tooltip) |
+| `field-richtext-blockquote`          | `"Blockquote"`      | Formatting button (tooltip) |
+| `field-richtext-code-inline`         | `"Inline code"`     | Formatting button (tooltip) |
+| `field-richtext-code-block`          | `"Code block"`      | Formatting button (tooltip) |
+| `field-richtext-list-bullet`         | `"Bullet list"`     | Formatting button (tooltip) |
+| `field-richtext-list-ordered`        | `"Ordered list"`    | Formatting button (tooltip) |
+| `field-richtext-horizontalrule`      | `"Horizontal rule"` | Formatting button (tooltip) |
+| `field-richtext-align-left`          | `"Align left"`      | Alignment button (tooltip)  |
+| `field-richtext-align-center`        | `"Align center"`    | Alignment button (tooltip)  |
+| `field-richtext-align-right`         | `"Align right"`     | Alignment button (tooltip)  |
+| `field-richtext-align-justify`       | `"Justify"`         | Alignment button (tooltip)  |
+| `field-richtext-select`              | `"Select"`          | Select control (tooltip)    |
+| `field-richtext-headingselect-1`     | `"Heading 1"`       | Heading select option       |
+| `field-richtext-headingselect-2`     | `"Heading 2"`       | Heading select option       |
+| `field-richtext-headingselect-3`     | `"Heading 3"`       | Heading select option       |
+| `field-richtext-headingselect-4`     | `"Heading 4"`       | Heading select option       |
+| `field-richtext-headingselect-5`     | `"Heading 5"`       | Heading select option       |
+| `field-richtext-headingselect-6`     | `"Heading 6"`       | Heading select option       |
+| `field-richtext-alignselect-left`    | `"Left"`            | Alignment select option     |
+| `field-richtext-alignselect-center`  | `"Center"`          | Alignment select option     |
+| `field-richtext-alignselect-right`   | `"Right"`           | Alignment select option     |
+| `field-richtext-alignselect-justify` | `"Justify"`         | Alignment select option     |
+| `field-richtext-listselect-bullet`   | `"Bullet list"`     | List select option          |
+| `field-richtext-listselect-ordered`  | `"Ordered list"`    | List select option          |
+
+### Viewport controls
+
+| Token                     | Default                        | Used for                                |
+| ------------------------- | ------------------------------ | --------------------------------------- |
+| `viewport-zoom-in`        | `"Zoom viewport in"`           | Zoom button (tooltip)                   |
+| `viewport-zoom-out`       | `"Zoom viewport out"`          | Zoom button (tooltip)                   |
+| `viewport-zoom-auto`      | `"{zoom}% (Auto)"`             | Auto zoom select option                 |
+| `viewport-toggle-menu`    | `"Toggle viewport menu"`       | Menu toggle (tooltip)                   |
+| `viewport-switch`         | `"Switch to {label} viewport"` | Viewport button (tooltip)               |
+| `viewport-switch-default` | `"Switch viewport"`            | Viewport button, if unlabeled (tooltip) |
+
+### Plugin bar
+
+| Token               | Default        | Used for                             |
+| ------------------- | -------------- | ------------------------------------ |
+| `plugin-blocks`     | `"Blocks"`     | Sidebar tab and legacy section title |
+| `plugin-outline`    | `"Outline"`    | Sidebar tab                          |
+| `plugin-fields`     | `"Fields"`     | Sidebar tab                          |
+| `plugin-components` | `"Components"` | Legacy sidebar section title         |
+
+### Layout
+
+| Token             | Default      | Used for                      |
+| ----------------- | ------------ | ----------------------------- |
+| `layout-maximize` | `"maximize"` | Mobile panel toggle (tooltip) |
+| `layout-minimize` | `"minimize"` | Mobile panel toggle (tooltip) |
+
+### Loader
+
+| Token            | Default     | Used for                     |
+| ---------------- | ----------- | ---------------------------- |
+| `loader-loading` | `"loading"` | Loading spinner (aria-label) |

package/dist/docs/api-reference/field-transforms.md

@@ -0,0 +1,51 @@
+# FieldTransforms
+
+Transform the data for each [field type](/docs/api-reference/fields) before rendering in the editor.
+
+```tsx
+const UppercaseText = ({ value }) => <p>{value.toUpperCase()}</p>;
+
+const fieldTransforms = {
+  text: (props) => <UppercaseText {...props} />,
+  // ...
+};
+```
+
+You can specify a custom render method for each known [field type](/docs/api-reference/fields), or introduce completely new ones.
+
+## Render Props
+
+| Prop                          | Example              | Type                                |
+| ----------------------------- | -------------------- | ----------------------------------- |
+| [`componentId`](#componentid) | `"Heading-12345"`    | string                              |
+| [`field`](#field)             | `{ type: "text" }`   | [Field](/docs/api-reference/fields) |
+| [`isReadOnly`](#isreadonly)   | `false`              | boolean                             |
+| [`propName`](#propname)       | `"title"`            | string                              |
+| [`propPath`](#proppath)       | `"obj.arr[2].title"` | string                              |
+| [`value`](#value)             | `"Value"`            | any                                 |
+
+### `componentId`
+
+The id of the component containing this prop
+
+### `field`
+
+The component's field definition for this prop.
+
+### `isReadOnly`
+
+Whether or not this field is currently set to read-only.
+
+### `propName`
+
+The name of this prop provided to the [component field](/docs/api-reference/configuration/component-config#fields) config.
+
+### `propPath`
+
+The path of this prop within the props object.
+
+Use in conjunction with the [`setDeep`](/docs/api-reference/functions/set-deep) utility to set data for a key deep within an object or array, normally [ComponentData](/docs/api-reference/data-model/component-data).
+
+### `value`
+
+The value of the prop.