UNPKG

@ckeditor/ckeditor5-list

Version:

Ordered and unordered lists feature to CKEditor 5.

ckeditor.com/ckeditor-5

ckeditor/ckeditor5

83 lines (82 loc) • 4.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/** * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license */ /** * @module list/todolist/todolistconverters */ import type { DowncastAttributeEvent, DowncastInsertEvent, Element, MapperModelToViewPositionEvent, Model, UpcastElementEvent, View } from 'ckeditor5/src/engine'; import { type GetCallback } from 'ckeditor5/src/utils'; /** * A model-to-view converter for the `listItem` model element insertion. * * It converts the `listItem` model element to an unordered list with a {@link module:engine/view/uielement~UIElement checkbox element} * at the beginning of each list item. It also merges the list with surrounding lists (if available). * * It is used by {@link module:engine/controller/editingcontroller~EditingController}. * * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert * @param model Model instance. * @param onCheckboxChecked Callback function. * @returns Returns a conversion callback. */ export declare function modelViewInsertion(model: Model, onCheckboxChecked: (element: Element) => void): GetCallback<DowncastInsertEvent<Element>>; /** * A model-to-view converter for the `listItem` model element insertion. * * It is used by {@link module:engine/controller/datacontroller~DataController}. * * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert * @param model Model instance. * @returns Returns a conversion callback. */ export declare function dataModelViewInsertion(model: Model): GetCallback<DowncastInsertEvent<Element>>; /** * 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 {@link module:engine/controller/datacontroller~DataController}. * * @see module:engine/conversion/upcastdispatcher~UpcastDispatcher#event:element */ export declare const dataViewModelCheckmarkInsertion: GetCallback<UpcastElementEvent>; /** * 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 * {@link module:engine/view/uielement~UIElement checkbox UI element} is added at the beginning * of the list item element (or vice versa). * * This converter is preceded by {@link module:list/list/converters~modelViewChangeType} and followed by * {@link module:list/list/converters~modelViewMergeAfterChangeType} to handle splitting and merging surrounding lists of the same type. * * It is used by {@link module:engine/controller/editingcontroller~EditingController}. * * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute * @param onCheckedChange Callback fired after clicking the checkbox UI element. * @param view Editing view controller. * @returns Returns a conversion callback. */ export declare function modelViewChangeType(onCheckedChange: (element: Element) => void, view: View): GetCallback<DowncastAttributeEvent<Element>>; /** * A model-to-view converter for the `todoListChecked` attribute change on the `listItem` model element. * * It marks the {@link module:engine/view/uielement~UIElement checkbox UI element} as checked. * * It is used by {@link module:engine/controller/editingcontroller~EditingController}. * * @see module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute * @param onCheckedChange Callback fired after clicking the checkbox UI element. * @returns Returns a conversion callback. */ export declare function modelViewChangeChecked(onCheckedChange: (element: Element) => void): GetCallback<DowncastAttributeEvent<Element>>; /** * 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. */ export declare function mapModelToViewPosition(view: View): GetCallback<MapperModelToViewPositionEvent>;