list/todolist/todolistconverters

@ckeditor/ckeditor5-list/src/todolist/todolistconverters

Functions

• dataModelViewInsertion( model ) → functionmodule:list/todolist/todolistconverters~dataModelViewInsertion

  A model-to-view converter for the listItem model element insertion.

  See source

  It is used by DataController.

  Parameters

  model : Model

  Model instance.

  Returns

  function

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event:insert

• dataViewModelCheckmarkInsertion( evt, data, conversionApi )module:list/todolist/todolistconverters~dataViewModelCheckmarkInsertion

  A view-to-model converter for the checkbox element inside a view list item.

  See source

  It changes the listType of the model listItem to a todo value. When a view checkbox element is marked as checked, an additional todoListChecked="true" attribute is added to the model item.

  It is used by DataController.

  Parameters

  evt : EventInfo

  An object containing information about the fired event.

  data : Object

  An object containing conversion input, a placeholder for conversion output and possibly other values.

  conversionApi : UpcastConversionApi

  Conversion interface to be used by the callback.

  Related:

  • UpcastDispatcher#event:element

• mapModelToViewPosition( view ) → functionmodule:list/todolist/todolistconverters~mapModelToViewPosition

  A model-to-view position at zero offset mapper.

  See source

  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

  function

• modelViewChangeChecked( onCheckedChange ) → functionmodule:list/todolist/todolistconverters~modelViewChangeChecked

  A model-to-view converter for the todoListChecked attribute change on the listItem model element.

  See source

  It marks the checkbox UI element as checked.

  It is used by EditingController.

  Parameters

  onCheckedChange : function

  Callback fired after clicking the checkbox UI element.

  Returns

  function

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event:attribute

• modelViewChangeType( onCheckedChange, view ) → functionmodule:list/todolist/todolistconverters~modelViewChangeType

  A model-to-view converter for the listType attribute change on the listItem model element.

  See source

  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 modelViewChangeType and followed by modelViewMergeAfterChangeType to handle splitting and merging surrounding lists of the same type.

  It is used by EditingController.

  Parameters

  onCheckedChange : function

  Callback fired after clicking the checkbox UI element.

  view : View

  Editing view controller.

  Returns

  function

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event:attribute

• modelViewInsertion( model, onCheckboxChecked ) → functionmodule:list/todolist/todolistconverters~modelViewInsertion

  A model-to-view converter for the listItem model element insertion.

  See source

  It converts the listItem model 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

  model : Model

  Model instance.

  onCheckboxChecked : function

  Callback function.

  Returns

  function

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event:insert