Context

Stores all the configurations specific to this context instance.

A list of editors that this context instance is injected to.

The plugins loaded and in use by this context instance.

Shorthand for t.

Reference to the editor which created the context. Null when the context was created outside of the editor.

It is used to destroy the context when removing the editor that has created the context.

An array of plugins built into the Context class.

It was used in the now deprecated CKEditor 5 builds featuring Context to provide the default configuration options which are later used during the context initialization.

They will be automatically initialized by Context unless config.plugins is passed.

// Build some context plugins into the Context class first.
Context.builtinPlugins = [ FooPlugin, BarPlugin ];

// Normally, you need to define config.plugins, but since Context.builtinPlugins was
// defined, now you can call create() without any configuration.
Context
	.create()
	.then( context => {
		context.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
		context.plugins.get( BarPlugin ); // -> An instance of the Bar plugin.
	} );

See also Context.defaultConfig and Editor.builtinPlugins.

The default configuration which is built into the Context class.

It was used in the now deprecated CKEditor 5 builds featuring Context to provide the default configuration options which are later used during the context initialization.

Context.defaultConfig = {
	foo: 1,
	bar: 2
};

Context
	.create()
	.then( context => {
		context.config.get( 'foo' ); // -> 1
		context.config.get( 'bar' ); // -> 2
	} );

// The default options can be overridden by the configuration passed to create().
Context
	.create( { bar: 3 } )
	.then( context => {
		context.config.get( 'foo' ); // -> 1
		context.config.get( 'bar' ); // -> 3
	} );

See also Context.builtinPlugins and Editor.defaultConfig.

Creates a context instance with a given configuration.

Usually not to be used directly. See the static create() method.

Parameters

[ config ] : ContextConfig

The context configuration.

Destroys the context instance and all editors used with the context, releasing all resources used by the context.

Returns

Promise<unknown>

A promise that resolves once the context instance is fully destroyed.

Loads and initializes plugins specified in the configuration.

Returns

Promise<LoadedPlugins>

A promise which resolves once the initialization is completed, providing an array of loaded plugins.

Adds a reference to the editor which is used with this context.

When the given editor has created the context, the reference to this editor will be stored as a _contextOwner.

This method should only be used by the editor.

Parameters

editor : Editor

isContextOwner : boolean

Stores the given editor as a context owner.

Returns

void

Returns the context configuration which will be copied to the editors created using this context.

The configuration returned by this method has the plugins configuration removed – plugins are shared with all editors through another mechanism.

This method should only be used by the editor.

Returns

Partial<EditorConfig>

Configuration as a plain object.

Removes a reference to the editor which was used with this context. When the context was created by the given editor, the context will be destroyed.

This method should only be used by the editor.

Parameters

editor : Editor

Returns

Promise<unknown>

A promise that resolves once the editor is removed from the context or when the context was destroyed.

Creates and initializes a new context instance.

const commonConfig = { ... }; // Configuration for all the plugins and editors.
const editorPlugins = [ ... ]; // Regular plugins here.

Context
	.create( {
		// Only context plugins here.
		plugins: [ ... ],

		// Configure the language for all the editors (it cannot be overwritten).
		language: { ... },

		// Configuration for context plugins.
		comments: { ... },
		...

		// Default configuration for editor plugins.
		toolbar: { ... },
		image: { ... },
		...
	} )
	.then( context => {
		const promises = [];

		promises.push( ClassicEditor.create(
			document.getElementById( 'editor1' ),
			{
				editorPlugins,
				context
			}
		) );

		promises.push( ClassicEditor.create(
			document.getElementById( 'editor2' ),
			{
				editorPlugins,
				context,
				toolbar: { ... } // You can overwrite the configuration of the context.
			}
		) );

		return Promise.all( promises );
	} );

Parameters

[ config ] : ContextConfig

The context configuration.

Returns

Promise<Context>

A promise resolved once the context is ready. The promise resolves with the created context instance.