ProtectedconstructorCreates an instance of the decoupled editor.
Note: Do not use the constructor to create editor instances. Use the static
module:editor-decoupled/decouplededitor~DecoupledEditor.create DecoupledEditor.create() method instead.
The DOM element that will be the source for the created editor
(on which the editor will be initialized) or initial data for the editor. For more information see
module:editor-balloon/ballooneditor~BalloonEditor.create BalloonEditor.create().
Optionalconfig: EditorConfigThe editor configuration.
Protected Readonly_The editor context. When it is not provided through the configuration, the editor creates it.
Protected Readonly_A set of lock IDs for the #isReadOnly getter.
ReadonlyaccessibilityA namespace for the accessibility features of the editor.
ReadonlycommandsCommands registered to the editor.
Use the shorthand #execute editor.execute() method to execute commands:
// Execute the bold command:
editor.execute( 'bold' );
// Check the state of the bold command:
editor.commands.get( 'bold' ).value;
ReadonlyconfigStores all configurations specific to this editor instance.
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
ReadonlyconversionConversion manager through which you can register model-to-view and view-to-model converters.
See the module:engine/conversion/conversion~Conversion documentation to learn how to add converters.
ReadonlydataThe module:engine/controller/datacontroller~DataController data controller. Used e.g. for setting and retrieving the editor data.
ReadonlyeditingThe module:engine/controller/editingcontroller~EditingController editing controller. Controls user input and rendering the content for editing.
ReadonlyidReadonlykeystrokesAn instance of the module:core/editingkeystrokehandler~EditingKeystrokeHandler.
It allows setting simple keystrokes:
// Execute the bold command on Ctrl+E:
editor.keystrokes.set( 'Ctrl+E', 'bold' );
// Execute your own callback:
editor.keystrokes.set( 'Ctrl+E', ( data, cancel ) => {
console.log( data.keyCode );
// Prevent the default (native) action and stop the underlying keydown event
// so no other editor feature will interfere.
cancel();
} );
Note: Certain typing-oriented keystrokes (like Backspace or Enter) are handled
by a low-level mechanism and trying to listen to them via the keystroke handler will not work reliably.
To handle these specific keystrokes, see the events fired by the
module:engine/view/document~ViewDocument editing view document (editor.editing.view.document).
ReadonlylocaleThe locale instance.
ReadonlymodelThe editor's model.
The central point of the editor's abstract data model.
ReadonlypluginsThe plugins loaded and in use by this editor instance.
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
ReadonlysourceThe element on which the editor has been initialized.
Indicates the editor life-cycle state.
The editor is in one of the following states:
initializing – During the editor initialization (before
module:core/editor/editor~Editor.create Editor.create()) finished its job.ready – After the promise returned by the module:core/editor/editor~Editor.create Editor.create()
method is resolved.destroyed – Once the #destroy editor.destroy() method was called.ReadonlytShorthand for module:utils/locale~Locale#t.
ReadonlyuiStaticContextThe module:core/context~Context class.
Exposed as static editor field for easier access in editor builds.
StaticContextThe module:watchdog/contextwatchdog~ContextWatchdog class.
Exposed as static editor field for easier access in editor builds.
Static OptionaldefaultThe default configuration which is built into the editor class.
It was used in the now deprecated CKEditor 5 builds to provide the default configuration options which are later used during the editor initialization.
ClassicEditor.defaultConfig = {
foo: 1,
bar: 2
};
ClassicEditor
.create( sourceElement )
.then( editor => {
editor.config.get( 'foo' ); // -> 1
editor.config.get( 'bar' ); // -> 2
} );
// The default options can be overridden by the configuration passed to create().
ClassicEditor
.create( sourceElement, { bar: 3 } )
.then( editor => {
editor.config.get( 'foo' ); // -> 1
editor.config.get( 'bar' ); // -> 3
} );
See also module:core/editor/editor~Editor.builtinPlugins.
StaticEditorThe module:watchdog/editorwatchdog~EditorWatchdog class.
Exposed as static editor field for easier access in editor builds.
Defines whether the editor is in the read-only mode.
In read-only mode the editor #commands commands are disabled so it is not possible to modify the document by using them. Also, the editable element(s) become non-editable.
In order to make the editor read-only, you need to call the #enableReadOnlyMode method:
editor.enableReadOnlyMode( 'feature-id' );
Later, to turn off the read-only mode, call #disableReadOnlyMode:
editor.disableReadOnlyMode( 'feature-id' );
StaticbuiltinAn array of plugins built into this editor class.
It is used in the now deprecated CKEditor 5 builds to provide a list of plugins which are later automatically initialized during the editor initialization.
They will be automatically initialized by the editor, unless listed in config.removePlugins and
unless config.plugins is passed.
// Build some plugins into the editor class first.
ClassicEditor.builtinPlugins = [ FooPlugin, BarPlugin ];
// Normally, you need to define config.plugins, but since ClassicEditor.builtinPlugins was
// defined, now you can call create() without any configuration.
ClassicEditor
.create( sourceElement )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
editor.plugins.get( BarPlugin ); // -> An instance of the Bar plugin.
} );
ClassicEditor
.create( sourceElement, {
// Do not initialize these plugins (note: it is defined by a string):
removePlugins: [ 'Foo' ]
} )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> Undefined.
editor.config.get( BarPlugin ); // -> An instance of the Bar plugin.
} );
ClassicEditor
.create( sourceElement, {
// Load only this plugin. It can also be defined by a string if
// this plugin was built into the editor class.
plugins: [ FooPlugin ]
} )
.then( editor => {
editor.plugins.get( FooPlugin ); // -> An instance of the Foo plugin.
editor.config.get( BarPlugin ); // -> Undefined.
} );
See also module:core/editor/editor~Editor.defaultConfig.
StaticeditorProtected_Optionalname: stringBinds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Observable property that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings dedicated} guide covering the topic of property bindings with some additional examples.
Consider two objects: a button and an associated command (both Observable).
A simple property binding could be as follows:
button.bind( 'isEnabled' ).to( command, 'isEnabled' );
or even shorter:
button.bind( 'isEnabled' ).to( command );
which works in the following way:
button.isEnabled instantly equals command.isEnabled,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#unbind.
You can also "rename" the property in the binding by specifying the new name in the to() chain:
button.bind( 'isEnabled' ).to( command, 'isWorking' );
It is possible to bind more than one property at a time to shorten the code:
button.bind( 'isEnabled', 'value' ).to( command );
which corresponds to:
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
The binding can include more than one observable, combining multiple data sources in a custom callback:
button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );
Using a custom callback allows processing the value before passing it to the target property:
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
It is also possible to bind to the same property in an array of observables.
To bind a button to multiple commands (also Observables) so that each and every one of them
must be enabled for the button to become enabled, use the following code:
button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );
Observable properties that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.
Read more in the {@glink framework/deep-dive/observables#decorating-object-methods dedicated} guide covering the topic of decorating methods with some additional examples.
Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.
For example, to cancel the method execution the event can be module:utils/eventinfo~EventInfo#stop stopped:
class Foo extends ObservableMixin() {
constructor() {
super();
this.decorate( 'method' );
}
method() {
console.log( 'called!' );
}
}
const foo = new Foo();
foo.on( 'method', ( evt ) => {
evt.stop();
}, { priority: 'high' } );
foo.method(); // Nothing is logged.
Note: The high module:utils/priorities~PriorityString priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).
It is also possible to change the returned value:
foo.on( 'method', ( evt ) => {
evt.return = 'Foo!';
} );
foo.method(); // -> 'Foo'
Finally, it is possible to access and modify the arguments the method is called with:
method( a, b ) {
console.log( `${ a }, ${ b }` );
}
// ...
foo.on( 'method', ( evt, args ) => {
args[ 0 ] = 3;
console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );
foo.method( 1, 2 ); // -> '3, 2'
Name of the method to decorate.
Delegates selected events to another module:utils/emittermixin~Emitter. For instance:
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
then eventX is delegated (fired by) emitterB and emitterC along with data:
emitterA.fire( 'eventX', data );
and eventY is delegated (fired by) emitterC along with data:
emitterA.fire( 'eventY', data );
Event names that will be delegated to another emitter.
Destroys the editor instance, releasing all resources used by it.
Updates the original editor element with the data if the
module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy
configuration option is set to true.
Note: The decoupled editor does not remove the toolbar and editable when destroyed. You can do that yourself in the destruction chain:
editor.destroy()
.then( () => {
// Remove the toolbar from DOM.
editor.ui.view.toolbar.element.remove();
// Remove the editable from DOM.
editor.ui.view.editable.element.remove();
console.log( 'Editor was destroyed' );
} );
Removes the read-only lock from the editor with given lock ID.
When no lock is present on the editor anymore, then the #isReadOnly isReadOnly property will be set to false.
The lock ID for setting the editor to the read-only state.
Turns on the read-only mode in the editor.
Editor can be switched to or out of the read-only mode by many features, under various circumstances. The editor supports locking mechanism for the read-only mode. It enables easy control over the read-only mode when many features wants to turn it on or off at the same time, without conflicting with each other. It guarantees that you will not make the editor editable accidentally (which could lead to errors).
Each read-only mode request is identified by a unique id (also called "lock"). If multiple plugins requested to turn on the read-only mode, then, the editor will become editable only after all these plugins turn the read-only mode off (using the same ids).
Note, that you cannot force the editor to disable the read-only mode if other plugins set it.
After the first enableReadOnlyMode() call, the #isReadOnly isReadOnly property will be set to true:
editor.isReadOnly; // `false`.
editor.enableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
You can turn off the read-only mode ("clear the lock") using the #disableReadOnlyMode disableReadOnlyMode() method:
editor.enableReadOnlyMode( 'my-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `false`.
All "locks" need to be removed to enable editing:
editor.enableReadOnlyMode( 'my-feature-id' );
editor.enableReadOnlyMode( 'my-other-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
editor.disableReadOnlyMode( 'my-other-feature-id' );
editor.isReadOnly; // `false`.
A unique ID for setting the editor to the read-only state.
Executes the specified command with given parameters.
Shorthand for:
editor.commands.get( commandName ).execute( ... );
The name of the command to execute.
Command parameters.
The value returned by the module:core/commandcollection~CommandCollection#execute commands.execute().
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an module:utils/eventinfo~EventInfo object,
followed by the optional args provided in the fire() method call.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The name of the event or EventInfo object if event is delegated.
Additional arguments to be passed to the callbacks.
By default the method returns undefined. However, the return value can be changed by listeners
through modification of the module:utils/eventinfo~EventInfo#return evt.return's property (the event info
is the first param of every callback).
Focuses the editor.
Note To explicitly focus the editing area of the editor, use the
module:engine/view/view~EditingView#focus editor.editing.view.focus() method of the editing view.
Check out the {@glink framework/deep-dive/ui/focus-tracking#focus-in-the-editor-ui Focus in the editor UI} section of the {@glink framework/deep-dive/ui/focus-tracking Deep dive into focus tracking} guide to learn more.
Gets the data from the editor.
editor.getData(); // -> '<p>This is editor!</p>'
If your editor implementation uses multiple roots, you should pass root name as one of the options:
editor.getData( { rootName: 'header' } ); // -> '<p>Content for header part.</p>'
By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the {@glink features/markdown Markdown output} guide for more details.
A warning is logged when you try to retrieve data for a detached root, as most probably this is a mistake. A detached root should be treated like it is removed, and you should not save its data. Note, that the detached root data is always an empty string.
Optionaloptions: { rootName?: string; trim?: "empty" | "none"; [key: string]: unknown }Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.
OptionalrootName?: stringRoot name. Defaults to 'main'.
Optionaltrim?: "empty" | "none"Whether returned data should be trimmed. This option is set to 'empty' by default,
which means that whenever editor content is considered empty, an empty string is returned. To turn off trimming
use 'none'. In such cases exact content will be returned (for example '<p> </p>' for an empty editor).
Output data.
Loads and initializes plugins specified in the configuration.
A promise which resolves once the initialization is completed, providing an array of loaded plugins.
Registers a callback function to be executed when an event is fired in a specific (emitter) object.
Events can be grouped in namespaces using :.
When namespaced event is fired, it additionally fires all callbacks for that namespace.
// myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );
// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );
An event callback can module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Stops executing the callback on the given event.
Shorthand for #stopListening this.stopListening( this, event, callback ).
The name of the event.
The function to stop being called.
Registers a callback function to be executed when an event is fired.
Shorthand for #listenTo this.listenTo( this, event, callback, options ) (it makes the emitter
listen on itself).
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Registers a callback function to be executed on the next time the event is fired only. This is similar to calling #on followed by #off in the callback.
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.
This method throws the observable-set-cannot-override error if the observable instance already
has a property with the given property name. This prevents from mistakenly overriding existing
properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.
In TypeScript, those properties should be declared in class using declare keyword. In example:
public declare myProp: number;
constructor() {
this.set( 'myProp', 2 );
}
The property's name.
The property's value.
Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.
It accepts a single object literal containing key/value pairs with properties to be set.
This method throws the observable-set-cannot-override error if the observable instance already
has a property with the given property name. This prevents from mistakenly overriding existing
properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.
In TypeScript, those properties should be declared in class using declare keyword. In example:
public declare myProp1: number;
public declare myProp2: string;
constructor() {
this.set( {
'myProp1: 2,
'myProp2: 'foo'
} );
}
An object with name=>value pairs.
Optional Readonlyaccessibility?: unknownA namespace for the accessibility features of the editor.
Optionalbind?: unknownOptional Readonlycommands?: unknownCommands registered to the editor.
Use the shorthand #execute editor.execute() method to execute commands:
// Execute the bold command:
editor.execute( 'bold' );
// Check the state of the bold command:
editor.commands.get( 'bold' ).value;
Optional Readonlyconfig?: unknownStores all configurations specific to this editor instance.
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
Optional Readonlyconversion?: unknownConversion manager through which you can register model-to-view and view-to-model converters.
See the module:engine/conversion/conversion~Conversion documentation to learn how to add converters.
Optional Readonlydata?: unknownThe module:engine/controller/datacontroller~DataController data controller. Used e.g. for setting and retrieving the editor data.
Optionaldecorate?: unknownOptionaldelegate?: unknownOptionaldestroy?: unknownOptionaldisableReadOnlyMode?: unknownOptional Readonlyediting?: unknownThe module:engine/controller/editingcontroller~EditingController editing controller. Controls user input and rendering the content for editing.
OptionalenableReadOnlyMode?: unknownOptionalexecute?: unknownOptionalfire?: unknownOptionalfocus?: unknownOptionalgetData?: unknownOptionalgetSelectedHtml?: unknownOptional Readonlyid?: unknownOptionalinitPlugins?: unknownOptionalisReadOnly?: unknownOptional Readonlykeystrokes?: unknownAn instance of the module:core/editingkeystrokehandler~EditingKeystrokeHandler.
It allows setting simple keystrokes:
// Execute the bold command on Ctrl+E:
editor.keystrokes.set( 'Ctrl+E', 'bold' );
// Execute your own callback:
editor.keystrokes.set( 'Ctrl+E', ( data, cancel ) => {
console.log( data.keyCode );
// Prevent the default (native) action and stop the underlying keydown event
// so no other editor feature will interfere.
cancel();
} );
Note: Certain typing-oriented keystrokes (like Backspace or Enter) are handled
by a low-level mechanism and trying to listen to them via the keystroke handler will not work reliably.
To handle these specific keystrokes, see the events fired by the
module:engine/view/document~ViewDocument editing view document (editor.editing.view.document).
OptionallistenTo?: unknownOptional Readonlylocale?: unknownThe locale instance.
Optional Readonlymodel?: unknownThe editor's model.
The central point of the editor's abstract data model.
Optionaloff?: unknownOptionalon?: unknownOptionalonce?: unknownOptional Readonlyplugins?: unknownThe plugins loaded and in use by this editor instance.
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
OptionalremoveSelection?: unknownOptionalset?: unknownOptionalsetData?: unknownOptional ReadonlysourceElement?: unknownThe element on which the editor has been initialized.
Optional Readonlystate?: unknownIndicates the editor life-cycle state.
The editor is in one of the following states:
initializing – During the editor initialization (before
module:core/editor/editor~Editor.create Editor.create()) finished its job.ready – After the promise returned by the module:core/editor/editor~Editor.create Editor.create()
method is resolved.destroyed – Once the #destroy editor.destroy() method was called.OptionalstopDelegating?: unknownOptionalstopListening?: unknownOptional Readonlyt?: unknownShorthand for module:utils/locale~Locale#t.
Optional Readonlyui?: unknownOptionalunbind?: unknownOptionalupdateSourceElement?: unknownSets the data in the editor.
editor.setData( '<p>This is editor!</p>' );
If your editor implementation uses multiple roots, you should pass an object with keys corresponding to the editor root names and values equal to the data that should be set in each root:
editor.setData( {
header: '<p>Content for header part.</p>',
content: '<p>Content for main part.</p>',
footer: '<p>Content for footer part.</p>'
} );
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the {@glink features/markdown Markdown output} guide for more details.
Input data.
Stops delegating events. It can be used at different levels:
Optionalevent: stringThe name of the event to stop delegating. If omitted, stops it all delegations.
Optionalemitter: Emitter(requires event) The object to stop delegating a particular event to.
If omitted, stops delegation of event to all emitters.
Stops listening for events. It can be used at different levels:
Optionalemitter: EmitterThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Removes the binding created with #bind.
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Updates the #sourceElement editor source element's content with the data if the
module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy
configuration option is set to true.
Optionaldata: stringData that the #sourceElement editor source element should be updated with.
StaticcreateCreates a new decoupled editor instance.
Note: remember that DecoupledEditor does not append the toolbar element to your web page, so you have to do it manually
after the editor has been initialized.
There are two ways how the editor can be initialized.
You can initialize the editor using an existing DOM element:
DecoupledEditor
.create( document.querySelector( '#editor' ) )
.then( editor => {
console.log( 'Editor was initialized', editor );
// Append the toolbar to the <body> element.
document.body.appendChild( editor.ui.view.toolbar.element );
} )
.catch( err => {
console.error( err.stack );
} );
The element's content will be used as the editor data and the element will become the editable element.
Alternatively, you can initialize the editor by passing the initial data directly as a string. In this case, you will have to manually append both the toolbar element and the editable element to your web page.
DecoupledEditor
.create( '<p>Hello world!</p>' )
.then( editor => {
console.log( 'Editor was initialized', editor );
// Append the toolbar to the <body> element.
document.body.appendChild( editor.ui.view.toolbar.element );
// Initial data was provided so the editor UI element needs to be added manually to the DOM.
document.body.appendChild( editor.ui.getEditableElement() );
} )
.catch( err => {
console.error( err.stack );
} );
This lets you dynamically append the editor to your web page whenever it is convenient for you. You may use this method if your web page content is generated on the client side and the DOM structure is not ready at the moment when you initialize the editor.
config.initialData)You can also mix these two ways by providing a DOM element to be used and passing the initial data through the configuration:
DecoupledEditor
.create( document.querySelector( '#editor' ), {
initialData: '<h2>Initial data</h2><p>Foo bar.</p>'
} )
.then( editor => {
console.log( 'Editor was initialized', editor );
// Append the toolbar to the <body> element.
document.body.appendChild( editor.ui.view.toolbar.element );
} )
.catch( err => {
console.error( err.stack );
} );
This method can be used to initialize the editor on an existing element with the specified content in case if your integration makes it difficult to set the content of the source element.
Note that an error will be thrown if you pass the initial data both as the first parameter and also in the configuration.
See the module:core/editor/editorconfig~EditorConfig editor configuration documentation to learn more about customizing plugins, toolbar and more.
The DOM element that will be the source for the created editor or the editor's initial data.
If a DOM element is passed, its content will be automatically loaded to the editor upon initialization.
The editor data will be set back to the original element once the editor is destroyed only if the
module:core/editor/editorconfig~EditorConfig#updateSourceElementOnDestroy updateSourceElementOnDestroy
option is set to true.
If the initial data is passed, a detached editor will be created. In this case you need to insert it into the DOM manually.
It is available via
module:editor-decoupled/decouplededitorui~DecoupledEditorUI#getEditableElement editor.ui.getEditableElement().
Optionalconfig: EditorConfigThe editor configuration.
A promise resolved once the editor is ready. The promise resolves with the created editor instance.
A text editor configured as a DecoupledEditor (fixed toolbar mode), as well as its preconfigured plugins.