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 4.4.25, 4.x (may differ) · Archived documentation

A structure defining the configuration of the Toolbox (former Left toolbar). 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", "RichText"]
                },
                "Image"
            ]
        }
    }
};

Interfaces

Name	Description
IButton	A structure defining configuration of the Toolbox using the buttons array.
IGalleryButton	A structure defining configuration of the Toolbox for launching the Image Gallery in a predefined mode. For more details, refer to the Using the Image Gallery topic.
IItem	A structure defining common properties of buttons in the Toolbox. These are the basic button definitions.
ISingleButton	A structure defining configuration of the Toolbox using the action property.

Type aliases

ButtonAction

The standard button actions.

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.