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.

Properties

allowExternalImagesEditing : ArrayOrItem<RegExp | 'origin' | ( src: string ) => boolean> | undefined
module:uploadcare/uploadcareconfig~UploadcareConfig#allowExternalImagesEditing
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.
locale : UploadcareLocaleDefinition | UploadcareLocaleDefinitionResolver | undefined
module:uploadcare/uploadcareconfig~UploadcareConfig#locale
Locale configuration for Uploadcare components.
The plugin automatically uses the editor's language (editor.locale.contentLanguage) as the locale name. If the editor language is different from 'en', you need to provide translations for that language. This property is used only to supply translations that will be used by Uploadcare components.
For information on how to configure the editor's language, see the CKEditor 5 localization documentation.
Example with UploadcareLocaleDefinition:
```
uploadcare: {
    pubkey: 'YOUR_PUBLIC_KEY',
    locale: {
        'locale-id': 'de',
        'social-source-lang': 'de',
        'upload-file': 'Datei hochladen',
        'file__one': 'Datei',
        'file__other': 'Dateien',
        'header-uploading': 'Lade {{count}} {{plural:file(count)}} hoch'
    }
}
```
Copy code
Example with UploadcareLocaleDefinitionResolver (for CDN loading):
```
uploadcare: {
    pubkey: 'YOUR_PUBLIC_KEY',
    locale: () => import('https://cdn.jsdelivr.net/npm/@uploadcare/file-uploader@v1/locales/file-uploader/de.js')
        .then( module => module.default )
}
```
Copy code
For detailed information about locale definition format, available languages, and CDN translations, see the Uploadcare localization documentation.
When translations are provided, they will be automatically applied to the Uploadcare components using UC.defineLocale() with the editor's language as the locale name.
Defaults to undefined
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
module:uploadcare/uploadcareconfig~UploadcareConfig#uploader
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 - Custom translations can be provided via the locale config option.
- 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.

UploadcareConfig

Properties

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

`editor : UploadcareEditorConfig | undefined`

`locale : UploadcareLocaleDefinition | UploadcareLocaleDefinitionResolver | undefined`

`pubkey : string`

`uploader : UploadcareUploaderConfig | undefined`