ImageInsertConfig
interface
The configuration of the image insert dropdown panel view. Used by the image insert feature in the @ckeditor/ckeditor5-image
package.
ClassicEditor
.create( editorElement, {
image: {
insert: {
... // settings for "insertImage" view goes here
}
}
} )
.then( ... )
.catch( ... );
See all editor options.
Properties
-
integrations : Array<string> | undefined
module:image/imageconfig~ImageInsertConfig#integrations
The image insert panel view configuration contains a list of
ImageInsert
integrations.The option accepts string tokens.
- for predefined integrations, we have 3 special strings:
upload
,url
, andassetManager
. - for custom integrations, each string should be a name of the integration registered by the
ImageInsertUI#registerIntegration()
.
// Add `upload`, `assetManager` and `url` integrations. const imageInsertConfig = { insert: { integrations: [ 'upload', 'assetManager', 'url' ] } };
Defaults to
[ 'upload', 'assetManager', 'url' ]
- for predefined integrations, we have 3 special strings:
-
type : 'auto' | 'block' | 'inline' | undefined
module:image/imageconfig~ImageInsertConfig#type
This option allows to override the image type used by the
InsertImageCommand
when the user inserts new images into the editor content. By default, all images inserted into the editor will be block ifImageBlock
is loaded. To let the editor decide the image type, choose'auto'
.Available options are:
'block'
– all images inserted into the editor will be block (requires theImageBlock
plugin),'inline'
– all images inserted into the editor will be inline (requires theImageInline
plugin),'auto'
– the editor will choose the optimal image type based on the context of the insertion and availability of plugins.
Defaults to
'block'