View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IGalleryButton Interface

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

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.

example

clientConfig.json

"Toolbox": {
    "buttons": [
        {
            "translationKey": "Toolbox.IMAGE",
            "translationKeyTitle": "Toolbox.TITLE_ADD_IMAGE",
            "iconClass": "cc-icon-add-image",
            "buttons": [
                "Image",
                {
                    "action": "Image",
                    "translationKey": "Toolbox.FACEBOOK",
                    "translationKeyTitle": "Toolbox.FACEBOOK",
                    "iconClass": "cc-icon-add-facebook",
                    "tabs": [ "Facebook" ]
                }
            ]
        }
    ]
}

Properties

action

action: ButtonAction

The action that the button performs. You can define the Toolbox by using the actions alone.

Optional defaultTabName

defaultTabName: string

The default tab to be displayed when the Image Gallery opens. By default, the Image Gallery opens the User tab first.

Optional iconClass

iconClass: string

The class of the button icon. You can find the complete list of available icon classes in ~\Resources\SPEditor\Styles\ControlStyles\sp-icons.less.

Optional itemConfig

itemConfig: ITextConfig | IImageItemDefaultConfig | IBarcodeDefaultConfig

A structure containing the configuration of new design elements. For an example, you can refer to ILocationDefaultConfig or IBarcodeDefaultConfig.

Optional tabs

tabs: string []

An array of available tab names in either the Asset Manager or the Gallery Dialog. By default, all tabs defined in a gallery are displayed.

Optional translationKey

translationKey: string

The translation key of the button caption. The corresponding string should be defined in the ~\Configuration\translations.json file.

Optional translationKeyTitle

translationKeyTitle: string

The translation key of the button tooltip. The corresponding string should be defined in the ~\Configuration\translations.json file.

Optional type

type: AssetSelectWidgetType

The gallery used in the editor, either the Asset Manager or the Gallery Dialog. The default value is "GalleryDialog".