list/todolist/todolistconverters

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

Functions

• dataModelViewInsertion( model ) → GetCallback<DowncastInsertEvent<Element>>module:list/todolist/todolistconverters~dataModelViewInsertion

  See source

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

  It is used by DataController.

  Parameters

  model : Model

  Model instance.

  Returns

  GetCallback<DowncastInsertEvent<Element>>

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event

• dataViewModelCheckmarkInsertion( this, ev, args ) → voidmodule:list/todolist/todolistconverters~dataViewModelCheckmarkInsertion

  See source

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

  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

  this : Emitter

  ev : EventInfo<'element' | `element:${ string }`, unknown>

  args : tuple

  Returns

  void

  Related:

  • UpcastDispatcher#event

• mapModelToViewPosition( view ) → GetCallback<MapperModelToViewPositionEvent>module:list/todolist/todolistconverters~mapModelToViewPosition

  See source

  A 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

  GetCallback<MapperModelToViewPositionEvent>

• modelViewChangeChecked( onCheckedChange ) → GetCallback<DowncastAttributeEvent<Element>>module:list/todolist/todolistconverters~modelViewChangeChecked

  See source

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

  It marks the checkbox UI element as checked.

  It is used by EditingController.

  Parameters

  onCheckedChange : ( Element ) => void

  Callback fired after clicking the checkbox UI element.

  Returns

  GetCallback<DowncastAttributeEvent<Element>>

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event

• modelViewChangeType( onCheckedChange, view ) → GetCallback<DowncastAttributeEvent<Element>>module:list/todolist/todolistconverters~modelViewChangeType

  See source

  A model-to-view converter for the listType attribute change on the listItem model 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 modelViewChangeType and followed by modelViewMergeAfterChangeType to handle splitting and merging surrounding lists of the same type.

  It is used by EditingController.

  Parameters

  onCheckedChange : ( Element ) => void

  Callback fired after clicking the checkbox UI element.

  view : View

  Editing view controller.

  Returns

  GetCallback<DowncastAttributeEvent<Element>>

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event

• modelViewInsertion( model, onCheckboxChecked ) → GetCallback<DowncastInsertEvent<Element>>module:list/todolist/todolistconverters~modelViewInsertion

  See source

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

  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 : ( Element ) => void

  Callback function.

  Returns

  GetCallback<DowncastInsertEvent<Element>>

  Returns a conversion callback.

  Related:

  • DowncastDispatcher#event