Class

BalloonEditor (editor-balloon)

@ckeditor/ckeditor5-editor-balloon/src/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.

Balloon editor and balloon build

The balloon editor can be used directly from source (if you installed the @ckeditor/ckeditor5-editor-balloon package) but it is also available in the balloon build.

Builds are ready-to-use editors with plugins bundled in. When using the editor from source you need to take care of loading all plugins by yourself (through the config.plugins option). Using the editor from source gives much better flexibility and allows easier customization.

Read more about initializing the editor from source or as a build in BalloonEditor.create().

Filtering

Properties

  • commands : CommandCollection

    readonly inherited

    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;
  • config : Config

    readonly inherited

    Holds all configurations specific to this editor instance.

    editor.config.get( 'image.toolbar' );
    // -> [ 'imageStyle:full', 'imageStyle:side', '|', 'imageTextAlternative' ]
  • conversion : Conversion

    readonly inherited

    Conversion manager through which you can register model to view and view to model converters.

    See Conversion's documentation to learn how to add converters.

  • data : DataController

    readonly inherited

    The data controller. Used e.g. for setting and retrieving editor data.

  • editing : EditingController

    readonly inherited

    The editing controller. Controls user input and rendering the content for editing.

  • isReadOnly : Boolean

    inherited observable

    Defines whether this editor is in 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 can set this value directly:

    editor.isReadOnly = true;
  • keystrokes : EditingKeystrokeHandler

    readonly inherited

    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 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 low level mechanism and trying to listen to them via the keystroke handler will not work reliably. To handle those specific keystrokes see the events fired by the editing view document (editor.editing.view.document).

  • locale : Locale

    readonly inherited

  • model : Model

    readonly inherited

    The editor's model.

    The central point of the editor's abstract data model.

  • plugins : PluginCollection

    readonly inherited

    The plugins loaded and in use by this editor instance.

    editor.plugins.get( 'Clipboard' ); // -> instance of the Clipboard plugin.
  • state : 'initializing' | 'ready' | 'destroyed'

    inherited observable

    Indicates the editor life-cycle state.

    The editor is in one of the following states:

