CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

UploadcareConfig (uploadcare)

@ckeditor/ckeditor5-uploadcare/src/uploadcareconfig

interface

The configuration of the Uploadcare feature.

The minimal configuration for the Uploadcare feature requires providing the config.uploadcare.pubkey:

ClassicEditor
 .create( editorElement, {
     uploadcare: {
         pubkey: 'YOUR_PUBLIC_KEY'
     }
 } )
 .then( ... )
 .catch( ... );

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

ClassicEditor
 .create( editorElement, {
     uploadcare: {
     	uploader: {
         	sourceList: [
             	'local',
             	'url',
             	'gdrive'
         	],
         },
         pubkey: 'YOUR_PUBLIC_KEY'
     }
 } )
 .then( ... )
 .catch( ... );

See all editor options.

Filtering

Properties

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

    Allows editing images that are not hosted in Uploadcare service.

    This configuration option should whitelist URL(s) of images that should be editable.

    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 Uploadcare are always editable.

    Defaults to []

  • editor : UploadcareEditorConfig | undefined

    Configuration for the Image Editor component. The component allows editing existing images in the CKEditor.

    You can find detailed information in the Uploadcare documentation.

    Please note that the cdn-url and uuid attributes are automatically handled by the Uploadcare plugin and are not supported in the config options.

  • pubkey : string

    The public key used for communication with the Uploadcare services.

    It will be used by both the File Uploader and Image Editor components.

  • uploader : UploadcareUploaderConfig | undefined

    Configuration that will be passed to the File Uploader component.

    You can find detailed information in the Uploadcare documentation.

    Please note that the source list is limited to the following values:

    • 'local'
    • 'url'
    • 'dropbox'
    • 'gdrive'
    • 'facebook'
    • 'gphotos'
    • 'onedrive'

    Additionally, below options are not supported:

    • imgOnly - It's true by default.
    • removeCopyright - It's true by default.
    • localeName - The editor language is used.
    • confirmUpload - It's false by default.
    • cameraMirror - The camera source is not supported.
    • cameraCapture - The camera source is not supported.
    • showEmptyList - It's false by default.

    All other options documented in the Uploadcare documentation are supported.