Interface IAssetSources.IDepositPhotosLightboxConfig

A structure defining properties of the Depositphotos lightbox source.

Inheritance

IAssetSourceConfig<"DepositPhotosLightbox">

IAssetSources.IDepositPhotosLightboxConfig

Package: @aurigma/design-editor-iframe

Examples

{
"assetSources": {
    "[source]Deposit Photos Lightbox": {
      "type": "DepositPhotosLightbox",
      "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "size": "XL",
      "insertItemConfirmationEnabled": false,
      "lightboxId": "xxxxx"
    }
  },

  "widgets": {
    "Toolbox": {
      "buttons": [
        {
          "type": "AssetManager",
          "action": "Image",
          "translationKey": "Toolbox.IMAGE",
          "iconClass": "cc-icon-add-image"
        }
      ]
    },

    "AssetManager": {
      "tabs": [
        {
          "name": "Deposit Photos Lightbox",
          "assetSourceInstance": "[source]Deposit Photos Lightbox",
          "iconClassName": "cc-icon-deposit-photos-lightbox"
        }
      ]
    }
  }
}

Properties

apiKey

The key required to use the Depositphotos API. To get this key, contact Depositphotos.

Declaration

apiKey: string;

Property Value

Type	Description
string	The key required to use the Depositphotos API. To get this key, contact Depositphotos.

insertItemConfirmationEnabled

Displays a dialog box informing your users that they will need to pay for images at checkout. The default value is true.

Declaration

insertItemConfirmationEnabled?: boolean;

Property Value

Type	Description
boolean	Displays a dialog box informing your users that they will need to pay for images at checkout. The default value is true.

lightboxId

The lightbox identifier.

Declaration

lightboxId: string;

Property Value

Type	Description
string	The lightbox identifier.

size

The size of images returned by the Depositphotos API.

Declaration

size: ImageSize.ImageSizeType;

Property Value

Type	Description
ImageSizeType	The size of images returned by the Depositphotos API.