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

IToolboxConfigParsed Module

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

A structure defining the configuration of the Toolbox. For details, see the Customizing the Toolbox topic.

example

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

Interfaces

Name	Description
IBgButton	A structure defining configuration of the Toolbox for customizing the background layer.
IButton	A structure defining configuration of the Toolbox using the buttons array.
IGalleryButton	A structure defining configuration of the Toolbox for launching the Asset Manager in a predefined mode. For more details, refer to The Asset Manager topic.
IItem	A structure defining common properties of buttons in the Toolbox.
ISingleButton	A structure defining configuration of the Toolbox using the action property.

Type aliases

ButtonAction

The standard button actions. The "RichText" button action is deprecated, since every text element may support rich formatting in Customers Canvas 6.

ButtonType

ButtonType: IButton | SingleButtonType

SingleButtonType

SingleButtonType: ISingleButton | IGalleryButton | ButtonAction

Properties

Optional buttons

buttons: ButtonType []

Defines configuration of Toolbox buttons.

Optional containerToolboxes

containerToolboxes: object

Allows for defining different toolboxes for different containers of spot colors and textures.

"Toolbox": {
    "containerToolboxes": {
        "foil": {
            "buttons": [ "Text", "Image" ]
        },
        "texture": {
            "buttons": [ "Image" ]
        },
        "spot": {
            "buttons": [ "Rectangle", "Image" ]
        }
    }
}

containerToolboxes declaration

[key: string ]: IToolboxConfigParsed

Optional disabled

disabled: boolean

Hides the Toolbox. The default value is false.