ILeftToolbarConfig Module

A structure containing the configuration of the Left toolbar.

example

clientConfig.json

"LeftToolbar": {
    "buttons": [
        {
            "translationKey": "LeftToolbar.TEXT",
            "translationKeyTitle": "LeftToolbar.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": ["Text", "RichText"]
        },
        "Image"
    ]
}

Interfaces

Name Description
IButton

A structure defining configuration of the Left Toolbar using the buttons array.

IGalleryButton

A structure defining configuration of the Left Toolbar 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 the Left Toolbar Buttons. These are the basic button definitions.

ISingleButton

A structure defining configuration of the Left Toolbar using the action property.

Type aliases

ButtonAction

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

ButtonType

ButtonType: IButton | SingleButtonType

SingleButtonType

Properties

Optional buttons

buttons: ButtonType []

Defines configuration of the Left Toolbar buttons. If you define the buttons array, then all properties, which enable and disable buttons, are ignored.

Optional disabled

disabled: boolean

Hides the Left toolbar. The default value is false.

Optional ellipseButtonEnabled

ellipseButtonEnabled: boolean

Displays the Ellipse button in the advanced editing mode.

Optional imageButtonEnabled

imageButtonEnabled: boolean

Displays the Add image button in the advanced editing mode.

Optional lineButtonEnabled

lineButtonEnabled: boolean

Displays the Line button in the advanced editing mode.

Optional linearBarcodeButtonEnabled

linearBarcodeButtonEnabled: boolean

Displays the adding Barcode option in the advanced editing mode.

Optional qrCodeButtonEnabled

qrCodeButtonEnabled: boolean

Displays the adding QR code option in the advanced editing mode.

Optional rectangleButtonEnabled

rectangleButtonEnabled: boolean

Displays the Rectangle button in the advanced editing mode.

Optional richTextButtonEnabled

richTextButtonEnabled: boolean

Displays the adding Rich text option in the advanced editing mode.

Optional textButtonEnabled

textButtonEnabled: boolean

Displays the Add text button in the advanced editing mode.