Component description

The component property adds components created in the components asset of any package to the object type or pages templates.

Minimal JSON

{
  "type": "component",
  "value": ""
}
{
  "key": "app_overview_table_generic_in_panel",
  "template": {
    "componentId": "template#app_overview_table_generic_in_panel",
    "type": "panel",
    "title": "",
    "values": [
      {
        "value": "section_objects_table",
        "componentId": "app_overview_table_generic_in_panel#section_objects_table",
        "type": "component"
      }
    ]
  }
}

Example of a component in a panel taken from the core package.

Nested properties

PropertyDescriptionValuesMandatory
typecomponentstringYes
valueKey of the component added to the template. For example, when placing multiple predefined components in a panel.stringYes
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template).stringNo