CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

CKBoxConfig (ckbox)

@ckeditor/ckeditor5-ckbox/src/ckboxconfig

interface
See source

The configuration of the CKBox feature.

The minimal configuration for the CKBox feature requires providing the config.ckbox.tokenUrl:

ClassicEditor
	.create( editorElement, {
		ckbox: {
			tokenUrl: 'https://example.com/cs-token-endpoint'
		}
	} )
	.then( ... )
	.catch( ... );

Hovewer, you can also adjust the feature to fit your needs:

ClassicEditor
	.create( editorElement, {
		ckbox: {
			defaultUploadCategories: {
				Bitmaps: [ 'bmp' ],
				Pictures: [ 'jpg', 'jpeg' ],
				Scans: [ 'png', 'tiff' ]
			},
			ignoreDataId: true,
			serviceOrigin: 'https://example.com/',
			tokenUrl: 'https://example.com/cs-token-endpoint'
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • allowExternalImagesEditing : ArrayOrItem<RegExp | 'origin' | ( string ) => boolean> | undefined

    See source

    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 []

  • categories : CKBoxCategoriesConfig | undefined

    See source

    Allows setting custom icons for categories.

  • choosableFileExtensions : Array<string> | undefined

    See source

    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']
};

  • defaultUploadCategories : null | Record<string, Array<string>> | undefined

    See source

    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

  • defaultUploadWorkspaceId : string | undefined

    See source

    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.

  • dialog : CKBoxDialogConfig | undefined

    See source

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

  • forceDemoLabel : boolean | undefined

    See source

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

  • ignoreDataId : boolean | undefined

    See source

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

    Defaults to false

  • language : string | undefined

    See source

    Configures the language for the CKBox dialog.

    Defaults to Locale#uiLanguage

  • serviceOrigin : string | undefined

    See source

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

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

  • theme : string | undefined

    See source

    The theme for CKBox dialog.

  • tokenUrl : TokenUrl | undefined

    See source

    The authentication token URL for CKBox feature.

    Defaults to config.cloudServices.tokenUrl

  • upload : CKBoxUploadConfig | undefined

    See source

    Configures when dialog should be minimized and hidden.

  • view : CKBoxViewConfig | undefined

    See source

    Configures the view of CKBox.