list/list/converters

@ckeditor/ckeditor5-list/src/list/converters

Functions

• internal

  bogusParagraphCreator( attributeNames, __namedParameters = { [__namedParameters.dataPipeline] } ) → ElementCreatorFunctionmodule:list/list/converters~bogusParagraphCreator

  See source

  Returns the bogus paragraph view element creator. A bogus paragraph is used if a list item contains only a single block or nested list.

  Parameters

  attributeNames : Array<string>

  The list of all model list attributes (including registered strategies).

  __namedParameters : object

  Properties

  [ __namedParameters.dataPipeline ] : boolean

  Defaults to {}

  Returns

  ElementCreatorFunction

• createModelToViewPositionMapper( strategies, view ) → GetCallback<MapperModelToViewPositionEvent>module:list/list/converters~createModelToViewPositionMapper

  See source

  The model to view custom position mapping for cases when marker is injected at the beginning of a block.

  Parameters

  strategies : Array<DowncastStrategy>

  view : View

  Returns

  GetCallback<MapperModelToViewPositionEvent>

• internal

  findMappedViewElement( element, mapper, model ) → Element | nullmodule:list/list/converters~findMappedViewElement

  See source

  Helper for mapping mode to view elements. It's using positions mapping instead of mapper.toViewElement( element ) to find outermost view element. This is for cases when mapping is using inner view element like in the code blocks (pre > code).

  Parameters

  element : Element

  The model element.

  mapper : Mapper

  The mapper instance.

  model : Model

  The model.

  Returns

  Element | null

• internal

  listItemDowncastConverter( attributeNames, strategies, model, __namedParameters = { [__namedParameters.dataPipeline] } ) → GetCallback<DowncastAttributeEvent<ListElement>>module:list/list/converters~listItemDowncastConverter

  See source

  Returns the list item downcast converter.

  Parameters

  attributeNames : Array<string>

  A list of attribute names that should be converted if they are set.

  strategies : Array<DowncastStrategy>

  The strategies.

  model : Model

  The model.

  __namedParameters : object

  Properties

  [ __namedParameters.dataPipeline ] : boolean

  Defaults to {}

  Returns

  GetCallback<DowncastAttributeEvent<ListElement>>

• listItemDowncastRemoveConverter( schema ) → GetCallback<DowncastRemoveEvent>module:list/list/converters~listItemDowncastRemoveConverter

  See source

  The 'remove' downcast converter for custom markers.

  Parameters

  schema : Schema

  Returns

  GetCallback<DowncastRemoveEvent>

• internal

  listItemUpcastConverter() → GetCallback<UpcastElementEvent>module:list/list/converters~listItemUpcastConverter

  See source

  Returns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.

  Returns

  GetCallback<UpcastElementEvent>

• internal

  listUpcastCleanList() → GetCallback<UpcastElementEvent>module:list/list/converters~listUpcastCleanList

  See source

  Returns the upcast converter for the <ul> and <ol> view elements that cleans the input view of garbage. This is mostly to clean whitespaces from between the <li> view elements inside the view list element. However, incorrect data can also be cleared if the view was incorrect.

  Returns

  GetCallback<UpcastElementEvent>

• internal

  reconvertItemsOnDataChange( model, editing, attributeNames, listEditing ) → () => voidmodule:list/list/converters~reconvertItemsOnDataChange

  See source

  Returns a model document change:data event listener that triggers conversion of related items if needed.

  Parameters

  model : Model

  The editor model.

  editing : EditingController

  The editing controller.

  attributeNames : Array<string>

  The list of all model list attributes (including registered strategies).

  listEditing : ListEditing

  The document list editing plugin.

  Returns

  () => void