Filter by keyword

ButtonControl

On This Page

    Defines a button which may appear in control extension points such as the property panel

    Example

    1 2 3 4 5 6 7 { "type": "button", "label": { "value": "My Custom Control 0" }, "key": "my-custom-control-0" }

    Properties

    key
    Type
    string
    Max length
    100
    Required
    		Yes
    Pattern
    ^[a-zA-Z0-9-]+$
    Description

    A key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique

    label
    Type
    		i18n Property
    Required
    		Yes
    Description

    Text which will appear inside the button

    Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

    Example

    1
2
3
4
    {
  "value": "My text"
}

    Properties

    value
    Type
    string
    Max length
    1500
    Required
    		Yes
    Description

    The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: b, i, strong, em, and code.

    i18n
    Type
    string
    Max length
    300
    Description

    The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

    type
    Type
    string
    Required
    		Yes
    Allowed values
    • button
    • BUTTON
    Description

    The type field must be set to 'button'

    Rate this page: