BalloonEditor

class

The balloon editor implementation (Medium-like editor). It uses an inline editable and a toolbar based on the BalloonToolbar. See the demo.

In order to create a balloon editor instance, use the static BalloonEditor.create() method.

See source

Properties

accessibility : Accessibility
readonlyinherited

A namespace for the accessibility features of the editor.
See source (with github icon)
commands : CommandCollection
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#commands
Commands registered to the editor.
Use the shorthand 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;
```
Copy code
See source (with github icon)
config : Config<EditorConfig>
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#config
Stores all configurations specific to this editor instance.
```
editor.config.get( 'image.toolbar' );
// -> [ 'imageStyle:block', 'imageStyle:side', '|', 'toggleImageCaption', 'imageTextAlternative' ]
```
Copy code
See source (with github icon)
conversion : Conversion
readonlyinherited

Conversion manager through which you can register model-to-view and view-to-model converters.
See the Conversion documentation to learn how to add converters.
See source (with github icon)
data : DataController
readonlyinherited

The data controller. Used e.g. for setting and retrieving the editor data.
See source (with github icon)
editing : EditingController
readonlyinherited

The editing controller. Controls user input and rendering the content for editing.
See source (with github icon)
id : string
readonlyinherited

See source (with github icon)
isReadOnly : boolean
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#isReadOnly
Defines whether the editor is in the read-only mode.
In read-only mode the editor 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' );
```
Copy code
- Later, to turn off the read-only mode, call disableReadOnlyMode:
```
editor.disableReadOnlyMode( 'feature-id' );
```
Copy code
See source (with github icon)
keystrokes : EditingKeystrokeHandler
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#keystrokes
An instance of the 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();
} );
```
Copy code
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 editing view document (editor.editing.view.document).
See source (with github icon)
locale : Locale
readonlyinherited

The locale instance.
See source (with github icon)
model : Model
readonlyinherited

The editor's model.
The central point of the editor's abstract data model.
See source (with github icon)
plugins : PluginCollection<Editor>
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#plugins
The plugins loaded and in use by this editor instance.
```
editor.plugins.get( 'ClipboardPipeline' ); // -> An instance of the clipboard pipeline plugin.
```
Copy code
See source (with github icon)
sourceElement : undefined | HTMLElement
readonlyinherited

The element on which the editor has been initialized.
See source (with github icon)
state : 'ready' | 'initializing' | 'destroyed'
inheritedobservable
module:editor-balloon/ballooneditor~BalloonEditor#state
Indicates the editor life-cycle state.
The editor is in one of the following states:
- initializing – During the editor initialization (before Editor.create()) finished its job.
- ready – After the promise returned by the Editor.create() method is resolved.
- destroyed – Once the editor.destroy() method was called.
See source (with github icon)
t : LocaleTranslate
readonlyinherited
module:editor-balloon/ballooneditor~BalloonEditor#t
Shorthand for t.
See source (with github icon)
Related:
- Locale#t
ui : BalloonEditorUI
readonly

See source (with github icon)
_context : Context
protectedreadonlyinherited

The editor context. When it is not provided through the configuration, the editor creates it.
See source (with github icon)
_readOnlyLocks : Set<string | symbol>
protectedreadonlyinherited

A set of lock IDs for the isReadOnly getter.
See source (with github icon)

Static properties

Context : Context
inheritedstatic

The Context class.
Exposed as static editor field for easier access in editor builds.
See source (with github icon)
ContextWatchdog : ContextWatchdog
inheritedstatic

The ContextWatchdog class.
Exposed as static editor field for easier access in editor builds.
See source (with github icon)
EditorWatchdog : EditorWatchdog
inheritedstatic

The EditorWatchdog class.
Exposed as static editor field for easier access in editor builds.
See source (with github icon)

`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`
inheritedstatic

module:editor-balloon/ballooneditor~BalloonEditor.builtinPlugins

An 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.
	} );

`defaultConfig : EditorConfig | undefined`
inheritedstatic

module:editor-balloon/ballooneditor~BalloonEditor.defaultConfig

The 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
	} );

Methods

constructor( sourceElementOrData, config )
protected

Creates an instance of the balloon editor.
Note: do not use the constructor to create editor instances. Use the static BalloonEditor.create() method instead.
See source (with github icon)
Parameters
sourceElementOrData : string | HTMLElement
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 BalloonEditor.create().
config : EditorConfig
The editor configuration.

Defaults to {}
bind( bindProperties ) → ObservableMultiBindChain
inherited
module:editor-balloon/ballooneditor~BalloonEditor#bind:MANY_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the 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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use 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' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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 );
```
Copy code
See source (with github icon)
Parameters
bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'isReadOnly' | 'ui' | 'editing' | 'model' | 'execute' | 'plugins' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins' | 'sourceElement' | 'updateSourceElement'>
Observable properties that will be bound to other observable(s).
Returns
ObservableMultiBindChain
The bind chain with the to() and toMany() methods.
bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, BalloonEditor[ K1 ], K2, BalloonEditor[ K2 ]>
inherited
module:editor-balloon/ballooneditor~BalloonEditor#bind:DUAL_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the 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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use 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' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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 );
```
Copy code
See source (with github icon)
Type parameters
K1
K2
Parameters
bindProperty1 : K1
Observable property that will be bound to other observable(s).
bindProperty2 : K2
Observable property that will be bound to other observable(s).
Returns
ObservableDualBindChain<K1, BalloonEditor[ K1 ], K2, BalloonEditor[ K2 ]>
The bind chain with the to() and toMany() methods.
bind( bindProperty ) → ObservableSingleBindChain<K, BalloonEditor[ K ]>
inherited
module:editor-balloon/ballooneditor~BalloonEditor#bind:SINGLE_BIND
Binds observable properties to other objects implementing the Observable interface.
Read more in the 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' );
```
Copy code
or even shorter:
```
button.bind( 'isEnabled' ).to( command );
```
Copy code
which works in the following way:
- button.isEnabled instantly equals command.isEnabled,
- whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.
Note: To release the binding, use 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' );
```
Copy code
It is possible to bind more than one property at a time to shorten the code:
```
button.bind( 'isEnabled', 'value' ).to( command );
```
Copy code
which corresponds to:
```
button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );
```
Copy code
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 );
```
Copy code
Using a custom callback allows processing the value before passing it to the target property:
```
button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );
```
Copy code
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 );
```
Copy code
See source (with github icon)
Type parameters
K
Parameters
bindProperty : K
Observable property that will be bound to other observable(s).
Returns
ObservableSingleBindChain<K, BalloonEditor[ K ]>
The bind chain with the to() and toMany() methods.
decorate( methodName ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#decorate
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 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 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.
```
Copy code
Note: The high 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'
```
Copy code
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'
```
Copy code
See source (with github icon)
Parameters
methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'isReadOnly' | 'ui' | 'editing' | 'model' | 'execute' | 'plugins' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins' | 'sourceElement' | 'updateSourceElement'
Name of the method to decorate.
Returns
void
delegate( events ) → EmitterMixinDelegateChain
inherited
module:editor-balloon/ballooneditor~BalloonEditor#delegate
Delegates selected events to another Emitter. For instance:
```
emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
```
Copy code
then eventX is delegated (fired by) emitterB and emitterC along with data:
```
emitterA.fire( 'eventX', data );
```
Copy code
and eventY is delegated (fired by) emitterC along with data:
```
emitterA.fire( 'eventY', data );
```
Copy code
See source (with github icon)
Parameters
events : Array<string>
Event names that will be delegated to another emitter.
Returns
EmitterMixinDelegateChain
destroy() → Promise<unknown>

