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

IItem Interface

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

A structure defining common properties of buttons in the Toolbox. These are the basic button definitions.

example

clientConfig.json The following two examples are equal and result in the same toolbox 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.RICHTEXT",
                    "translationKeyTitle": "Toolbox.TITLE_ADD_RICHTEXT",
                    "iconClass": "cc-icon-rich-text",
                    "action": "RichText"
                }
            ]    
        },
        {
            "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",
                "RichText"
            ]    
        },
        "Image"
    ]
}

Properties

Optional iconClass

iconClass: string

The class of the button icon. You can find the complete list of available icon classes in ~\Resources\SPEditor\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 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.