CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

list/documentlist/converters

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

module

Filtering

Functions

  • internal

    bogusParagraphCreator( attributeNames, __namedParameters = { [__namedParameters.dataPipeline] } ) → ElementCreatorFunction

    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

  • internal

    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

  • internal

    listItemDowncastConverter( attributeNames, strategies, model, __namedParameters = { [__namedParameters.dataPipeline] } ) → GetCallback<DowncastAttributeEvent<ListElement>>

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

  • internal

    listItemUpcastConverter() → GetCallback<UpcastElementEvent>

    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>

    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, documentListEditing ) → () => void

    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

    () => void