Destroys the editor instance, releasing all resources used by it.
Updates the original editor element with the data if the updateSourceElementOnDestroy configuration option is set to true.
See source (with github icon)
Returns
Promise<unknown>
disableReadOnlyMode( lockId ) → void
inherited

Removes the read-only lock from the editor with given lock ID.
When no lock is present on the editor anymore, then the isReadOnly property will be set to false.
See source (with github icon)
Parameters
lockId : string | symbol
The lock ID for setting the editor to the read-only state.
Returns
void
enableReadOnlyMode( lockId ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#enableReadOnlyMode
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 property will be set to true:
```
editor.isReadOnly; // `false`.
editor.enableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `true`.
```
Copy code
You can turn off the read-only mode ("clear the lock") using the disableReadOnlyMode() method:
```
editor.enableReadOnlyMode( 'my-feature-id' );
// ...
editor.disableReadOnlyMode( 'my-feature-id' );
editor.isReadOnly; // `false`.
```
Copy code
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`.
```
Copy code
See source (with github icon)
Parameters
lockId : string | symbol
A unique ID for setting the editor to the read-only state.
Returns
void
execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>
inherited
module:editor-balloon/ballooneditor~BalloonEditor#execute
Executes the specified command with given parameters.
Shorthand for:
```
editor.commands.get( commandName ).execute( ... );
```
Copy code
See source (with github icon)
Type parameters
TName : extends string
Parameters
commandName : TName
The name of the command to execute.
commandParams : Parameters<CommandsMap[ TName ][ 'execute' ]>
Command parameters.
Returns
ReturnType<CommandsMap[ TName ][ 'execute' ]>
The value returned by the commands.execute().
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
inherited

Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
eventOrInfo : GetNameOrEventInfo<TEvent>
The name of the event or EventInfo object if event is delegated.
args : TEvent[ 'args' ]
Additional arguments to be passed to the callbacks.
Returns
GetEventInfo<TEvent>[ 'return' ]
By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).
focus() → void
inherited

