list/list/converters
@ckeditor/ckeditor5-list/src/list/converters
Filtering
Functions
-
internal
bogusParagraphCreator( attributeNames, __namedParameters = { [__namedParameters.dataPipeline] } ) → ElementCreatorFunctionmodule:list/list/converters~bogusParagraphCreatorReturns 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
-
createModelToViewPositionMapper( strategies, view ) → GetCallback<MapperModelToViewPositionEvent>module:list/list/converters~createModelToViewPositionMapperThe 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
-
internal
findMappedViewElement( element, mapper, model ) → Element | nullmodule:list/list/converters~findMappedViewElementHelper 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
Returns
Element | null
-
internal
listItemDowncastConverter( attributeNames, strategies, model, __namedParameters = { [__namedParameters.dataPipeline] } ) → GetCallback<DowncastAttributeEvent<ListElement>>module:list/list/converters~listItemDowncastConverterReturns 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 : ModelThe model.
__namedParameters : object-
Properties
[ __namedParameters.dataPipeline ] : boolean
Defaults to
{}
Returns
-
listItemDowncastRemoveConverter( schema ) → GetCallback<DowncastRemoveEvent>module:list/list/converters~listItemDowncastRemoveConverter -
internal
listItemUpcastConverter() → GetCallback<UpcastElementEvent>module:list/list/converters~listItemUpcastConverterReturns the upcast converter for list items. It's supposed to work after the block converters (content inside list items) are converted.
Returns
-
internal
reconvertItemsOnDataChange( model, editing, attributeNames, listEditing ) → () => voidmodule:list/list/converters~reconvertItemsOnDataChangeReturns a model document change:data event listener that triggers conversion of related items if needed.
Parameters
model : ModelThe editor model.
editing : EditingControllerThe editing controller.
attributeNames : Array<string>The list of all model list attributes (including registered strategies).
listEditing : ListEditingThe document list editing plugin.
Returns
() => void
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.