list/list/converters
Functions
bogusParagraphCreator( attributeNames, __namedParameters = { [__namedParameters.dataPipeline] } ) → DowncastElementCreatorFunctioninternalmodule: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>internalmodule: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<ListDowncastStrategy>view : EditingView
Returns
findMappedViewElement( element, mapper, model, writer ) → ViewElement | undefinedinternalmodule: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
element : ModelElementThe model element.
mapper : MapperThe mapper instance.
model : ModelThe model.
writer : ViewDowncastWriterThe view downcast writer.
Returns
ViewElement | undefined
listItemDowncastConverter( attributeNames, strategies, model, __namedParameters = { [__namedParameters.dataPipeline], [__namedParameters.enableSkipLevelLists] } ) → GetCallback<DowncastAttributeEvent<ListElement>>internalmodule: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<ListDowncastStrategy>The strategies.
model : ModelThe model.
__namedParameters : object- Properties
[ __namedParameters.dataPipeline ] : boolean[ __namedParameters.enableSkipLevelLists ] : boolean
Returns
listItemDowncastRemoveConverter( schema ) → GetCallback<DowncastRemoveEvent>internalmodule:list/list/converters~listItemDowncastRemoveConverterlistItemSkipLevelConsumer() → GetCallback<UpcastElementEvent>internalmodule:list/list/converters~listItemSkipLevelConsumerReturns a consuming upcast converter for skip-level list item wrappers. It detects intermediate
<li>elements withlist-style-type:none(generated by the skip-level downcast or by external sources) and consumes them without producing a model element, so they don't end up as empty list items in the model.The wrapper
<li>is consumed, but its children (nested lists) are converted normally. BecausegetIndent()counts all ancestor<li>elements (including the consumed wrapper), nested items receive the correct indent values that reflect the skip-level gap.Only
<li>elements whose sole meaningful content is a nested<ul>/<ol>are treated as intermediate wrappers. Anything else (text, paragraphs, custom elements, even an empty<li>withlist-style-type:nonecarrying only attributes) falls through to the regular list item upcast, so its data and attributes can be preserved by GHS or other plugins.Returns
listItemUpcastConverter() → GetCallback<UpcastElementEvent>internalmodule: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
reconvertItemsOnDataChange( model, editing, attributeNames, listEditing ) → () => voidinternalmodule: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