Meet us at PRINT 19. Chicago, IL. Oct. 3 - 5.

IToolboxConfigParsed Module

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", "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

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

The standard button actions.

ButtonType

ButtonType: IButton | SingleButtonType

SingleButtonType

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

Optional disabled

disabled: boolean

Hides the Toolbox. The default value is false.