engine/conversion/upcasthelpers

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

Classes

• UpcastHelpersmodule:engine/conversion/upcasthelpers~UpcastHelpers

Type Definitions

• AttributeCreatorFunctionmodule:engine/conversion/upcasthelpers~AttributeCreatorFunction

• ElementCreatorFunctionmodule:engine/conversion/upcasthelpers~ElementCreatorFunction

• MarkerFromAttributeCreatorFunctionmodule:engine/conversion/upcasthelpers~MarkerFromAttributeCreatorFunction

• MarkerFromElementCreatorFunctionmodule:engine/conversion/upcasthelpers~MarkerFromElementCreatorFunction

Functions

• convertSelectionChange( model, mapper ) → ( EventInfo<string, unknown>, object ) => voidmodule:engine/conversion/upcasthelpers~convertSelectionChange

  See source

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

  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

  ( EventInfo<string, unknown>, object ) => void

  event-selectionChange callback function.

• convertText() → ( EventInfo<string, unknown>, UpcastConversionData<Text>, UpcastConversionApi ) => voidmodule:engine/conversion/upcasthelpers~convertText

  See source

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

  Returns

  ( EventInfo<string, unknown>, UpcastConversionData<Text>, UpcastConversionApi ) => void

  View text converter.

• convertToModelFragment() → ( EventInfo<string, unknown>, UpcastConversionData<Element | DocumentFragment>, UpcastConversionApi ) => voidmodule:engine/conversion/upcasthelpers~convertToModelFragment

  See source

  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.

  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

  ( EventInfo<string, unknown>, UpcastConversionData<Element | DocumentFragment>, UpcastConversionApi ) => void

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