list/legacytodolist/legacytodolistconverters
@ckeditor/ckeditor5-list/src/legacytodolist/legacytodolistconverters
Filtering
Constants
-
dataViewModelCheckmarkInsertion : GetCallback<UpcastElementEvent>module:list/legacytodolist/legacytodolistconverters~dataViewModelCheckmarkInsertionA view-to-model converter for the checkbox element inside a view list item.
It changes the
listTypeof the modellistItemto atodovalue. When a view checkbox element is marked as checked, an additionaltodoListChecked="true"attribute is added to the model item.It is used by
DataController.
Functions
-
dataModelViewInsertion( model ) → GetCallback<DowncastInsertEvent<Element>>module:list/legacytodolist/legacytodolistconverters~dataModelViewInsertionA model-to-view converter for the
listItemmodel element insertion.It is used by
DataController.Parameters
model : ModelModel instance.
Returns
GetCallback<DowncastInsertEvent<Element>>Returns a conversion callback.
Related:
-
mapModelToViewPosition( view ) → GetCallback<MapperModelToViewPositionEvent>module:list/legacytodolist/legacytodolistconverters~mapModelToViewPositionA model-to-view position at zero offset mapper.
This helper ensures that position inside todo-list in the view is mapped after the checkbox.
It only handles the position at the beginning of a list item as other positions are properly mapped be the default mapper.
Parameters
view : View
Returns
-
modelViewChangeChecked( onCheckedChange ) → GetCallback<DowncastAttributeEvent<Element>>module:list/legacytodolist/legacytodolistconverters~modelViewChangeCheckedA model-to-view converter for the
todoListCheckedattribute change on thelistItemmodel element.It marks the checkbox UI element as checked.
It is used by
EditingController.Parameters
onCheckedChange : ( element: Element ) => voidCallback fired after clicking the checkbox UI element.
Returns
GetCallback<DowncastAttributeEvent<Element>>Returns a conversion callback.
Related:
-
modelViewChangeType( onCheckedChange, view ) → GetCallback<DowncastAttributeEvent<Element>>module:list/legacytodolist/legacytodolistconverters~modelViewChangeTypeA model-to-view converter for the
listTypeattribute change on thelistItemmodel element.This change means that the
<li>element parent changes to<ul class="todo-list">and a checkbox UI element is added at the beginning of the list item element (or vice versa).This converter is preceded by
modelViewChangeTypeand followed bymodelViewMergeAfterChangeTypeto handle splitting and merging surrounding lists of the same type.It is used by
EditingController.Parameters
onCheckedChange : ( element: Element ) => voidCallback fired after clicking the checkbox UI element.
view : ViewEditing view controller.
Returns
GetCallback<DowncastAttributeEvent<Element>>Returns a conversion callback.
Related:
-
modelViewInsertion( model, onCheckboxChecked ) → GetCallback<DowncastInsertEvent<Element>>module:list/legacytodolist/legacytodolistconverters~modelViewInsertionA model-to-view converter for the
listItemmodel element insertion.It converts the
listItemmodel element to an unordered list with a checkbox element at the beginning of each list item. It also merges the list with surrounding lists (if available).It is used by
EditingController.Parameters
Returns
GetCallback<DowncastInsertEvent<Element>>Returns a conversion callback.
Related:
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.