@ckeditor/ckeditor5-engine 36.0.1 → 37.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/README.md +1 -1
  2. package/package.json +24 -23
  3. package/src/controller/datacontroller.d.ts +331 -0
  4. package/src/controller/datacontroller.js +62 -109
  5. package/src/controller/editingcontroller.d.ts +98 -0
  6. package/src/controller/editingcontroller.js +22 -46
  7. package/src/conversion/conversion.d.ts +476 -0
  8. package/src/conversion/conversion.js +328 -347
  9. package/src/conversion/conversionhelpers.d.ts +26 -0
  10. package/src/conversion/conversionhelpers.js +1 -5
  11. package/src/conversion/downcastdispatcher.d.ts +547 -0
  12. package/src/conversion/downcastdispatcher.js +74 -152
  13. package/src/conversion/downcasthelpers.d.ts +1226 -0
  14. package/src/conversion/downcasthelpers.js +843 -762
  15. package/src/conversion/mapper.d.ts +499 -0
  16. package/src/conversion/mapper.js +84 -99
  17. package/src/conversion/modelconsumable.d.ts +201 -0
  18. package/src/conversion/modelconsumable.js +96 -99
  19. package/src/conversion/upcastdispatcher.d.ts +492 -0
  20. package/src/conversion/upcastdispatcher.js +73 -100
  21. package/src/conversion/upcasthelpers.d.ts +499 -0
  22. package/src/conversion/upcasthelpers.js +406 -373
  23. package/src/conversion/viewconsumable.d.ts +177 -0
  24. package/src/conversion/viewconsumable.js +157 -162
  25. package/src/dataprocessor/basichtmlwriter.d.ts +18 -0
  26. package/src/dataprocessor/basichtmlwriter.js +0 -9
  27. package/src/dataprocessor/dataprocessor.d.ts +61 -0
  28. package/src/dataprocessor/htmldataprocessor.d.ts +76 -0
  29. package/src/dataprocessor/htmldataprocessor.js +6 -28
  30. package/src/dataprocessor/htmlwriter.d.ts +16 -0
  31. package/src/dataprocessor/xmldataprocessor.d.ts +90 -0
  32. package/src/dataprocessor/xmldataprocessor.js +8 -40
  33. package/src/dev-utils/model.d.ts +124 -0
  34. package/src/dev-utils/model.js +41 -38
  35. package/src/dev-utils/operationreplayer.d.ts +51 -0
  36. package/src/dev-utils/operationreplayer.js +6 -14
  37. package/src/dev-utils/utils.d.ts +37 -0
  38. package/src/dev-utils/utils.js +5 -18
  39. package/src/dev-utils/view.d.ts +319 -0
  40. package/src/dev-utils/view.js +205 -226
  41. package/src/index.d.ts +105 -0
  42. package/src/index.js +1 -0
  43. package/src/model/batch.d.ts +106 -0
  44. package/src/model/differ.d.ts +329 -0
  45. package/src/model/document.d.ts +245 -0
  46. package/src/model/document.js +1 -1
  47. package/src/model/documentfragment.d.ts +196 -0
  48. package/src/model/documentfragment.js +2 -2
  49. package/src/model/documentselection.d.ts +420 -0
  50. package/src/model/element.d.ts +165 -0
  51. package/src/model/history.d.ts +114 -0
  52. package/src/model/item.d.ts +14 -0
  53. package/src/model/liveposition.d.ts +77 -0
  54. package/src/model/liverange.d.ts +102 -0
  55. package/src/model/markercollection.d.ts +335 -0
  56. package/src/model/model.d.ts +812 -0
  57. package/src/model/model.js +59 -30
  58. package/src/model/node.d.ts +256 -0
  59. package/src/model/nodelist.d.ts +91 -0
  60. package/src/model/operation/attributeoperation.d.ts +98 -0
  61. package/src/model/operation/detachoperation.d.ts +55 -0
  62. package/src/model/operation/insertoperation.d.ts +85 -0
  63. package/src/model/operation/markeroperation.d.ts +86 -0
  64. package/src/model/operation/mergeoperation.d.ts +95 -0
  65. package/src/model/operation/moveoperation.d.ts +91 -0
  66. package/src/model/operation/nooperation.d.ts +33 -0
  67. package/src/model/operation/operation.d.ts +89 -0
  68. package/src/model/operation/operationfactory.d.ts +18 -0
  69. package/src/model/operation/renameoperation.d.ts +78 -0
  70. package/src/model/operation/rootattributeoperation.d.ts +97 -0
  71. package/src/model/operation/rootattributeoperation.js +1 -1
  72. package/src/model/operation/splitoperation.d.ts +104 -0
  73. package/src/model/operation/transform.d.ts +100 -0
  74. package/src/model/operation/utils.d.ts +71 -0
  75. package/src/model/position.d.ts +539 -0
  76. package/src/model/position.js +1 -1
  77. package/src/model/range.d.ts +458 -0
  78. package/src/model/range.js +1 -1
  79. package/src/model/rootelement.d.ts +40 -0
  80. package/src/model/schema.d.ts +1176 -0
  81. package/src/model/schema.js +15 -15
  82. package/src/model/selection.d.ts +472 -0
  83. package/src/model/text.d.ts +66 -0
  84. package/src/model/text.js +0 -2
  85. package/src/model/textproxy.d.ts +144 -0
  86. package/src/model/treewalker.d.ts +186 -0
  87. package/src/model/treewalker.js +19 -10
  88. package/src/model/typecheckable.d.ts +255 -0
  89. package/src/model/utils/autoparagraphing.d.ts +37 -0
  90. package/src/model/utils/deletecontent.d.ts +58 -0
  91. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -0
  92. package/src/model/utils/getselectedcontent.d.ts +30 -0
  93. package/src/model/utils/insertcontent.d.ts +46 -0
  94. package/src/model/utils/insertcontent.js +2 -12
  95. package/src/model/utils/insertobject.d.ts +44 -0
  96. package/src/model/utils/insertobject.js +3 -14
  97. package/src/model/utils/modifyselection.d.ts +48 -0
  98. package/src/model/utils/selection-post-fixer.d.ts +65 -0
  99. package/src/model/writer.d.ts +726 -0
  100. package/src/model/writer.js +6 -4
  101. package/src/view/attributeelement.d.ts +108 -0
  102. package/src/view/attributeelement.js +25 -69
  103. package/src/view/containerelement.d.ts +49 -0
  104. package/src/view/containerelement.js +10 -43
  105. package/src/view/datatransfer.d.ts +75 -0
  106. package/src/view/document.d.ts +184 -0
  107. package/src/view/document.js +15 -84
  108. package/src/view/documentfragment.d.ts +150 -0
  109. package/src/view/documentfragment.js +40 -81
  110. package/src/view/documentselection.d.ts +219 -0
  111. package/src/view/documentselection.js +75 -121
  112. package/src/view/domconverter.d.ts +620 -0
  113. package/src/view/domconverter.js +159 -276
  114. package/src/view/downcastwriter.d.ts +804 -0
  115. package/src/view/downcastwriter.js +336 -380
  116. package/src/view/editableelement.d.ts +52 -0
  117. package/src/view/editableelement.js +9 -49
  118. package/src/view/element.d.ts +466 -0
  119. package/src/view/element.js +150 -222
  120. package/src/view/elementdefinition.d.ts +87 -0
  121. package/src/view/emptyelement.d.ts +41 -0
  122. package/src/view/emptyelement.js +11 -44
  123. package/src/view/filler.d.ts +111 -0
  124. package/src/view/filler.js +24 -21
  125. package/src/view/item.d.ts +14 -0
  126. package/src/view/matcher.d.ts +486 -0
  127. package/src/view/matcher.js +247 -218
  128. package/src/view/node.d.ts +160 -0
  129. package/src/view/node.js +26 -100
  130. package/src/view/observer/arrowkeysobserver.d.ts +41 -0
  131. package/src/view/observer/arrowkeysobserver.js +0 -13
  132. package/src/view/observer/bubblingemittermixin.d.ts +166 -0
  133. package/src/view/observer/bubblingemittermixin.js +36 -25
  134. package/src/view/observer/bubblingeventinfo.d.ts +47 -0
  135. package/src/view/observer/bubblingeventinfo.js +3 -29
  136. package/src/view/observer/clickobserver.d.ts +43 -0
  137. package/src/view/observer/clickobserver.js +9 -19
  138. package/src/view/observer/compositionobserver.d.ts +82 -0
  139. package/src/view/observer/compositionobserver.js +13 -42
  140. package/src/view/observer/domeventdata.d.ts +50 -0
  141. package/src/view/observer/domeventdata.js +5 -30
  142. package/src/view/observer/domeventobserver.d.ts +69 -0
  143. package/src/view/observer/domeventobserver.js +19 -21
  144. package/src/view/observer/fakeselectionobserver.d.ts +46 -0
  145. package/src/view/observer/fakeselectionobserver.js +2 -15
  146. package/src/view/observer/focusobserver.d.ts +82 -0
  147. package/src/view/observer/focusobserver.js +14 -40
  148. package/src/view/observer/inputobserver.d.ts +86 -0
  149. package/src/view/observer/inputobserver.js +18 -64
  150. package/src/view/observer/keyobserver.d.ts +67 -0
  151. package/src/view/observer/keyobserver.js +8 -42
  152. package/src/view/observer/mouseobserver.d.ts +89 -0
  153. package/src/view/observer/mouseobserver.js +8 -28
  154. package/src/view/observer/mutationobserver.d.ts +82 -0
  155. package/src/view/observer/mutationobserver.js +7 -37
  156. package/src/view/observer/observer.d.ts +84 -0
  157. package/src/view/observer/observer.js +12 -25
  158. package/src/view/observer/selectionobserver.d.ts +143 -0
  159. package/src/view/observer/selectionobserver.js +9 -99
  160. package/src/view/observer/tabobserver.d.ts +42 -0
  161. package/src/view/observer/tabobserver.js +0 -14
  162. package/src/view/placeholder.d.ts +85 -0
  163. package/src/view/placeholder.js +26 -43
  164. package/src/view/position.d.ts +189 -0
  165. package/src/view/position.js +36 -83
  166. package/src/view/range.d.ts +279 -0
  167. package/src/view/range.js +79 -122
  168. package/src/view/rawelement.d.ts +73 -0
  169. package/src/view/rawelement.js +34 -48
  170. package/src/view/renderer.d.ts +265 -0
  171. package/src/view/renderer.js +105 -193
  172. package/src/view/rooteditableelement.d.ts +41 -0
  173. package/src/view/rooteditableelement.js +12 -40
  174. package/src/view/selection.d.ts +375 -0
  175. package/src/view/selection.js +79 -153
  176. package/src/view/styles/background.d.ts +33 -0
  177. package/src/view/styles/background.js +14 -12
  178. package/src/view/styles/border.d.ts +43 -0
  179. package/src/view/styles/border.js +58 -48
  180. package/src/view/styles/margin.d.ts +29 -0
  181. package/src/view/styles/margin.js +13 -11
  182. package/src/view/styles/padding.d.ts +29 -0
  183. package/src/view/styles/padding.js +13 -11
  184. package/src/view/styles/utils.d.ts +93 -0
  185. package/src/view/styles/utils.js +22 -48
  186. package/src/view/stylesmap.d.ts +675 -0
  187. package/src/view/stylesmap.js +249 -244
  188. package/src/view/text.d.ts +74 -0
  189. package/src/view/text.js +16 -46
  190. package/src/view/textproxy.d.ts +97 -0
  191. package/src/view/textproxy.js +10 -59
  192. package/src/view/treewalker.d.ts +195 -0
  193. package/src/view/treewalker.js +43 -106
  194. package/src/view/typecheckable.d.ts +401 -0
  195. package/src/view/uielement.d.ts +96 -0
  196. package/src/view/uielement.js +28 -62
  197. package/src/view/upcastwriter.d.ts +328 -0
  198. package/src/view/upcastwriter.js +124 -134
  199. package/src/view/view.d.ts +327 -0
  200. package/src/view/view.js +79 -150
