CKBoxConfig

Allows editing images that are not hosted in CKBox service.

This configuration option should whitelist URL(s) of images that should be editable. Make sure that allowed image resources have CORS enabled.

The image is editable if this option is:

• a regular expression and it matches the image URL, or
• a custom function that returns true for the image URL, or
• 'origin' literal and the image URL is from the same origin, or
• an array of the above and the image URL matches one of the array elements.

Images hosted in CKBox are always editable.

Defaults to []

Allows setting custom icons for categories.

Specifies the file extensions considered valid for user interaction. Whith this option developers can restrict user interaction to only those assets whose file extensions match those listed in the array. Assets whose file extensions are not listed in the choosableFileExtensions array are automatically disabled within the CKBox interface.

const ckboxConfig = {
		choosableFileExtensions: ['jpg', 'png']
};

Defines the categories to which the uploaded images will be assigned. If configured, it overrides the category mappings defined on the cloud service. The value of this option should be an object, where the keys define categories and their values are the types of images that will be uploaded to these categories. The categories might be referenced by their name or ID.

Example:

const ckboxConfig = {
	defaultUploadCategories: {
		Bitmaps: [ 'bmp' ],
		Pictures: [ 'jpg', 'jpeg' ],
		Scans: [ 'png', 'tiff' ],
		// The category below is referenced by its ID.
		'fdf2a647-b67f-4a6c-b692-5ba1dc1ed87b': [ 'gif' ]
	}
};

Defaults to null

Defines the workspace id to use during upload when the user has access to more than one workspace.

If defined, it is an error, when the user has no access to the specified workspace.

This option allows opening CKBox in dialog mode. It takes a configuration object with the width and height attributes.

Controls when to enable the download attribute for inserted links.

By default, files are downloadable.

const ckboxConfig = {
  downloadableFiles: asset => asset.data.extension !== 'pdf'
};

Enforces displaying the "Powered by CKBox" link regardless of the CKBox plan used.

Inserts the unique asset ID as the data-ckbox-resource-id attribute. To disable this behavior, set it to true.

Defaults to false

Configures the language for the CKBox dialog.

Defaults to Locale#uiLanguage

Configures the base URL of the API service. Required only in on-premises installations.

Defaults to 'https://api.ckbox.io'

The theme for CKBox dialog.

The authentication token URL for CKBox feature.

Defaults to config.cloudServices.tokenUrl

Configures when dialog should be minimized and hidden.

Configures the view of CKBox.