Component description

The button-link component displays a URL as a button. The link must be stored in an attribute type that is linked to the component, if the attribute does not contain any value, the button will not be displayed.

Example

Minimal JSON

{
  "type": "button-link"
}
{
  "type": "button-link",
  "attributeTypeKey": "attributeType_key",
  "title": "title.button.default",
  "settings": {
    "size": "medium",
    "style": "default"
  }
}

Example taken from the core package.

Nested properties

PropertyDescriptionValuesMandatory
typebutton-linkstringYes
attributeTypeKeyKey of the attribute type with the URL link. The attribute can have the following features: is_url: Only links, not email addresses.stringNo
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
settingsSetting configuring the appearance of the button. When not specified, the default style will be used. The following sizes and styles are supported: Size:small: Small button., medium: Medium-sized button., large: Large button.Style:default: Default style with no coloring., info: Dark gray button., warning: Yellow button., error: Red button., success: Green button., gray_with_orange_text: Gray background with orange text."settings": { "size": "", "style": "" }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