CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

list/documentlist/converters

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

module

Filtering

Functions

  • protected

    bogusParagraphCreator( attributeNames, [ options ] = { [options.dataPipeline] } ) → function

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

    [ options ] : Object
    Properties
    [ options.dataPipeline ] : Boolean

    Defaults to false

    Returns

    function

  • protected

    findMappedViewElement( element, mapper, model ) → Element | null

    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

  • protected

    listItemDowncastConverter( attributeNames, strategies, model ) → function

    See source

    Returns the list item downcast converter.

    Parameters

    attributeNames : Array.<String>

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

    strategies : Array.<AttributeStrategy>

    The strategies.

    model : Model

    The model.

    Returns

    function

  • protected

    listItemUpcastConverter() → function

    See source

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

    Returns

    function

  • protected

    listUpcastCleanList() → function

    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, also incorrect data can be cleared if the view was incorrect.

    Returns

    function

  • protected

    reconvertItemsOnDataChange( model, editing, attributeNames, documentListEditing ) → function

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

    documentListEditing : DocumentListEditing

    The document list editing plugin.

    Returns

    function