Component description

The panel component wraps multiple components in the same box. Panels appear as a grey border and title.

Example

Minimal JSON

{
  "type": "panel",
  "values": []
}
{
  "key": "list_synonym_in_panel",
  "template": {
    "type": "panel",
    "title": "list_synonym_in_panel",
    "values": [
      {
        "type": "child-list",
        "title": "list_synonym",
        "objectTypeKey": "synonym"
      }
    ]
  }
}

Example of a child list component in a panel taken from the core_business_glossary package.

Nested properties

PropertyDescriptionValuesMandatory
typepanelstringYes
valuesArray of components in the panel.arrayYes
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
parametersParameters linking the component to an API table. The panel then shows the table name and its number of objects. Example configuration: { "type": "panel", ..., "parameters": [ { "name": "tableId", "value": "example_unique_table_id" } ] }arrayNo
settingsSettings configuring the behavior of a panel.jsonNo
titleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section.stringNo
tooltipKeyTranslation key of the tooltip that appears when hovering over the property. Define in translations to specify how the text is displayed in the UI.stringNo