IToolboxConfigParsed Module

A structure defining the configuration of the Toolbox (former Left toolbar).

example

clientConfig.json

"Toolbox": {
    "buttons": [
        {
            "translationKey": "Toolbox.TEXT",
            "translationKeyTitle": "Toolbox.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": ["Text", "RichText", "BoundedText"]
        },
        "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

ButtonAction: "ToggleObjectInspector" | "Text" | "BoundedText" | "RichText" | "Image" | "Line" | "Rectangle" | "Ellipse" | "QrCode" | "LinearBarcode" | "Background" | "Layout"

ButtonType

ButtonType: IButton | SingleButtonType

SingleButtonType

Properties

Optional buttons

buttons: ButtonType []

Defines configuration of Toolbox buttons.

Optional disabled

disabled: boolean

Hides the Toolbox. The default value is false.