CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

CKBoxConfig (ckbox)

@ckeditor/ckeditor5-ckbox/src/ckbox

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/',
			assetsOrigin: 'https://example.cloud/',
			tokenUrl: 'https://example.com/cs-token-endpoint'
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • assetsOrigin : String | undefined

    See source

    Configures the base URL for assets inserted into the editor. Required only in on-premises installations.

    Defaults to 'https://ckbox.cloud'

  • defaultUploadCategories : Object | 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

  • 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'

  • tokenUrl : String

    See source

    The authentication token URL for CKBox feature.

    Defaults to config.cloudServices.tokenUrl