Report an issue
Interface

DataApi (core/editor/utils)

@ckeditor/ckeditor5-core/src/editor/utils/dataapimixin

interface

Interface defining editor methods for setting and getting data to and from the editor's main root element using the data pipeline.

This interface is not a part of the Editor class because one may want to implement an editor with multiple root elements, in which case the methods for setting and getting data will need to be implemented differently.

Filtering

Methods

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

    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.

  • setData( data )

    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.