Focuses the editor.
Note To explicitly focus the editing area of the editor, use the editor.editing.view.focus() method of the editing view.
Check out the Focus in the editor UI section of the Deep dive into focus tracking guide to learn more.
See source (with github icon)
Returns
void
getData( [ options ] = { [options.rootName], [options.trim], options.[key: string] } ) → string
inherited
module:editor-balloon/ballooneditor~BalloonEditor#getData
Gets the data from the editor.
```
editor.getData(); // -> 'This is editor!'
```
Copy code
If your editor implementation uses multiple roots, you should pass root name as one of the options:
```
editor.getData( { rootName: 'header' } ); // -> 'Content for header part.'
```
Copy code
By default, the editor outputs HTML. This can be controlled by injecting a different data processor. See the 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.
See source (with github icon)
Parameters
[ options ] : object
Additional configuration for the retrieved data. Editor features may introduce more configuration options that can be set through this parameter.

Properties

[ options.rootName ] : string
Root name. Defaults to 'main'.
[ options.trim ] : 'none' | 'empty'
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 ' ' for an empty editor).
options.[key: string] : unknown
Returns
string
Output data.
initPlugins() → Promise<LoadedPlugins>
inherited

Loads and initializes plugins specified in the configuration.
See source (with github icon)
Returns
Promise<LoadedPlugins>
A promise which resolves once the initialization is completed, providing an array of loaded plugins.
listenTo( emitter, event, callback, [ options ] ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#listenTo:BASE_EMITTER
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' );
```
Copy code
An event callback can stop the event and set the return value of the fire method.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type describing the event. See BaseEvent.
Parameters
emitter : Emitter
The object that fires the event.
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
off( event, callback ) → void
inherited

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).
See source (with github icon)
Parameters
event : string
The name of the event.
callback : Function
The function to stop being called.
Returns
void
on( event, callback, [ options ] ) → void
inherited

Registers a callback function to be executed when an event is fired.
Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
once( event, callback, [ options ] ) → void
inherited

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.
See source (with github icon)
Type parameters
TEvent : extends BaseEvent
The type descibing the event. See BaseEvent.
Parameters
event : TEvent[ 'name' ]
The name of the event.
callback : GetCallback<TEvent>
The function to be called on event.
[ options ] : GetCallbackOptions<TEvent>
Additional options.
Returns
void
set( values ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#set:OBJECT
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'
	} );
}
```
Copy code
See source (with github icon)
Parameters
values : object
An object with name=>value pairs.
Returns
void
set( name, value ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#set:KEY_VALUE
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 );
}
```
Copy code
See source (with github icon)
Type parameters
K
Parameters
name : K
The property's name.
value : BalloonEditor[ K ]
The property's value.
Returns
void
setData( data ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#setData
Sets the data in the editor.
```
editor.setData( 'This is editor!' );
```
Copy code
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: 'Content for header part.',
 content: 'Content for main part.',
 footer: 'Content for footer part.'
} );
```
Copy code
By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.
See source (with github icon)
Parameters
data : string | Record<string, string>
Input data.
Returns
void
stopDelegating( [ event ], [ emitter ] ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#stopDelegating
Stops delegating events. It can be used at different levels:
- To stop delegating all events.
- To stop delegating a specific event to all emitters.
- To stop delegating a specific event to a specific emitter.
See source (with github icon)
Parameters
[ event ] : string
The name of the event to stop delegating. If omitted, stops it all delegations.
[ emitter ] : Emitter
(requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.
Returns
void
stopListening( [ emitter ], [ event ], [ callback ] ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#stopListening:BASE_STOP
Stops listening for events. It can be used at different levels:
- To stop listening to a specific callback.
- To stop listening to a specific event.
- To stop listening to all events fired by a specific object.
- To stop listening to all events fired by all objects.
See source (with github icon)
Parameters
[ emitter ] : Emitter
The object to stop listening to. If omitted, stops it for all objects.
[ event ] : string
(Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.
[ callback ] : Function
(Requires the event) The function to be removed from the call list for the given event.
Returns
void
unbind( unbindProperties ) → void
inherited
module:editor-balloon/ballooneditor~BalloonEditor#unbind
Removes the binding created with bind.
```
// Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();
```
Copy code
See source (with github icon)
Parameters
unbindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'data' | 'focus' | 'id' | 'config' | 'locale' | 't' | 'destroy' | 'isReadOnly' | 'ui' | 'editing' | 'model' | 'execute' | 'plugins' | 'keystrokes' | 'accessibility' | 'commands' | 'conversion' | 'state' | 'enableReadOnlyMode' | 'disableReadOnlyMode' | 'setData' | 'getData' | 'initPlugins' | 'sourceElement' | 'updateSourceElement'>
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Returns
void
updateSourceElement( [ data ] ) → void
inherited

Updates the editor source element's content with the data if the updateSourceElementOnDestroy configuration option is set to true.
See source (with github icon)
Parameters
[ data ] : string
Data that the editor source element should be updated with.
Returns
void
_showLicenseError( reason, [ name ] ) → void
protectedinherited

See source (with github icon)
Parameters
reason : LicenseErrorReason
[ name ] : string
Returns
void

Static methods

create( sourceElementOrData, config ) → Promise<BalloonEditor>
static
module:editor-balloon/ballooneditor~BalloonEditor.create
Creates a new balloon editor instance.
There are three general ways how the editor can be initialized.
Using an existing DOM element (and loading data from it)
You can initialize the editor using an existing DOM element:
```
BalloonEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		console.log( 'Editor was initialized', editor );
	} )
	.catch( err => {
		console.error( err.stack );
	} );
```
Copy code
The element's content will be used as the editor data and the element will become the editable element.
Creating a detached editor
Alternatively, you can initialize the editor by passing the initial data directly as a string. In this case, the editor will render an element that must be inserted into the DOM for the editor to work properly:
```
BalloonEditor
	.create( 'Hello world!' )
	.then( editor => {
		console.log( 'Editor was initialized', editor );

		// Initial data was provided so the editor UI element needs to be added manually to the DOM.
		document.body.appendChild( editor.ui.element );
	} )
	.catch( err => {
		console.error( err.stack );
	} );
```
Copy code
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.
Using an existing DOM element (and data provided in 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:
```
BalloonEditor
	.create( document.querySelector( '#editor' ), {
		initialData: '<h2>Initial data</h2>Foo bar.'
	} )
	.then( editor => {
		console.log( 'Editor was initialized', editor );
	} )
	.catch( err => {
		console.error( err.stack );
	} );
```
Copy code
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.
Configuring the editor
See the editor configuration documentation to learn more about customizing plugins, toolbar and more.
Using the editor from source
If you want to use the balloon editor, you need to define the list of plugins to be initialized and toolbar items.
See source (with github icon)
Parameters
sourceElementOrData : string | HTMLElement
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 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 under the editor.ui.element property.
config : EditorConfig
The editor configuration.

Defaults to {}
Returns
Promise<BalloonEditor>
A promise resolved once the editor is ready. The promise resolves with the created editor instance.

Events

change:isReadOnly( eventInfo, name, value, oldValue )
inherited

Fired when the isReadOnly property changed value.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isReadOnly).
value : boolean
New value of the isReadOnly property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isReadOnly property with given key or null, if property was not set before.
change:state( eventInfo, name, value, oldValue )
inherited

Fired when the state property changed value.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (state).
value : 'ready' | 'initializing' | 'destroyed'
New value of the state property with given key or null, if operation should remove property.
oldValue : 'ready' | 'initializing' | 'destroyed'
Old value of the state property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )
inherited
module:editor-balloon/ballooneditor~BalloonEditor#event:change:{property}
Fired when a property changed value.
```
observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'
```
Copy code
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.
collectUsageData( eventInfo, <anonymous> = { .setUsageData } )
inherited

Fired when the editor is about to collect usage data.
This event is fired when the editor is about to collect usage data. It allows plugins to provide additional data for the usage statistics. The usage data is collected by the editor and sent to the usage tracking server. All plugins are expected to be ready at this point.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
<anonymous> : object
Properties

<anonymous>.setUsageData : void
destroy( eventInfo )
inherited

Fired when this editor instance is destroyed. The editor at this point is not usable and this event should be used to perform the clean-up in any plugin.
See also the editor.state property.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
ready( eventInfo )
inherited

Fired when the data and all additional editor components are ready.
Note: This event is most useful for plugin developers. When integrating the editor with your website or application, you do not have to listen to editor#ready because when the promise returned by the static Editor.create() event is resolved, the editor is already ready. In fact, since the first moment when the editor instance is available to you is inside then()'s callback, you cannot even add a listener to the editor#ready event.
See also the editor.state property.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
set:isReadOnly( eventInfo, name, value, oldValue )
inherited

Fired when the isReadOnly property is going to be set but is not set yet (before the change event is fired).
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (isReadOnly).
value : boolean
New value of the isReadOnly property with given key or null, if operation should remove property.
oldValue : boolean
Old value of the isReadOnly property with given key or null, if property was not set before.
set:state( eventInfo, name, value, oldValue )
inherited

Fired when the state property is going to be set but is not set yet (before the change event is fired).
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
Name of the changed property (state).
value : 'ready' | 'initializing' | 'destroyed'
New value of the state property with given key or null, if operation should remove property.
oldValue : 'ready' | 'initializing' | 'destroyed'
Old value of the state property with given key or null, if property was not set before.
set:{property}( eventInfo, name, value, oldValue )
inherited
module:editor-balloon/ballooneditor~BalloonEditor#event:set:{property}
Fired when a property value is going to be set but is not set yet (before the change event is fired).
You can control the final value of the property by using the event's return property.
```
observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
 // -> 'Current property value is 1'
 // -> 'Value has changed from 1 to 3'
```
Copy code
Note: The event is fired even when the new value is the same as the old value.
See source (with github icon)
Parameters
eventInfo : EventInfo
An object containing information about the fired event.
name : string
The property name.
value : TValue
The new property value.
oldValue : TValue
The previous property value.

BalloonEditor

Properties

accessibility : Accessibilityreadonlyinherited

commands : CommandCollectionreadonlyinherited

config : Config<EditorConfig>readonlyinherited

conversion : Conversionreadonlyinherited

data : DataControllerreadonlyinherited

editing : EditingControllerreadonlyinherited

id : stringreadonlyinherited

isReadOnly : booleanreadonlyinherited

keystrokes : EditingKeystrokeHandlerreadonlyinherited

locale : Localereadonlyinherited

model : Modelreadonlyinherited

plugins : PluginCollection<Editor>readonlyinherited

sourceElement : undefined | HTMLElementreadonlyinherited

state : 'ready' | 'initializing' | 'destroyed'inherited Eye iconobservable

t : LocaleTranslatereadonlyinherited

Related:

ui : BalloonEditorUIreadonly

_context : Contextprotectedreadonlyinherited

_readOnlyLocks : Set<string | symbol>protectedreadonlyinherited

Static properties

Context : Contextinheritedstatic

ContextWatchdog : ContextWatchdoginheritedstatic

EditorWatchdog : EditorWatchdoginheritedstatic

builtinPlugins : Array<PluginConstructor<Editor>> | undefinedinheritedstatic

defaultConfig : EditorConfig | undefinedinheritedstatic

editorName : 'BalloonEditor'readonlystatic

Methods

constructor( sourceElementOrData, config )protected

Parameters

bind( bindProperties ) → ObservableMultiBindChaininherited

Parameters

Returns

bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, BalloonEditor[ K1 ], K2, BalloonEditor[ K2 ]>inherited

Type parameters

Parameters

Returns

bind( bindProperty ) → ObservableSingleBindChain<K, BalloonEditor[ K ]>inherited

Type parameters

Parameters

Returns

decorate( methodName ) → voidinherited

Parameters

Returns

delegate( events ) → EmitterMixinDelegateChaininherited

Parameters

Returns

destroy() → Promise<unknown>

Returns

disableReadOnlyMode( lockId ) → voidinherited

Parameters

Returns

enableReadOnlyMode( lockId ) → voidinherited

Parameters

Returns

execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>inherited

Type parameters

Parameters

Returns

fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]inherited

Type parameters

Parameters

Returns

focus() → voidinherited

Returns

getData( [ options ] = { [options.rootName], [options.trim], options.[key: string] } ) → stringinherited

Parameters

Returns

initPlugins() → Promise<LoadedPlugins>inherited

Returns

listenTo( emitter, event, callback, [ options ] ) → voidinherited

Type parameters

Parameters

Returns

off( event, callback ) → voidinherited

Parameters

Returns

on( event, callback, [ options ] ) → voidinherited

Type parameters

`accessibility : Accessibility`
readonlyinherited

`commands : CommandCollection`
readonlyinherited

`config : Config<EditorConfig>`
readonlyinherited

`conversion : Conversion`
readonlyinherited

`data : DataController`
readonlyinherited

`editing : EditingController`
readonlyinherited

`id : string`
readonlyinherited

`isReadOnly : boolean`
readonlyinherited

`keystrokes : EditingKeystrokeHandler`
readonlyinherited

`locale : Locale`
readonlyinherited

`model : Model`
readonlyinherited

`plugins : PluginCollection<Editor>`
readonlyinherited

`sourceElement : undefined | HTMLElement`
readonlyinherited

`state : 'ready' | 'initializing' | 'destroyed'`
inheritedobservable

`t : LocaleTranslate`
readonlyinherited

`ui : BalloonEditorUI`
readonly

`_context : Context`
protectedreadonlyinherited

`_readOnlyLocks : Set<string | symbol>`
protectedreadonlyinherited

`Context : Context`
inheritedstatic

`ContextWatchdog : ContextWatchdog`
inheritedstatic

`EditorWatchdog : EditorWatchdog`
inheritedstatic

`builtinPlugins : Array<PluginConstructor<Editor>> | undefined`
inheritedstatic

`defaultConfig : EditorConfig | undefined`
inheritedstatic

`editorName : 'BalloonEditor'`
readonlystatic

`constructor( sourceElementOrData, config )`
protected

`bind( bindProperties ) → ObservableMultiBindChain`
inherited

`bind( bindProperty1, bindProperty2 ) → ObservableDualBindChain<K1, BalloonEditor[ K1 ], K2, BalloonEditor[ K2 ]>`
inherited

`bind( bindProperty ) → ObservableSingleBindChain<K, BalloonEditor[ K ]>`
inherited

`decorate( methodName ) → void`
inherited

`delegate( events ) → EmitterMixinDelegateChain`
inherited

`destroy() → Promise<unknown>`

`disableReadOnlyMode( lockId ) → void`
inherited

`enableReadOnlyMode( lockId ) → void`
inherited

`execute( commandName, commandParams ) → ReturnType<CommandsMap[ TName ][ 'execute' ]>`
inherited

`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`
inherited

`focus() → void`
inherited

`getData( [ options ] = { [options.rootName], [options.trim], options.[key: string] } ) → string`
inherited

`initPlugins() → Promise<LoadedPlugins>`
inherited

`listenTo( emitter, event, callback, [ options ] ) → void`
inherited

`off( event, callback ) → void`
inherited

`on( event, callback, [ options ] ) → void`
inherited

`once( event, callback, [ options ] ) → void`
inherited

`set( values ) → void`
inherited

`set( name, value ) → void`
inherited

`setData( data ) → void`
inherited

`stopDelegating( [ event ], [ emitter ] ) → void`
inherited

`stopListening( [ emitter ], [ event ], [ callback ] ) → void`
inherited

`unbind( unbindProperties ) → void`
inherited

`updateSourceElement( [ data ] ) → void`
inherited

`_showLicenseError( reason, [ name ] ) → void`
protectedinherited

`create( sourceElementOrData, config ) → Promise<BalloonEditor>`
static

Using an existing DOM element (and data provided in `config.initialData`)

`change:isReadOnly( eventInfo, name, value, oldValue )`
inherited

`change:state( eventInfo, name, value, oldValue )`
inherited

`change:{property}( eventInfo, name, value, oldValue )`
inherited

`collectUsageData( eventInfo, <anonymous> = { .setUsageData } )`
inherited

`destroy( eventInfo )`
inherited

`ready( eventInfo )`
inherited

`set:isReadOnly( eventInfo, name, value, oldValue )`
inherited

`set:state( eventInfo, name, value, oldValue )`
inherited

`set:{property}( eventInfo, name, value, oldValue )`
inherited