You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

ISingleButton Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure defining configuration of the Toolbox using the action property.

example

The following two examples are equal and result in the same toolbar configuration.

"Toolbox": {
    "buttons": [
        {
            "translationKey": "Toolbox.TEXT",
            "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": [
                {
                    "translationKey": "Toolbox.ADD_TEXT",
                    "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
                    "iconClass": "cc-icon-add-text",
                    "action": "Text"
                },
                {
                    "translationKey": "Toolbox.BOUNDEDTEXT",
                    "translationKeyTitle": "Toolbox.TITLE_ADD_BOUNDEDTEXT",
                    "iconClass": "cc-icon-rich-text",
                    "action": "BoundedText"
                }
            ]    
        },
        {
            "translationKey": "Toolbox.IMAGE",
            "translationKeyTitle": "Toolbox.TITLE_ADD_IMAGE",
            "iconClass": "cc-icon-add-image",
            "action": "Image"
        }
    ]
}

"Toolbox": {
    "buttons": [
        {
            "translationKey": "Toolbox.TEXT",
            "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": [
                "Text",
                "BoundedText"
            ]    
        },
        "Image"
    ]
}

Properties

action

action: ButtonAction

The action that the button performs. You can define the Toolbox by using the actions alone.

Optional iconClass

iconClass: string

The class of the button icon. You can find the complete list of available icon classes in \src\design-editor\Styles\ControlStyles\sp-icons.less.

Optional itemConfig

itemConfig: ITextConfig | IImageItemDefaultConfig | IBarcodeDefaultConfig

A structure containing the configuration of new design elements. For an example, you can refer to ILocationDefaultConfig or IBarcodeDefaultConfig.

Optional nameDialogEnabled

nameDialogEnabled: boolean

Enables a dialog box to type in the name of a new design element. The default value is false.

Optional translationKey

translationKey: string

The translation key of the button caption. The corresponding string should be defined in the ~\Configuration\translations.json file.

Optional translationKeyTitle

translationKeyTitle: string

The translation key of the button tooltip. The corresponding string should be defined in the ~\Configuration\translations.json file.