@@ -11,14 +11,18 @@ import { getCode } from '@ckeditor/ckeditor5-utils';
11
11
  * Observer for events connected with pressing keyboard keys.
12
12
  *
13
13
  * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
14
- *
15
- * @extends module:engine/view/observer/domeventobserver~DomEventObserver
16
14
  */
17
15
  export default class KeyObserver extends DomEventObserver {
18
- constructor(view) {
19
- super(view);
16
+ constructor() {
17
+ super(...arguments);
18
+ /**
19
+ * @inheritDoc
20
+ */
20
21
  this.domEventType = ['keydown', 'keyup'];
21
22
  }
23
+ /**
24
+ * @inheritDoc
25
+ */
22
26
  onDomEvent(domEvt) {
23
27
  const data = {
24
28
  keyCode: domEvt.keyCode,
@@ -33,41 +37,3 @@ export default class KeyObserver extends DomEventObserver {
33
37
  this.fire(domEvt.type, domEvt, data);
34
38
  }
35
39
  }
36
- /**
37
- * Fired when a key has been pressed.
38
- *
39
- * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
40
- *
41
- * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
42
- * {@link module:engine/view/view~View} this event is available by default.
43
- *
44
- * @see module:engine/view/observer/keyobserver~KeyObserver
45
- * @event module:engine/view/document~Document#event:keydown
46
- * @param {module:engine/view/observer/keyobserver~KeyEventData} keyEventData
47
- */
48
- /**
49
- * Fired when a key has been released.
50
- *
51
- * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
52
- *
53
- * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
54
- * {@link module:engine/view/view~View} this event is available by default.
55
- *
56
- * @see module:engine/view/observer/keyobserver~KeyObserver
57
- * @event module:engine/view/document~Document#event:keyup
58
- * @param {module:engine/view/observer/keyobserver~KeyEventData} keyEventData
59
- */
60
- /**
61
- * The value of both events - {@link module:engine/view/document~Document#event:keydown} and
62
- * {@link module:engine/view/document~Document#event:keyup}.
63
- *
64
- * @class module:engine/view/observer/keyobserver~KeyEventData
65
- * @extends module:engine/view/observer/domeventdata~DomEventData
66
- * @implements module:utils/keyboard~KeystrokeInfo
67
- */
68
- /**
69
- * Code of the whole keystroke. See {@link module:utils/keyboard~getCode}.
70
- *
71
- * @readonly
72
- * @member {Number} module:engine/view/observer/keyobserver~KeyEventData#keystroke
73
- */
@@ -0,0 +1,89 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module engine/view/observer/mouseobserver
7
+ */
8
+ import DomEventObserver from './domeventobserver';
9
+ import type DomEventData from './domeventdata';
10
+ /**
11
+ * Mouse events observer.
12
+ *
13
+ * Note that this observer is not available by default. To make it available it needs to be added to
14
+ * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
15
+ */
16
+ export default class MouseObserver extends DomEventObserver<'mousedown' | 'mouseup' | 'mouseover' | 'mouseout'> {
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ readonly domEventType: readonly ["mousedown", "mouseup", "mouseover", "mouseout"];
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ onDomEvent(domEvent: MouseEvent): void;
25
+ }
26
+ /**
27
+ * Fired when the mouse button is pressed down on one of the editing roots of the editor.
28
+ *
29
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
30
+ *
31
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
32
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
33
+ *
34
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
35
+ * @eventName mousedown
36
+ * @param data The event data.
37
+ */
38
+ export type ViewDocumentMouseDownEvent = {
39
+ name: 'mousedown';
40
+ args: [data: DomEventData<MouseEvent>];
41
+ };
42
+ /**
43
+ * Fired when the mouse button is released over one of the editing roots of the editor.
44
+ *
45
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
46
+ *
47
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
48
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
49
+ *
50
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
51
+ * @eventName mouseup
52
+ * @param data The event data.
53
+ */
54
+ export type ViewDocumentMouseUpEvent = {
55
+ name: 'mouseup';
56
+ args: [data: DomEventData<MouseEvent>];
57
+ };
58
+ /**
59
+ * Fired when the mouse is over one of the editing roots of the editor.
60
+ *
61
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
62
+ *
63
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
64
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
65
+ *
66
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
67
+ * @eventName mouseup
68
+ * @param data The event data.
69
+ */
70
+ export type ViewDocumentMouseOverEvent = {
71
+ name: 'mouseover';
72
+ args: [data: DomEventData<MouseEvent>];
73
+ };
74
+ /**
75
+ * Fired when the mouse is moved out of the one of the editing roots of the editor.
76
+ *
77
+ * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
78
+ *
79
+ * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
80
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
81
+ *
82
+ * @see module:engine/view/observer/mouseobserver~MouseObserver
83
+ * @eventName mouseup
84
+ * @param data The event data.
85
+ */
86
+ export type ViewDocumentMouseOutEvent = {
87
+ name: 'mouseout';
88
+ args: [data: DomEventData<MouseEvent>];
89
+ };
@@ -11,39 +11,19 @@ import DomEventObserver from './domeventobserver';
11
11
  *
12
12
  * Note that this observer is not available by default. To make it available it needs to be added to
13
13
  * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
14
- *
15
- * @extends module:engine/view/observer/domeventobserver~DomEventObserver
16
14
  */
17
15
  export default class MouseObserver extends DomEventObserver {
18
- constructor(view) {
19
- super(view);
16
+ constructor() {
17
+ super(...arguments);
18
+ /**
19
+ * @inheritDoc
20
+ */
20
21
  this.domEventType = ['mousedown', 'mouseup', 'mouseover', 'mouseout'];
21
22
  }
23
+ /**
24
+ * @inheritDoc
25
+ */
22
26
  onDomEvent(domEvent) {
23
27
  this.fire(domEvent.type, domEvent);
24
28
  }
25
29
  }
26
- /**
27
- * Fired when the mouse button is pressed down on one of the editing roots of the editor.
28
- *
29
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
30
- *
31
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
32
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
33
- *
34
- * @see module:engine/view/observer/mouseobserver~MouseObserver
35
- * @event module:engine/view/document~Document#event:mousedown
36
- * @param {module:engine/view/observer/domeventdata~DomEventData} data The event data.
37
- */
38
- /**
39
- * Fired when the mouse button is released over one of the editing roots of the editor.
40
- *
41
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
42
- *
43
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
44
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
45
- *
46
- * @see module:engine/view/observer/mouseobserver~MouseObserver
47
- * @event module:engine/view/document~Document#event:mouseup
48
- * @param {module:engine/view/observer/domeventdata~DomEventData} data The event data.
49
- */
@@ -0,0 +1,82 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module engine/view/observer/mutationobserver
7
+ */
8
+ import Observer from './observer';
9
+ import type DomConverter from '../domconverter';
10
+ import type Renderer from '../renderer';
11
+ import type View from '../view';
12
+ /**
13
+ * Mutation observer's role is to watch for any DOM changes inside the editor that weren't
14
+ * done by the editor's {@link module:engine/view/renderer~Renderer} itself and reverting these changes.
15
+ *
16
+ * It does this by observing all mutations in the DOM, marking related view elements as changed and calling
17
+ * {@link module:engine/view/renderer~Renderer#render}. Because all mutated nodes are marked as
18
+ * "to be rendered" and the {@link module:engine/view/renderer~Renderer#render `render()`} method is called,
19
+ * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
20
+ *
21
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
22
+ */
23
+ export default class MutationObserver extends Observer {
24
+ /**
25
+ * Reference to the {@link module:engine/view/view~View#domConverter}.
26
+ */
27
+ readonly domConverter: DomConverter;
28
+ /**
29
+ * Reference to the {@link module:engine/view/view~View#_renderer}.
30
+ */
31
+ readonly renderer: Renderer;
32
+ /**
33
+ * Native mutation observer config.
34
+ */
35
+ private readonly _config;
36
+ /**
37
+ * Observed DOM elements.
38
+ */
39
+ private readonly _domElements;
40
+ /**
41
+ * Native mutation observer.
42
+ */
43
+ private _mutationObserver;
44
+ /**
45
+ * @inheritDoc
46
+ */
47
+ constructor(view: View);
48
+ /**
49
+ * Synchronously handles mutations and empties the queue.
50
+ */
51
+ flush(): void;
52
+ /**
53
+ * @inheritDoc
54
+ */
55
+ observe(domElement: HTMLElement): void;
56
+ /**
57
+ * @inheritDoc
58
+ */
59
+ enable(): void;
60
+ /**
61
+ * @inheritDoc
62
+ */
63
+ disable(): void;
64
+ /**
65
+ * @inheritDoc
66
+ */
67
+ destroy(): void;
68
+ /**
69
+ * Handles mutations. Mark view elements to sync and call render.
70
+ *
71
+ * @param domMutations Array of native mutations.
72
+ */
73
+ private _onMutations;
74
+ /**
75
+ * Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
76
+ * Such mutations are generated while pressing space or performing native spellchecker correction
77
+ * on the end of the block element in Firefox browser.
78
+ *
79
+ * @param mutation Native mutation object.
80
+ */
81
+ private _isBogusBrMutation;
82
+ }
@@ -19,48 +19,21 @@ import { isEqualWith } from 'lodash-es';
19
19
  * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
20
20
  *
21
21
  * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
22
- *
23
- * @extends module:engine/view/observer/observer~Observer
24
22
  */
25
23
  export default class MutationObserver extends Observer {
24
+ /**
25
+ * @inheritDoc
26
+ */
26
27
  constructor(view) {
27
28
  super(view);
28
- /**
29
- * Native mutation observer config.
30
- *
31
- * @private
32
- * @member {Object}
33
- */
34
29
  this._config = {
35
30
  childList: true,
36
31
  characterData: true,
37
32
  subtree: true
38
33
  };
39
- /**
40
- * Reference to the {@link module:engine/view/view~View#domConverter}.
41
- *
42
- * @member {module:engine/view/domconverter~DomConverter}
43
- */
44
34
  this.domConverter = view.domConverter;
45
- /**
46
- * Reference to the {@link module:engine/view/view~View#_renderer}.
47
- *
48
- * @member {module:engine/view/renderer~Renderer}
49
- */
50
35
  this.renderer = view._renderer;
51
- /**
52
- * Observed DOM elements.
53
- *
54
- * @private
55
- * @member {Array.<HTMLElement>}
56
- */
57
36
  this._domElements = [];
58
- /**
59
- * Native mutation observer.
60
- *
61
- * @private
62
- * @member {MutationObserver}
63
- */
64
37
  this._mutationObserver = new window.MutationObserver(this._onMutations.bind(this));
65
38
  }
66
39
  /**
@@ -104,8 +77,7 @@ export default class MutationObserver extends Observer {
104
77
  /**
105
78
  * Handles mutations. Mark view elements to sync and call render.
106
79
  *
107
- * @private
108
- * @param {Array.<Object>} domMutations Array of native mutations.
80
+ * @param domMutations Array of native mutations.
109
81
  */
110
82
  _onMutations(domMutations) {
111
83
  // As a result of this.flush() we can have an empty collection.
@@ -171,7 +143,7 @@ export default class MutationObserver extends Observer {
171
143
  }
172
144
  // In case only non-relevant mutations were recorded it skips the event and force render (#5600).
173
145
  if (hasMutations) {
174
- // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
146
+ // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
175
147
  // @if CK_DEBUG_TYPING // console.group( '%c[MutationObserver]%c Mutations detected',
176
148
  // @if CK_DEBUG_TYPING // 'font-weight:bold;color:green', ''
177
149
  // @if CK_DEBUG_TYPING // );
@@ -179,7 +151,7 @@ export default class MutationObserver extends Observer {
179
151
  // At this point we have "dirty DOM" (changed) and de-synched view (which has not been changed).
180
152
  // In order to "reset DOM" we render the view again.
181
153
  this.view.forceRender();
182
- // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
154
+ // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
183
155
  // @if CK_DEBUG_TYPING // console.groupEnd();
184
156
  // @if CK_DEBUG_TYPING // }
185
157
  }
@@ -189,9 +161,7 @@ export default class MutationObserver extends Observer {
189
161
  * Such mutations are generated while pressing space or performing native spellchecker correction
190
162
  * on the end of the block element in Firefox browser.
191
163
  *
192
- * @private
193
- * @param {Object} mutation Native mutation object.
194
- * @returns {Boolean}
164
+ * @param mutation Native mutation object.
195
165
  */
196
166
  _isBogusBrMutation(mutation) {
197
167
  let addedNode = null;
@@ -0,0 +1,84 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import type Document from '../document';
6
+ import type View from '../view';
7
+ declare const Observer_base: {
8
+ new (): import("@ckeditor/ckeditor5-utils").DomEmitter;
9
+ prototype: import("@ckeditor/ckeditor5-utils").DomEmitter;
10
+ };
11
+ /**
12
+ * Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary
13
+ * processing and fire events on the {@link module:engine/view/document~Document} objects.
14
+ * Observers can also add features to the view, for instance by updating its status or marking elements
15
+ * which need a refresh on DOM events.
16
+ */
17
+ export default abstract class Observer extends Observer_base {
18
+ /**
19
+ * An instance of the view controller.
20
+ */
21
+ readonly view: View;
22
+ /**
23
+ * A reference to the {@link module:engine/view/document~Document} object.
24
+ */
25
+ readonly document: Document;
26
+ /**
27
+ * The state of the observer. If it is disabled, no events will be fired.
28
+ */
29
+ private _isEnabled;
30
+ /**
31
+ * Creates an instance of the observer.
32
+ */
33
+ constructor(view: View);
34
+ /**
35
+ * The state of the observer. If it is disabled, no events will be fired.
36
+ */
37
+ get isEnabled(): boolean;
38
+ /**
39
+ * Enables the observer. This method is called when the observer is registered to the
40
+ * {@link module:engine/view/view~View} and after {@link module:engine/view/view~View#forceRender rendering}
41
+ * (all observers are {@link #disable disabled} before rendering).
42
+ *
43
+ * A typical use case for disabling observers is that mutation observers need to be disabled for the rendering.
44
+ * However, a child class may not need to be disabled, so it can implement an empty method.
45
+ *
46
+ * @see module:engine/view/observer/observer~Observer#disable
47
+ */
48
+ enable(): void;
49
+ /**
50
+ * Disables the observer. This method is called before
51
+ * {@link module:engine/view/view~View#forceRender rendering} to prevent firing events during rendering.
52
+ *
53
+ * @see module:engine/view/observer/observer~Observer#enable
54
+ */
55
+ disable(): void;
56
+ /**
57
+ * Disables and destroys the observer, among others removes event listeners created by the observer.
58
+ */
59
+ destroy(): void;
60
+ /**
61
+ * Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).
62
+ *
63
+ * Currently, an event will be ignored only if its target or any of its ancestors has the `data-cke-ignore-events` attribute.
64
+ * This attribute can be used inside the structures generated by
65
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `DowncastWriter#createUIElement()`} to ignore events
66
+ * fired within a UI that should be excluded from CKEditor 5's realms.
67
+ *
68
+ * @param domTarget The DOM event target to check (usually an element, sometimes a text node and
69
+ * potentially sometimes a document, too).
70
+ * @returns Whether this event should be ignored by the observer.
71
+ */
72
+ checkShouldIgnoreEventFromTarget(domTarget: Node | null): boolean;
73
+ /**
74
+ * Starts observing the given root element.
75
+ *
76
+ * @param name The name of the root element.
77
+ */
78
+ abstract observe(domElement: HTMLElement, name: string): void;
79
+ }
80
+ /**
81
+ * The constructor of {@link ~Observer} subclass.
82
+ */
83
+ export type ObserverConstructor = new (view: View) => Observer;
84
+ export {};
@@ -11,38 +11,25 @@ import { DomEmitterMixin } from '@ckeditor/ckeditor5-utils';
11
11
  * processing and fire events on the {@link module:engine/view/document~Document} objects.
12
12
  * Observers can also add features to the view, for instance by updating its status or marking elements
13
13
  * which need a refresh on DOM events.
14
- *
15
- * @abstract
16
14
  */
17
15
  export default class Observer extends DomEmitterMixin() {
18
16
  /**
19
17
  * Creates an instance of the observer.
20
- *
21
- * @param {module:engine/view/view~View} view
22
18
  */
23
19
  constructor(view) {
24
20
  super();
25
21
  /**
26
- * An instance of the view controller.
27
- *
28
- * @readonly
29
- * @member {module:engine/view/view~View}
22
+ * The state of the observer. If it is disabled, no events will be fired.
30
23
  */
24
+ this._isEnabled = false;
31
25
  this.view = view;
32
- /**
33
- * A reference to the {@link module:engine/view/document~Document} object.
34
- *
35
- * @readonly
36
- * @member {module:engine/view/document~Document}
37
- */
38
26
  this.document = view.document;
39
- /**
40
- * The state of the observer. If it is disabled, no events will be fired.
41
- *
42
- * @readonly
43
- * @member {Boolean}
44
- */
45
- this.isEnabled = false;
27
+ }
28
+ /**
29
+ * The state of the observer. If it is disabled, no events will be fired.
30
+ */
31
+ get isEnabled() {
32
+ return this._isEnabled;
46
33
  }
47
34
  /**
48
35
  * Enables the observer. This method is called when the observer is registered to the
@@ -55,7 +42,7 @@ export default class Observer extends DomEmitterMixin() {
55
42
  * @see module:engine/view/observer/observer~Observer#disable
56
43
  */
57
44
  enable() {
58
- this.isEnabled = true;
45
+ this._isEnabled = true;
59
46
  }
60
47
  /**
61
48
  * Disables the observer. This method is called before
@@ -64,7 +51,7 @@ export default class Observer extends DomEmitterMixin() {
64
51
  * @see module:engine/view/observer/observer~Observer#enable
65
52
  */
66
53
  disable() {
67
- this.isEnabled = false;
54
+ this._isEnabled = false;
68
55
  }
69
56
  /**
70
57
  * Disables and destroys the observer, among others removes event listeners created by the observer.
@@ -81,9 +68,9 @@ export default class Observer extends DomEmitterMixin() {
81
68
  * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `DowncastWriter#createUIElement()`} to ignore events
82
69
  * fired within a UI that should be excluded from CKEditor 5's realms.
83
70
  *
84
- * @param {Node} domTarget The DOM event target to check (usually an element, sometimes a text node and
71
+ * @param domTarget The DOM event target to check (usually an element, sometimes a text node and
85
72
  * potentially sometimes a document, too).
86
- * @returns {Boolean} Whether this event should be ignored by the observer.
73
+ * @returns Whether this event should be ignored by the observer.
87
74
  */
88
75
  checkShouldIgnoreEventFromTarget(domTarget) {
89
76
  if (domTarget && domTarget.nodeType === 3) {
@@ -0,0 +1,143 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module engine/view/observer/selectionobserver
7
+ */
8
+ import Observer from './observer';
9
+ import MutationObserver from './mutationobserver';
10
+ import type View from '../view';
11
+ import type DocumentSelection from '../documentselection';
12
+ import type DomConverter from '../domconverter';
13
+ import type Selection from '../selection';
14
+ import FocusObserver from './focusobserver';
15
+ type DomSelection = globalThis.Selection;
16
+ /**
17
+ * Selection observer class observes selection changes in the document. If a selection changes on the document this
18
+ * observer checks if the DOM selection is different from the {@link module:engine/view/document~Document#selection view selection}.
19
+ * The selection observer fires {@link module:engine/view/document~Document#event:selectionChange} event only if
20
+ * a selection change was the only change in the document and the DOM selection is different from the view selection.
21
+ *
22
+ * This observer also manages the {@link module:engine/view/document~Document#isSelecting} property of the view document.
23
+ *
24
+ * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
25
+ */
26
+ export default class SelectionObserver extends Observer {
27
+ /**
28
+ * Instance of the mutation observer. Selection observer calls
29
+ * {@link module:engine/view/observer/mutationobserver~MutationObserver#flush} to ensure that the mutations will be handled
30
+ * before the {@link module:engine/view/document~Document#event:selectionChange} event is fired.
31
+ */
32
+ readonly mutationObserver: MutationObserver;
33
+ /**
34
+ * Instance of the focus observer. Focus observer calls
35
+ * {@link module:engine/view/observer/focusobserver~FocusObserver#flush} to mark the latest focus change as complete.
36
+ */
37
+ readonly focusObserver: FocusObserver;
38
+ /**
39
+ * Reference to the view {@link module:engine/view/documentselection~DocumentSelection} object used to compare
40
+ * new selection with it.
41
+ */
42
+ readonly selection: DocumentSelection;
43
+ /**
44
+ * Reference to the {@link module:engine/view/view~View#domConverter}.
45
+ */
46
+ readonly domConverter: DomConverter;
47
+ /**
48
+ * A set of documents which have added `selectionchange` listener to avoid adding a listener twice to the same
49
+ * document.
50
+ */
51
+ private readonly _documents;
52
+ /**
53
+ * Fires debounced event `selectionChangeDone`. It uses `lodash#debounce` method to delay function call.
54
+ */
55
+ private readonly _fireSelectionChangeDoneDebounced;
56
+ /**
57
+ * When called, starts clearing the {@link #_loopbackCounter} counter in time intervals. When the number of selection
58
+ * changes exceeds a certain limit within the interval of time, the observer will not fire `selectionChange` but warn about
59
+ * possible infinite selection loop.
60
+ */
61
+ private readonly _clearInfiniteLoopInterval;
62
+ /**
63
+ * Unlocks the `isSelecting` state of the view document in case the selection observer did not record this fact
64
+ * correctly (for whatever reason). It is a safeguard (paranoid check), that returns document to the normal state
65
+ * after a certain period of time (debounced, postponed by each selectionchange event).
66
+ */
67
+ private readonly _documentIsSelectingInactivityTimeoutDebounced;
68
+ /**
69
+ * Private property to check if the code does not enter infinite loop.
70
+ */
71
+ private _loopbackCounter;
72
+ constructor(view: View);
73
+ /**
74
+ * @inheritDoc
75
+ */
76
+ observe(domElement: HTMLElement): void;
77
+ /**
78
+ * @inheritDoc
79
+ */
80
+ destroy(): void;
81
+ /**
82
+ * Selection change listener. {@link module:engine/view/observer/mutationobserver~MutationObserver#flush Flush} mutations, check if
83
+ * a selection changes and fires {@link module:engine/view/document~Document#event:selectionChange} event on every change
84
+ * and {@link module:engine/view/document~Document#event:selectionChangeDone} when a selection stop changing.
85
+ *
86
+ * @param domEvent DOM event.
87
+ * @param domDocument DOM document.
88
+ */
89
+ private _handleSelectionChange;
90
+ /**
91
+ * Clears `SelectionObserver` internal properties connected with preventing infinite loop.
92
+ */
93
+ private _clearInfiniteLoop;
94
+ }
95
+ /**
96
+ * The value of {@link ~ViewDocumentSelectionChangeEvent} and {@link ~ViewDocumentSelectionChangeDoneEvent} events.
97
+ */
98
+ export type ViewDocumentSelectionEventData = {
99
+ /**
100
+ * Old View selection which is {@link module:engine/view/document~Document#selection}.
101
+ */
102
+ oldSelection: DocumentSelection;
103
+ /**
104
+ * New View selection which is converted DOM selection.
105
+ */
106
+ newSelection: Selection;
107
+ /**
108
+ * Native DOM selection.
109
+ */
110
+ domSelection: DomSelection | null;
111
+ };
112
+ /**
113
+ * Fired when a selection has changed. This event is fired only when the selection change was the only change that happened
114
+ * in the document, and the old selection is different then the new selection.
115
+ *
116
+ * Introduced by {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
117
+ *
118
+ * Note that because {@link module:engine/view/observer/selectionobserver~SelectionObserver} is attached by the
119
+ * {@link module:engine/view/view~View} this event is available by default.
120
+ *
121
+ * @see module:engine/view/observer/selectionobserver~SelectionObserver
122
+ * @eventName selectionChange
123
+ */
124
+ export type ViewDocumentSelectionChangeEvent = {
125
+ name: 'selectionChange';
126
+ args: [ViewDocumentSelectionEventData];
127
+ };
128
+ /**
129
+ * Fired when selection stops changing.
130
+ *
131
+ * Introduced by {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
132
+ *
133
+ * Note that because {@link module:engine/view/observer/selectionobserver~SelectionObserver} is attached by the
134
+ * {@link module:engine/view/view~View} this event is available by default.
135
+ *
136
+ * @see module:engine/view/observer/selectionobserver~SelectionObserver
137
+ * @eventName selectionChangeDone
138
+ */
139
+ export type ViewDocumentSelectionChangeDoneEvent = {
140
+ name: 'selectionChangeDone';
141
+ args: [ViewDocumentSelectionEventData];
142
+ };
143
+ export {};