Static properties

  • builtinPlugins : Array.<Function>

    inherited static

    An array of plugins built into this editor class. It is used in 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 ); // -> instance of the Foo plugin
            editor.plugins.get( BarPlugin ); // -> instance of the Bar plugin
        } );
    
    ClassicEditor
        .create( sourceElement, {
            // Don't initialize this plugins (note: it's defined by a string):
            removePlugins: [ 'Foo' ]
        } )
        .then( editor => {
            editor.plugins.get( FooPlugin ); // -> undefined
            editor.config.get( BarPlugin ); // -> instance of the Bar plugin
        } );
    
    ClassicEditor
        .create( sourceElement, {
            // Load only this plugin. Can also be define by a string if
            // this plugin was built into the editor class.
            plugins: [ FooPlugin ]
        } )
        .then( editor => {
            editor.plugins.get( FooPlugin ); // -> instance of the Foo plugin
            editor.config.get( BarPlugin ); // -> undefined
        } );

    See also defaultConfig.

  • defaultConfig : Object

    inherited static

    The default config which is built into the editor class. It is used in CKEditor 5 builds to provide the default config options which are later used during 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 config passed to create().
    ClassicEditor
        .create( sourceElement, { bar: 3 } )
        .then( editor => {
            editor.config.get( 'foo' ); // -> 1
            editor.config.get( 'bar' ); // -> 3
        } );

    See also builtinPlugins.

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.

    Parameters

    sourceElementOrData : HTMLElement | String

    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.

  • bind( bindProperties ) → Object

    mixed

    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' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    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' );

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

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

    Parameters

    bindProperties : String

    Observable properties that will be bound to other observable(s).

    Returns

    Object

    The bind chain with the to() and toMany() methods.

  • decorate( methodName )

    mixed

    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 {
        constructor() {
            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 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'

    Parameters

    methodName : String

    Name of the method to decorate.

  • delegate( events ) → EmitterMixinDelegateChain

    mixed

    Delegates selected events to another 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 );

    Parameters

    events : String

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • destroy() → Promise

    Destroys the editor instance, releasing all resources used by it.

    Updates the original editor element with the data.

    Returns

    Promise
  • execute( commandName, [ ...commandParams ] )

    inherited

    Executes specified command with given parameters.

    Shorthand for:

    editor.commands.get( commandName ).execute( ... );

    Parameters

    commandName : String

    Name of command to execute.

    [ ...commandParams ] : *

    Command parameters.

  • fire( eventOrInfo, [ args ] ) → *

    mixed

    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.

    Parameters

    eventOrInfo : String | EventInfo

    The name of the event or EventInfo object if event is delegated.

    [ args ] : *

    Additional arguments to be passed to the callbacks.

    Returns

    *

    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).

  • getData( [ options ] = { [options.rootName], [options.trim] } ) → String

    mixed

    Gets the data from the editor.

    editor.getData(); // -> '<p>This is editor!</p>'

    By default the editor outputs HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

    Note: Not only is the format of the data configurable, but the type of the getData()'s return value does not have to be a string either. You can e.g. return an object or a DOM DocumentFragment if you consider this the right format for you.

    Parameters

    [ options ] : Object
    Properties
    [ options.rootName ] : String

    Root name.

    Defaults to 'main'

    [ options.trim ] : String

    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>&nbsp;</p>' for an empty editor).

    Defaults to 'empty'

    Returns

    String

    Output data.

  • initPlugins() → Promise.<LoadedPlugins>

    inherited

    Loads and initializes plugins specified in the config.

    Returns

    Promise.<LoadedPlugins>

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

  • listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

    mixed

    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 stop the event and set the return value of the fire method.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • off( event, callback )

    mixed

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to stop being called.

  • on( event, callback, [ options ] = { [options.priority] } )

    mixed

    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).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • once( event, callback, [ options ] = { [options.priority] } )

    mixed

    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.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • set( name, [ value ] )

    mixed

    Creates and sets the value of an observable property of this object. Such an property becomes a part of the state and is be observable.

    It accepts also 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 have 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.

    Parameters

    name : String | Object

    The property's name or object with name=>value pairs.

    [ value ] : *

    The property's value (if name was passed in the first parameter).

  • setData( data )

    mixed

    Sets the data in the editor.

    editor.setData( '<p>This is editor!</p>' );

    By default the editor accepts HTML. This can be controlled by injecting a different data processor. See the Markdown output guide for more details.

    Note: Not only is the format of the data configurable, but the type of the setData()'s parameter does not have to be a string either. You can e.g. accept an object or a DOM DocumentFragment if you consider this the right format for you.

    Parameters

    data : String

    Input data.

  • stopDelegating( [ event ], [ emitter ] )

    mixed

    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.

    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.

  • stopListening( [ emitter ], [ event ], [ callback ] )

    mixed

    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.

    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.

  • t()

    inherited

    Shorthand for t.

    Related:

  • unbind( [ unbindProperties ] )

    mixed

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
    A.unbind( 'a' );
    
    // Removes bindings for all properties.
    A.unbind();

    Parameters

    [ unbindProperties ] : String

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

  • updateSourceElement()

    mixed

    Updates the editor source element's content with the data.

Static methods

  • create( sourceElementOrData, [ config ] ) → Promise

    static

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

    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( '<p>Hello world!</p>' )
        .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 );
        } );

    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><p>Foo bar.</p>'
        } )
        .then( editor => {
            console.log( 'Editor was initialized', editor );
        } )
        .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.

    Configuring the editor

    See the editor configuration documentation to learn more about customizing plugins, toolbar and more.

    Using the editor from source

    The code samples listed in the previous sections of this documentation assume that you are using an editor build (for example – @ckeditor/ckeditor5-build-balloon).

    If you want to use the balloon editor from source (@ckeditor/ckeditor5-editor-balloon/src/ballooneditor), you need to define the list of plugins to be initialized and toolbar items. Read more about using the editor from source in the "Advanced setup" guide.

    Parameters

    sourceElementOrData : HTMLElement | String

    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. Moreover, the editor data will be set back to the original element once the editor is destroyed.

    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.

    Returns

    Promise

    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.

    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.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (state).

    value : 'initializing' | 'ready' | 'destroyed'

    New value of the state property with given key or null, if operation should remove property.

    oldValue : 'initializing' | 'ready' | 'destroyed'

    Old value of the state property with given key or null, if property was not set before.

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

    mixed

    Fired when a property changed value.

    observable.set( 'prop', 1 );
    
    observable.on( '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'

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    The property name.

    value : *

    The new property value.

    oldValue : *

    The previous property value.

  • 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.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • ready( eventInfo )

    inherited

    Fired when 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.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

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

    mixed

    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( '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( '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'

    Note: Event is fired even when the new value is the same as the old value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    The property name.

    value : *

    The new property value.

    oldValue : *

    The previous property value.