Component description

The markdown component creates a Markdown text editor with a preview of the displayed version of the text.

Example

Minimal JSON

{
  "type": "markdown",
  "title": "",
  "attributeTypeKey": ""
}
{
  "type": "markdown",
  "title": "title.markdown.component",
  "attributeTypeKye": "core_description",
  "componentId": "markdown-component"
}

Nested properties

PropertyDescriptionValuesMandatory
typemarkdownstringYes
attributeTypeKeyKey of the attribute that contains the text whose syntax will be highlighted in the selected language.stringYes
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
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