CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

engine/conversion/upcasthelpers

@ckeditor/ckeditor5-engine/src/conversion/upcasthelpers

module
See source

Contains the view to model converters for UpcastDispatcher.

Filtering

Classes

Functions

  • convertSelectionChange( model, mapper ) → function

    Function factory, creates a callback function which converts a view selection taken from the event-selectionChange event and sets in on the model.

    See source

    Note: because there is no view selection change dispatcher nor any other advanced view selection to model conversion mechanism, the callback should be set directly on view document.

    view.document.on( 'selectionChange', convertSelectionChange( modelDocument, mapper ) );

    Parameters

    model : Model

    Data model.

    mapper : Mapper

    Conversion mapper.

    Returns

    function

    event-selectionChange callback function.

  • convertText() → function

    Function factory, creates a converter that converts Text to Text.

    See source

    Returns

    function

    View text converter.

  • convertToModelFragment() → function

    Function factory, creates a converter that converts view document fragment or all children of Element into model document fragment. This is the "entry-point" converter for upcast (view to model conversion). This converter starts the conversion of all children of passed view document fragment. Those children view nodes are then handled by other converters.

    See source

    This also a "default", last resort converter for all view elements that has not been converted by other converters. When a view element is being converted to the model but it does not have converter specified, that view element will be converted to model document fragment and returned.

    Returns

    function

    Universal converter for view fragments and elements that returns model fragment with children of converted view item.