`ComponentData`

An object representing an instance of a component.

{
  "type": "HeadingBlock",
  "props": {
    "id": "HeadingBlock-1234",
    "title": "Hello, world"
  }
}

Params

Param	Example	Type	Status
`type`	`type: "HeadingBlock"`	String	Required
`props`	`props: { id: "12345", title: "Hello, world" }`	Object	Required
`readOnly`	`readOnly: { title: true }`	Object	-
`synced`	`synced: true`	Boolean	-

Required params

`type`

The type of the component, which tells React Editor to run the render() method for the component of the same key.

`props`

The props stored based on the component config that React Editor will pass to the render() method for the component.

{
  "type": "HeadingBlock",
  "props": {
    "id": "HeadingBlock-1234", // Auto-generated
    "title": "Hello, world"
  }
}

Requires a unique id prop to be defined.

Optional params

`synced`

For a component whose global config is enabled, controls whether its props come from data.globals[type]. Global components are synced by default; set this to false to keep that instance’s props local. The instance id and nested children remain page-local.

{
  "type": "SiteHeader",
  "props": { "id": "SiteHeader-1234" },
  "synced": true
}

`readOnly`

An object describing which fields are set to read-only.

{
  "type": "HeadingBlock",
  "props": {
    "id": "HeadingBlock-1234",
    "title": "Hello, world"
  },
  "readOnly": {
    "title": true
  }
}

AppState Data