ISingleButton Interface

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

example

clientConfig.json The following two examples are equal and result in the same toolbar configuration.

"LeftToolbar": {
    "buttons": [
        {
            "translationKey": "LeftToolbar.TEXT",
            "translationKeyTitle": "LeftToolbar.TITLE_ADD_TEXT",
            "iconClass": "cc-icon-add-text",
            "buttons": [
                {
                    "translationKey": "LeftToolbar.ADD_TEXT",
                    "translationKeyTitle": "LeftToolbar.TITLE_ADD_TEXT",
                    "iconClass": "cc-icon-add-text",
                    "action": "Text"
                },
                {
                    "translationKey": "LeftToolbar.RICHTEXT",
                    "translationKeyTitle": "LeftToolbar.TITLE_ADD_RICHTEXT",
                    "iconClass": "cc-icon-rich-text",
                    "action": "RichText"
                }
            ]    
        },
        {
            "translationKey": "LeftToolbar.IMAGE",
            "translationKeyTitle": "LeftToolbar.TITLE_ADD_IMAGE",
            "iconClass": "cc-icon-add-image",
            "action": "Image"
        }
    ]
}

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

Properties

action

action: ButtonAction

The action that the button performs. You can define the Left Toolbar using only this property.

iconClass

iconClass: string

The class of the button icon.

translationKey

translationKey: string

The translation key of the button caption.

translationKeyTitle

translationKeyTitle: string

The translation key of the button tooltip.