Component description

The simple-relation component displays objects with one predefined relation type to the object where this component is used. Often used for displaying the “is synonym for” relation.

Warning

This component must be wrapped in a panel without a title.

Example

Minimal JSON

{
  "type": "simple-relation",
  "title": "",
  "relationTypeKeys": [],
  "delimiter": ","
}
{
  "key": "is_synonym_of",
  "template": {
    "type": "panel",
    "title": "is_synonym_of",
    "values": [
      {
        "type": "simple-relation",
        "title": "is_synonym_of",
        "relationTypeKeys": [
          "core#synonymOf"
        ],
        "delimiter": ","
      }
    ]
  }
}

Example taken from the core_business_glossary package.

Nested properties

PropertyDescriptionValuesMandatory
typesimple-relationstringYes
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.stringYes
relationTypeKeysKey(s) of displayed relation type(s).stringYes
delimiterDelimiter separating multiple related objects.stringYes