@ckeditor/ckeditor5-engine 39.0.1 → 40.0.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 (244) hide show
  1. package/CHANGELOG.md +2 -2
  2. package/LICENSE.md +1 -1
  3. package/README.md +8 -8
  4. package/package.json +2 -6
  5. package/src/controller/datacontroller.d.ts +334 -334
  6. package/src/controller/datacontroller.js +481 -481
  7. package/src/controller/editingcontroller.d.ts +98 -98
  8. package/src/controller/editingcontroller.js +191 -191
  9. package/src/conversion/conversion.d.ts +478 -478
  10. package/src/conversion/conversion.js +601 -601
  11. package/src/conversion/conversionhelpers.d.ts +26 -26
  12. package/src/conversion/conversionhelpers.js +32 -32
  13. package/src/conversion/downcastdispatcher.d.ts +562 -562
  14. package/src/conversion/downcastdispatcher.js +547 -547
  15. package/src/conversion/downcasthelpers.d.ts +1226 -1226
  16. package/src/conversion/downcasthelpers.js +2183 -2183
  17. package/src/conversion/mapper.d.ts +503 -503
  18. package/src/conversion/mapper.js +536 -536
  19. package/src/conversion/modelconsumable.d.ts +201 -201
  20. package/src/conversion/modelconsumable.js +333 -333
  21. package/src/conversion/upcastdispatcher.d.ts +492 -492
  22. package/src/conversion/upcastdispatcher.js +460 -460
  23. package/src/conversion/upcasthelpers.d.ts +499 -499
  24. package/src/conversion/upcasthelpers.js +950 -950
  25. package/src/conversion/viewconsumable.d.ts +369 -369
  26. package/src/conversion/viewconsumable.js +532 -532
  27. package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
  28. package/src/dataprocessor/basichtmlwriter.js +19 -19
  29. package/src/dataprocessor/dataprocessor.d.ts +61 -61
  30. package/src/dataprocessor/dataprocessor.js +5 -5
  31. package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
  32. package/src/dataprocessor/htmldataprocessor.js +96 -96
  33. package/src/dataprocessor/htmlwriter.d.ts +16 -16
  34. package/src/dataprocessor/htmlwriter.js +5 -5
  35. package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
  36. package/src/dataprocessor/xmldataprocessor.js +108 -108
  37. package/src/dev-utils/model.d.ts +124 -124
  38. package/src/dev-utils/model.js +395 -395
  39. package/src/dev-utils/operationreplayer.d.ts +51 -51
  40. package/src/dev-utils/operationreplayer.js +112 -112
  41. package/src/dev-utils/utils.d.ts +37 -37
  42. package/src/dev-utils/utils.js +73 -73
  43. package/src/dev-utils/view.d.ts +319 -319
  44. package/src/dev-utils/view.js +967 -967
  45. package/src/index.d.ts +114 -114
  46. package/src/index.js +78 -78
  47. package/src/model/batch.d.ts +106 -106
  48. package/src/model/batch.js +96 -96
  49. package/src/model/differ.d.ts +387 -387
  50. package/src/model/differ.js +1149 -1149
  51. package/src/model/document.d.ts +272 -272
  52. package/src/model/document.js +361 -361
  53. package/src/model/documentfragment.d.ts +200 -200
  54. package/src/model/documentfragment.js +306 -306
  55. package/src/model/documentselection.d.ts +420 -420
  56. package/src/model/documentselection.js +993 -993
  57. package/src/model/element.d.ts +165 -165
  58. package/src/model/element.js +281 -281
  59. package/src/model/history.d.ts +114 -114
  60. package/src/model/history.js +207 -207
  61. package/src/model/item.d.ts +14 -14
  62. package/src/model/item.js +5 -5
  63. package/src/model/liveposition.d.ts +77 -77
  64. package/src/model/liveposition.js +93 -93
  65. package/src/model/liverange.d.ts +102 -102
  66. package/src/model/liverange.js +120 -120
  67. package/src/model/markercollection.d.ts +335 -335
  68. package/src/model/markercollection.js +403 -403
  69. package/src/model/model.d.ts +919 -919
  70. package/src/model/model.js +842 -842
  71. package/src/model/node.d.ts +256 -256
  72. package/src/model/node.js +375 -375
  73. package/src/model/nodelist.d.ts +91 -91
  74. package/src/model/nodelist.js +163 -163
  75. package/src/model/operation/attributeoperation.d.ts +103 -103
  76. package/src/model/operation/attributeoperation.js +148 -148
  77. package/src/model/operation/detachoperation.d.ts +60 -60
  78. package/src/model/operation/detachoperation.js +77 -77
  79. package/src/model/operation/insertoperation.d.ts +90 -90
  80. package/src/model/operation/insertoperation.js +135 -135
  81. package/src/model/operation/markeroperation.d.ts +91 -91
  82. package/src/model/operation/markeroperation.js +107 -107
  83. package/src/model/operation/mergeoperation.d.ts +100 -100
  84. package/src/model/operation/mergeoperation.js +167 -167
  85. package/src/model/operation/moveoperation.d.ts +96 -96
  86. package/src/model/operation/moveoperation.js +164 -164
  87. package/src/model/operation/nooperation.d.ts +38 -38
  88. package/src/model/operation/nooperation.js +48 -48
  89. package/src/model/operation/operation.d.ts +96 -96
  90. package/src/model/operation/operation.js +62 -62
  91. package/src/model/operation/operationfactory.d.ts +18 -18
  92. package/src/model/operation/operationfactory.js +44 -44
  93. package/src/model/operation/renameoperation.d.ts +83 -83
  94. package/src/model/operation/renameoperation.js +115 -115
  95. package/src/model/operation/rootattributeoperation.d.ts +98 -98
  96. package/src/model/operation/rootattributeoperation.js +155 -155
  97. package/src/model/operation/rootoperation.d.ts +76 -76
  98. package/src/model/operation/rootoperation.js +90 -90
  99. package/src/model/operation/splitoperation.d.ts +109 -109
  100. package/src/model/operation/splitoperation.js +194 -194
  101. package/src/model/operation/transform.d.ts +100 -100
  102. package/src/model/operation/transform.js +1985 -1985
  103. package/src/model/operation/utils.d.ts +71 -71
  104. package/src/model/operation/utils.js +213 -213
  105. package/src/model/position.d.ts +539 -539
  106. package/src/model/position.js +979 -979
  107. package/src/model/range.d.ts +458 -458
  108. package/src/model/range.js +875 -875
  109. package/src/model/rootelement.d.ts +60 -60
  110. package/src/model/rootelement.js +74 -74
  111. package/src/model/schema.d.ts +1186 -1186
  112. package/src/model/schema.js +1242 -1242
  113. package/src/model/selection.d.ts +482 -482
  114. package/src/model/selection.js +789 -789
  115. package/src/model/text.d.ts +66 -66
  116. package/src/model/text.js +85 -85
  117. package/src/model/textproxy.d.ts +144 -144
  118. package/src/model/textproxy.js +189 -189
  119. package/src/model/treewalker.d.ts +186 -186
  120. package/src/model/treewalker.js +244 -244
  121. package/src/model/typecheckable.d.ts +285 -285
  122. package/src/model/typecheckable.js +16 -16
  123. package/src/model/utils/autoparagraphing.d.ts +37 -37
  124. package/src/model/utils/autoparagraphing.js +63 -63
  125. package/src/model/utils/deletecontent.d.ts +58 -58
  126. package/src/model/utils/deletecontent.js +488 -488
  127. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
  128. package/src/model/utils/findoptimalinsertionrange.js +57 -57
  129. package/src/model/utils/getselectedcontent.d.ts +30 -30
  130. package/src/model/utils/getselectedcontent.js +125 -125
  131. package/src/model/utils/insertcontent.d.ts +46 -46
  132. package/src/model/utils/insertcontent.js +705 -705
  133. package/src/model/utils/insertobject.d.ts +44 -44
  134. package/src/model/utils/insertobject.js +139 -139
  135. package/src/model/utils/modifyselection.d.ts +48 -48
  136. package/src/model/utils/modifyselection.js +186 -186
  137. package/src/model/utils/selection-post-fixer.d.ts +74 -74
  138. package/src/model/utils/selection-post-fixer.js +260 -260
  139. package/src/model/writer.d.ts +851 -851
  140. package/src/model/writer.js +1306 -1306
  141. package/src/view/attributeelement.d.ts +108 -108
  142. package/src/view/attributeelement.js +184 -184
  143. package/src/view/containerelement.d.ts +49 -49
  144. package/src/view/containerelement.js +80 -80
  145. package/src/view/datatransfer.d.ts +79 -79
  146. package/src/view/datatransfer.js +98 -98
  147. package/src/view/document.d.ts +184 -184
  148. package/src/view/document.js +120 -120
  149. package/src/view/documentfragment.d.ts +149 -149
  150. package/src/view/documentfragment.js +228 -228
  151. package/src/view/documentselection.d.ts +306 -306
  152. package/src/view/documentselection.js +256 -256
  153. package/src/view/domconverter.d.ts +640 -640
  154. package/src/view/domconverter.js +1450 -1425
  155. package/src/view/downcastwriter.d.ts +996 -996
  156. package/src/view/downcastwriter.js +1696 -1696
  157. package/src/view/editableelement.d.ts +62 -62
  158. package/src/view/editableelement.js +62 -62
  159. package/src/view/element.d.ts +468 -468
  160. package/src/view/element.js +724 -724
  161. package/src/view/elementdefinition.d.ts +87 -87
  162. package/src/view/elementdefinition.js +5 -5
  163. package/src/view/emptyelement.d.ts +41 -41
  164. package/src/view/emptyelement.js +73 -73
  165. package/src/view/filler.d.ts +111 -111
  166. package/src/view/filler.js +150 -150
  167. package/src/view/item.d.ts +14 -14
  168. package/src/view/item.js +5 -5
  169. package/src/view/matcher.d.ts +486 -486
  170. package/src/view/matcher.js +507 -507
  171. package/src/view/node.d.ts +163 -163
  172. package/src/view/node.js +228 -228
  173. package/src/view/observer/arrowkeysobserver.d.ts +45 -45
  174. package/src/view/observer/arrowkeysobserver.js +40 -40
  175. package/src/view/observer/bubblingemittermixin.d.ts +166 -166
  176. package/src/view/observer/bubblingemittermixin.js +172 -172
  177. package/src/view/observer/bubblingeventinfo.d.ts +47 -47
  178. package/src/view/observer/bubblingeventinfo.js +37 -37
  179. package/src/view/observer/clickobserver.d.ts +43 -43
  180. package/src/view/observer/clickobserver.js +29 -29
  181. package/src/view/observer/compositionobserver.d.ts +82 -82
  182. package/src/view/observer/compositionobserver.js +60 -60
  183. package/src/view/observer/domeventdata.d.ts +50 -50
  184. package/src/view/observer/domeventdata.js +47 -47
  185. package/src/view/observer/domeventobserver.d.ts +73 -73
  186. package/src/view/observer/domeventobserver.js +79 -79
  187. package/src/view/observer/fakeselectionobserver.d.ts +47 -47
  188. package/src/view/observer/fakeselectionobserver.js +91 -91
  189. package/src/view/observer/focusobserver.d.ts +82 -82
  190. package/src/view/observer/focusobserver.js +86 -86
  191. package/src/view/observer/inputobserver.d.ts +86 -86
  192. package/src/view/observer/inputobserver.js +164 -164
  193. package/src/view/observer/keyobserver.d.ts +66 -66
  194. package/src/view/observer/keyobserver.js +39 -39
  195. package/src/view/observer/mouseobserver.d.ts +89 -89
  196. package/src/view/observer/mouseobserver.js +29 -29
  197. package/src/view/observer/mutationobserver.d.ts +86 -86
  198. package/src/view/observer/mutationobserver.js +206 -206
  199. package/src/view/observer/observer.d.ts +89 -89
  200. package/src/view/observer/observer.js +84 -84
  201. package/src/view/observer/selectionobserver.d.ts +148 -148
  202. package/src/view/observer/selectionobserver.js +202 -202
  203. package/src/view/observer/tabobserver.d.ts +46 -46
  204. package/src/view/observer/tabobserver.js +42 -42
  205. package/src/view/placeholder.d.ts +96 -96
  206. package/src/view/placeholder.js +267 -267
  207. package/src/view/position.d.ts +189 -189
  208. package/src/view/position.js +324 -324
  209. package/src/view/range.d.ts +279 -279
  210. package/src/view/range.js +430 -430
  211. package/src/view/rawelement.d.ts +73 -73
  212. package/src/view/rawelement.js +105 -105
  213. package/src/view/renderer.d.ts +265 -265
  214. package/src/view/renderer.js +999 -999
  215. package/src/view/rooteditableelement.d.ts +41 -41
  216. package/src/view/rooteditableelement.js +69 -69
  217. package/src/view/selection.d.ts +375 -375
  218. package/src/view/selection.js +559 -559
  219. package/src/view/styles/background.d.ts +33 -33
  220. package/src/view/styles/background.js +74 -74
  221. package/src/view/styles/border.d.ts +43 -43
  222. package/src/view/styles/border.js +316 -316
  223. package/src/view/styles/margin.d.ts +29 -29
  224. package/src/view/styles/margin.js +34 -34
  225. package/src/view/styles/padding.d.ts +29 -29
  226. package/src/view/styles/padding.js +34 -34
  227. package/src/view/styles/utils.d.ts +93 -93
  228. package/src/view/styles/utils.js +219 -219
  229. package/src/view/stylesmap.d.ts +675 -675
  230. package/src/view/stylesmap.js +766 -766
  231. package/src/view/text.d.ts +74 -74
  232. package/src/view/text.js +93 -93
  233. package/src/view/textproxy.d.ts +97 -97
  234. package/src/view/textproxy.js +124 -124
  235. package/src/view/treewalker.d.ts +195 -195
  236. package/src/view/treewalker.js +327 -327
  237. package/src/view/typecheckable.d.ts +448 -448
  238. package/src/view/typecheckable.js +19 -19
  239. package/src/view/uielement.d.ts +96 -96
  240. package/src/view/uielement.js +182 -182
  241. package/src/view/upcastwriter.d.ts +417 -417
  242. package/src/view/upcastwriter.js +359 -359
  243. package/src/view/view.d.ts +487 -487
  244. package/src/view/view.js +546 -546
@@ -1,19 +1,19 @@
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/typecheckable
7
- */
8
- export default class TypeCheckable {
9
- /* istanbul ignore next -- @preserve */
10
- is() {
11
- // There are a lot of overloads above.
12
- // Overriding method in derived classes remove them and only `is( type: string ): boolean` is visible which we don't want.
13
- // One option would be to copy them all to all classes, but that's ugly.
14
- // It's best when TypeScript compiler doesn't see those overloads, except the one in the top base class.
15
- // To overload a method, but not let the compiler see it, do after class definition:
16
- // `MyClass.prototype.is = function( type: string ) {...}`
17
- throw new Error('is() method is abstract');
18
- }
19
- }
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/typecheckable
7
+ */
8
+ export default class TypeCheckable {
9
+ /* istanbul ignore next -- @preserve */
10
+ is() {
11
+ // There are a lot of overloads above.
12
+ // Overriding method in derived classes remove them and only `is( type: string ): boolean` is visible which we don't want.
13
+ // One option would be to copy them all to all classes, but that's ugly.
14
+ // It's best when TypeScript compiler doesn't see those overloads, except the one in the top base class.
15
+ // To overload a method, but not let the compiler see it, do after class definition:
16
+ // `MyClass.prototype.is = function( type: string ) {...}`
17
+ throw new Error('is() method is abstract');
18
+ }
19
+ }
@@ -1,96 +1,96 @@
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/uielement
7
- */
8
- import Element, { type ElementAttributes } from './element';
9
- import Node from './node';
10
- import type View from './view';
11
- import type Document from './document';
12
- import type DomConverter from './domconverter';
13
- import type Item from './item';
14
- type DomDocument = globalThis.Document;
15
- type DomElement = globalThis.HTMLElement;
16
- /**
17
- * UI element class. It should be used to represent editing UI which needs to be injected into the editing view
18
- * If possible, you should keep your UI outside the editing view. However, if that is not possible,
19
- * UI elements can be used.
20
- *
21
- * How a UI element is rendered is in your control (you pass a callback to
22
- * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`}).
23
- * The editor will ignore your UI element – the selection cannot be placed in it, it is skipped (invisible) when
24
- * the user modifies the selection by using arrow keys and the editor does not listen to any mutations which
25
- * happen inside your UI elements.
26
- *
27
- * The limitation is that you cannot convert a model element to a UI element. UI elements need to be
28
- * created for {@link module:engine/model/markercollection~Marker markers} or as additinal elements
29
- * inside normal {@link module:engine/view/containerelement~ContainerElement container elements}.
30
- *
31
- * To create a new UI element use the
32
- * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`} method.
33
- */
34
- export default class UIElement extends Element {
35
- /**
36
- * Creates new instance of UIElement.
37
- *
38
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` when third parameter is passed,
39
- * to inform that usage of UIElement is incorrect (adding child nodes to UIElement is forbidden).
40
- *
41
- * @see module:engine/view/downcastwriter~DowncastWriter#createUIElement
42
- * @internal
43
- * @param document The document instance to which this element belongs.
44
- * @param name Node name.
45
- * @param attrs Collection of attributes.
46
- * @param children A list of nodes to be inserted into created element.
47
- */
48
- constructor(document: Document, name: string, attrs?: ElementAttributes, children?: Node | Iterable<Node>);
49
- /**
50
- * Overrides {@link module:engine/view/element~Element#_insertChild} method.
51
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` to prevent adding any child nodes
52
- * to UIElement.
53
- *
54
- * @internal
55
- */
56
- _insertChild(index: number, items: Item | Iterable<Item>): number;
57
- /**
58
- * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
59
- * {@link module:engine/view/domconverter~DomConverter}.
60
- * Do not use inheritance to create custom rendering method, replace `render()` method instead:
61
- *
62
- * ```ts
63
- * const myUIElement = downcastWriter.createUIElement( 'span' );
64
- * myUIElement.render = function( domDocument, domConverter ) {
65
- * const domElement = this.toDomElement( domDocument );
66
- *
67
- * domConverter.setContentOf( domElement, '<b>this is ui element</b>' );
68
- *
69
- * return domElement;
70
- * };
71
- * ```
72
- *
73
- * If changes in your UI element should trigger some editor UI update you should call
74
- * the {@link module:ui/editorui/editorui~EditorUI#update `editor.ui.update()`} method
75
- * after rendering your UI element.
76
- *
77
- * @param domConverter Instance of the DomConverter used to optimize the output.
78
- */
79
- render(domDocument: DomDocument, domConverter: DomConverter): DomElement;
80
- /**
81
- * Creates DOM element based on this view UIElement.
82
- * Note that each time this method is called new DOM element is created.
83
- */
84
- toDomElement(domDocument: DomDocument): DomElement;
85
- }
86
- /**
87
- * This function injects UI element handling to the given {@link module:engine/view/document~Document document}.
88
- *
89
- * A callback is added to {@link module:engine/view/document~Document#event:keydown document keydown event}.
90
- * The callback handles the situation when right arrow key is pressed and selection is collapsed before a UI element.
91
- * Without this handler, it would be impossible to "jump over" UI element using right arrow key.
92
- *
93
- * @param view View controller to which the quirks handling will be injected.
94
- */
95
- export declare function injectUiElementHandling(view: View): void;
96
- export {};
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/uielement
7
+ */
8
+ import Element, { type ElementAttributes } from './element';
9
+ import Node from './node';
10
+ import type View from './view';
11
+ import type Document from './document';
12
+ import type DomConverter from './domconverter';
13
+ import type Item from './item';
14
+ type DomDocument = globalThis.Document;
15
+ type DomElement = globalThis.HTMLElement;
16
+ /**
17
+ * UI element class. It should be used to represent editing UI which needs to be injected into the editing view
18
+ * If possible, you should keep your UI outside the editing view. However, if that is not possible,
19
+ * UI elements can be used.
20
+ *
21
+ * How a UI element is rendered is in your control (you pass a callback to
22
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`}).
23
+ * The editor will ignore your UI element – the selection cannot be placed in it, it is skipped (invisible) when
24
+ * the user modifies the selection by using arrow keys and the editor does not listen to any mutations which
25
+ * happen inside your UI elements.
26
+ *
27
+ * The limitation is that you cannot convert a model element to a UI element. UI elements need to be
28
+ * created for {@link module:engine/model/markercollection~Marker markers} or as additinal elements
29
+ * inside normal {@link module:engine/view/containerelement~ContainerElement container elements}.
30
+ *
31
+ * To create a new UI element use the
32
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`} method.
33
+ */
34
+ export default class UIElement extends Element {
35
+ /**
36
+ * Creates new instance of UIElement.
37
+ *
38
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` when third parameter is passed,
39
+ * to inform that usage of UIElement is incorrect (adding child nodes to UIElement is forbidden).
40
+ *
41
+ * @see module:engine/view/downcastwriter~DowncastWriter#createUIElement
42
+ * @internal
43
+ * @param document The document instance to which this element belongs.
44
+ * @param name Node name.
45
+ * @param attrs Collection of attributes.
46
+ * @param children A list of nodes to be inserted into created element.
47
+ */
48
+ constructor(document: Document, name: string, attrs?: ElementAttributes, children?: Node | Iterable<Node>);
49
+ /**
50
+ * Overrides {@link module:engine/view/element~Element#_insertChild} method.
51
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` to prevent adding any child nodes
52
+ * to UIElement.
53
+ *
54
+ * @internal
55
+ */
56
+ _insertChild(index: number, items: Item | Iterable<Item>): number;
57
+ /**
58
+ * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
59
+ * {@link module:engine/view/domconverter~DomConverter}.
60
+ * Do not use inheritance to create custom rendering method, replace `render()` method instead:
61
+ *
62
+ * ```ts
63
+ * const myUIElement = downcastWriter.createUIElement( 'span' );
64
+ * myUIElement.render = function( domDocument, domConverter ) {
65
+ * const domElement = this.toDomElement( domDocument );
66
+ *
67
+ * domConverter.setContentOf( domElement, '<b>this is ui element</b>' );
68
+ *
69
+ * return domElement;
70
+ * };
71
+ * ```
72
+ *
73
+ * If changes in your UI element should trigger some editor UI update you should call
74
+ * the {@link module:ui/editorui/editorui~EditorUI#update `editor.ui.update()`} method
75
+ * after rendering your UI element.
76
+ *
77
+ * @param domConverter Instance of the DomConverter used to optimize the output.
78
+ */
79
+ render(domDocument: DomDocument, domConverter: DomConverter): DomElement;
80
+ /**
81
+ * Creates DOM element based on this view UIElement.
82
+ * Note that each time this method is called new DOM element is created.
83
+ */
84
+ toDomElement(domDocument: DomDocument): DomElement;
85
+ }
86
+ /**
87
+ * This function injects UI element handling to the given {@link module:engine/view/document~Document document}.
88
+ *
89
+ * A callback is added to {@link module:engine/view/document~Document#event:keydown document keydown event}.
90
+ * The callback handles the situation when right arrow key is pressed and selection is collapsed before a UI element.
91
+ * Without this handler, it would be impossible to "jump over" UI element using right arrow key.
92
+ *
93
+ * @param view View controller to which the quirks handling will be injected.
94
+ */
95
+ export declare function injectUiElementHandling(view: View): void;
96
+ export {};
@@ -1,182 +1,182 @@
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/uielement
7
- */
8
- import Element from './element';
9
- import Node from './node';
10
- import { CKEditorError, keyCodes } from '@ckeditor/ckeditor5-utils';
11
- /**
12
- * UI element class. It should be used to represent editing UI which needs to be injected into the editing view
13
- * If possible, you should keep your UI outside the editing view. However, if that is not possible,
14
- * UI elements can be used.
15
- *
16
- * How a UI element is rendered is in your control (you pass a callback to
17
- * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`}).
18
- * The editor will ignore your UI element – the selection cannot be placed in it, it is skipped (invisible) when
19
- * the user modifies the selection by using arrow keys and the editor does not listen to any mutations which
20
- * happen inside your UI elements.
21
- *
22
- * The limitation is that you cannot convert a model element to a UI element. UI elements need to be
23
- * created for {@link module:engine/model/markercollection~Marker markers} or as additinal elements
24
- * inside normal {@link module:engine/view/containerelement~ContainerElement container elements}.
25
- *
26
- * To create a new UI element use the
27
- * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`} method.
28
- */
29
- export default class UIElement extends Element {
30
- /**
31
- * Creates new instance of UIElement.
32
- *
33
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` when third parameter is passed,
34
- * to inform that usage of UIElement is incorrect (adding child nodes to UIElement is forbidden).
35
- *
36
- * @see module:engine/view/downcastwriter~DowncastWriter#createUIElement
37
- * @internal
38
- * @param document The document instance to which this element belongs.
39
- * @param name Node name.
40
- * @param attrs Collection of attributes.
41
- * @param children A list of nodes to be inserted into created element.
42
- */
43
- constructor(document, name, attrs, children) {
44
- super(document, name, attrs, children);
45
- this.getFillerOffset = getFillerOffset;
46
- }
47
- /**
48
- * Overrides {@link module:engine/view/element~Element#_insertChild} method.
49
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` to prevent adding any child nodes
50
- * to UIElement.
51
- *
52
- * @internal
53
- */
54
- _insertChild(index, items) {
55
- if (items && (items instanceof Node || Array.from(items).length > 0)) {
56
- /**
57
- * Cannot add children to {@link module:engine/view/uielement~UIElement}.
58
- *
59
- * @error view-uielement-cannot-add
60
- */
61
- throw new CKEditorError('view-uielement-cannot-add', [this, items]);
62
- }
63
- return 0;
64
- }
65
- /**
66
- * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
67
- * {@link module:engine/view/domconverter~DomConverter}.
68
- * Do not use inheritance to create custom rendering method, replace `render()` method instead:
69
- *
70
- * ```ts
71
- * const myUIElement = downcastWriter.createUIElement( 'span' );
72
- * myUIElement.render = function( domDocument, domConverter ) {
73
- * const domElement = this.toDomElement( domDocument );
74
- *
75
- * domConverter.setContentOf( domElement, '<b>this is ui element</b>' );
76
- *
77
- * return domElement;
78
- * };
79
- * ```
80
- *
81
- * If changes in your UI element should trigger some editor UI update you should call
82
- * the {@link module:ui/editorui/editorui~EditorUI#update `editor.ui.update()`} method
83
- * after rendering your UI element.
84
- *
85
- * @param domConverter Instance of the DomConverter used to optimize the output.
86
- */
87
- render(domDocument, domConverter) {
88
- // Provide basic, default output.
89
- return this.toDomElement(domDocument);
90
- }
91
- /**
92
- * Creates DOM element based on this view UIElement.
93
- * Note that each time this method is called new DOM element is created.
94
- */
95
- toDomElement(domDocument) {
96
- const domElement = domDocument.createElement(this.name);
97
- for (const key of this.getAttributeKeys()) {
98
- domElement.setAttribute(key, this.getAttribute(key));
99
- }
100
- return domElement;
101
- }
102
- }
103
- // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
104
- // Proper overload would interfere with that.
105
- UIElement.prototype.is = function (type, name) {
106
- if (!name) {
107
- return type === 'uiElement' || type === 'view:uiElement' ||
108
- // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
109
- type === 'element' || type === 'view:element' ||
110
- type === 'node' || type === 'view:node';
111
- }
112
- else {
113
- return name === this.name && (type === 'uiElement' || type === 'view:uiElement' ||
114
- type === 'element' || type === 'view:element');
115
- }
116
- };
117
- /**
118
- * This function injects UI element handling to the given {@link module:engine/view/document~Document document}.
119
- *
120
- * A callback is added to {@link module:engine/view/document~Document#event:keydown document keydown event}.
121
- * The callback handles the situation when right arrow key is pressed and selection is collapsed before a UI element.
122
- * Without this handler, it would be impossible to "jump over" UI element using right arrow key.
123
- *
124
- * @param view View controller to which the quirks handling will be injected.
125
- */
126
- export function injectUiElementHandling(view) {
127
- view.document.on('arrowKey', (evt, data) => jumpOverUiElement(evt, data, view.domConverter), { priority: 'low' });
128
- }
129
- /**
130
- * Returns `null` because block filler is not needed for UIElements.
131
- */
132
- function getFillerOffset() {
133
- return null;
134
- }
135
- /**
136
- * Selection cannot be placed in a `UIElement`. Whenever it is placed there, it is moved before it. This
137
- * causes a situation when it is impossible to jump over `UIElement` using right arrow key, because the selection
138
- * ends up in ui element (in DOM) and is moved back to the left. This handler fixes this situation.
139
- */
140
- function jumpOverUiElement(evt, data, domConverter) {
141
- if (data.keyCode == keyCodes.arrowright) {
142
- const domSelection = data.domTarget.ownerDocument.defaultView.getSelection();
143
- const domSelectionCollapsed = domSelection.rangeCount == 1 && domSelection.getRangeAt(0).collapsed;
144
- // Jump over UI element if selection is collapsed or shift key is pressed. These are the cases when selection would extend.
145
- if (domSelectionCollapsed || data.shiftKey) {
146
- const domParent = domSelection.focusNode;
147
- const domOffset = domSelection.focusOffset;
148
- const viewPosition = domConverter.domPositionToView(domParent, domOffset);
149
- // In case if dom element is not converted to view or is not mapped or something. Happens for example in some tests.
150
- if (viewPosition === null) {
151
- return;
152
- }
153
- // Skip all following ui elements.
154
- let jumpedOverAnyUiElement = false;
155
- const nextViewPosition = viewPosition.getLastMatchingPosition(value => {
156
- if (value.item.is('uiElement')) {
157
- // Remember that there was at least one ui element.
158
- jumpedOverAnyUiElement = true;
159
- }
160
- // Jump over ui elements, jump over empty attribute elements, move up from inside of attribute element.
161
- if (value.item.is('uiElement') || value.item.is('attributeElement')) {
162
- return true;
163
- }
164
- // Don't jump over text or don't get out of container element.
165
- return false;
166
- });
167
- // If anything has been skipped, fix position.
168
- // This `if` could be possibly omitted but maybe it is better not to mess with DOM selection if not needed.
169
- if (jumpedOverAnyUiElement) {
170
- const newDomPosition = domConverter.viewPositionToDom(nextViewPosition);
171
- if (domSelectionCollapsed) {
172
- // Selection was collapsed, so collapse it at further position.
173
- domSelection.collapse(newDomPosition.parent, newDomPosition.offset);
174
- }
175
- else {
176
- // Selection was not collapse, so extend it instead of collapsing.
177
- domSelection.extend(newDomPosition.parent, newDomPosition.offset);
178
- }
179
- }
180
- }
181
- }
182
- }
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/uielement
7
+ */
8
+ import Element from './element';
9
+ import Node from './node';
10
+ import { CKEditorError, keyCodes } from '@ckeditor/ckeditor5-utils';
11
+ /**
12
+ * UI element class. It should be used to represent editing UI which needs to be injected into the editing view
13
+ * If possible, you should keep your UI outside the editing view. However, if that is not possible,
14
+ * UI elements can be used.
15
+ *
16
+ * How a UI element is rendered is in your control (you pass a callback to
17
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`}).
18
+ * The editor will ignore your UI element – the selection cannot be placed in it, it is skipped (invisible) when
19
+ * the user modifies the selection by using arrow keys and the editor does not listen to any mutations which
20
+ * happen inside your UI elements.
21
+ *
22
+ * The limitation is that you cannot convert a model element to a UI element. UI elements need to be
23
+ * created for {@link module:engine/model/markercollection~Marker markers} or as additinal elements
24
+ * inside normal {@link module:engine/view/containerelement~ContainerElement container elements}.
25
+ *
26
+ * To create a new UI element use the
27
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `downcastWriter#createUIElement()`} method.
28
+ */
29
+ export default class UIElement extends Element {
30
+ /**
31
+ * Creates new instance of UIElement.
32
+ *
33
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` when third parameter is passed,
34
+ * to inform that usage of UIElement is incorrect (adding child nodes to UIElement is forbidden).
35
+ *
36
+ * @see module:engine/view/downcastwriter~DowncastWriter#createUIElement
37
+ * @internal
38
+ * @param document The document instance to which this element belongs.
39
+ * @param name Node name.
40
+ * @param attrs Collection of attributes.
41
+ * @param children A list of nodes to be inserted into created element.
42
+ */
43
+ constructor(document, name, attrs, children) {
44
+ super(document, name, attrs, children);
45
+ this.getFillerOffset = getFillerOffset;
46
+ }
47
+ /**
48
+ * Overrides {@link module:engine/view/element~Element#_insertChild} method.
49
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-uielement-cannot-add` to prevent adding any child nodes
50
+ * to UIElement.
51
+ *
52
+ * @internal
53
+ */
54
+ _insertChild(index, items) {
55
+ if (items && (items instanceof Node || Array.from(items).length > 0)) {
56
+ /**
57
+ * Cannot add children to {@link module:engine/view/uielement~UIElement}.
58
+ *
59
+ * @error view-uielement-cannot-add
60
+ */
61
+ throw new CKEditorError('view-uielement-cannot-add', [this, items]);
62
+ }
63
+ return 0;
64
+ }
65
+ /**
66
+ * Renders this {@link module:engine/view/uielement~UIElement} to DOM. This method is called by
67
+ * {@link module:engine/view/domconverter~DomConverter}.
68
+ * Do not use inheritance to create custom rendering method, replace `render()` method instead:
69
+ *
70
+ * ```ts
71
+ * const myUIElement = downcastWriter.createUIElement( 'span' );
72
+ * myUIElement.render = function( domDocument, domConverter ) {
73
+ * const domElement = this.toDomElement( domDocument );
74
+ *
75
+ * domConverter.setContentOf( domElement, '<b>this is ui element</b>' );
76
+ *
77
+ * return domElement;
78
+ * };
79
+ * ```
80
+ *
81
+ * If changes in your UI element should trigger some editor UI update you should call
82
+ * the {@link module:ui/editorui/editorui~EditorUI#update `editor.ui.update()`} method
83
+ * after rendering your UI element.
84
+ *
85
+ * @param domConverter Instance of the DomConverter used to optimize the output.
86
+ */
87
+ render(domDocument, domConverter) {
88
+ // Provide basic, default output.
89
+ return this.toDomElement(domDocument);
90
+ }
91
+ /**
92
+ * Creates DOM element based on this view UIElement.
93
+ * Note that each time this method is called new DOM element is created.
94
+ */
95
+ toDomElement(domDocument) {
96
+ const domElement = domDocument.createElement(this.name);
97
+ for (const key of this.getAttributeKeys()) {
98
+ domElement.setAttribute(key, this.getAttribute(key));
99
+ }
100
+ return domElement;
101
+ }
102
+ }
103
+ // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
104
+ // Proper overload would interfere with that.
105
+ UIElement.prototype.is = function (type, name) {
106
+ if (!name) {
107
+ return type === 'uiElement' || type === 'view:uiElement' ||
108
+ // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
109
+ type === 'element' || type === 'view:element' ||
110
+ type === 'node' || type === 'view:node';
111
+ }
112
+ else {
113
+ return name === this.name && (type === 'uiElement' || type === 'view:uiElement' ||
114
+ type === 'element' || type === 'view:element');
115
+ }
116
+ };
117
+ /**
118
+ * This function injects UI element handling to the given {@link module:engine/view/document~Document document}.
119
+ *
120
+ * A callback is added to {@link module:engine/view/document~Document#event:keydown document keydown event}.
121
+ * The callback handles the situation when right arrow key is pressed and selection is collapsed before a UI element.
122
+ * Without this handler, it would be impossible to "jump over" UI element using right arrow key.
123
+ *
124
+ * @param view View controller to which the quirks handling will be injected.
125
+ */
126
+ export function injectUiElementHandling(view) {
127
+ view.document.on('arrowKey', (evt, data) => jumpOverUiElement(evt, data, view.domConverter), { priority: 'low' });
128
+ }
129
+ /**
130
+ * Returns `null` because block filler is not needed for UIElements.
131
+ */
132
+ function getFillerOffset() {
133
+ return null;
134
+ }
135
+ /**
136
+ * Selection cannot be placed in a `UIElement`. Whenever it is placed there, it is moved before it. This
137
+ * causes a situation when it is impossible to jump over `UIElement` using right arrow key, because the selection
138
+ * ends up in ui element (in DOM) and is moved back to the left. This handler fixes this situation.
139
+ */
140
+ function jumpOverUiElement(evt, data, domConverter) {
141
+ if (data.keyCode == keyCodes.arrowright) {
142
+ const domSelection = data.domTarget.ownerDocument.defaultView.getSelection();
143
+ const domSelectionCollapsed = domSelection.rangeCount == 1 && domSelection.getRangeAt(0).collapsed;
144
+ // Jump over UI element if selection is collapsed or shift key is pressed. These are the cases when selection would extend.
145
+ if (domSelectionCollapsed || data.shiftKey) {
146
+ const domParent = domSelection.focusNode;
147
+ const domOffset = domSelection.focusOffset;
148
+ const viewPosition = domConverter.domPositionToView(domParent, domOffset);
149
+ // In case if dom element is not converted to view or is not mapped or something. Happens for example in some tests.
150
+ if (viewPosition === null) {
151
+ return;
152
+ }
153
+ // Skip all following ui elements.
154
+ let jumpedOverAnyUiElement = false;
155
+ const nextViewPosition = viewPosition.getLastMatchingPosition(value => {
156
+ if (value.item.is('uiElement')) {
157
+ // Remember that there was at least one ui element.
158
+ jumpedOverAnyUiElement = true;
159
+ }
160
+ // Jump over ui elements, jump over empty attribute elements, move up from inside of attribute element.
161
+ if (value.item.is('uiElement') || value.item.is('attributeElement')) {
162
+ return true;
163
+ }
164
+ // Don't jump over text or don't get out of container element.
165
+ return false;
166
+ });
167
+ // If anything has been skipped, fix position.
168
+ // This `if` could be possibly omitted but maybe it is better not to mess with DOM selection if not needed.
169
+ if (jumpedOverAnyUiElement) {
170
+ const newDomPosition = domConverter.viewPositionToDom(nextViewPosition);
171
+ if (domSelectionCollapsed) {
172
+ // Selection was collapsed, so collapse it at further position.
173
+ domSelection.collapse(newDomPosition.parent, newDomPosition.offset);
174
+ }
175
+ else {
176
+ // Selection was not collapse, so extend it instead of collapsing.
177
+ domSelection.extend(newDomPosition.parent, newDomPosition.offset);
178
+ }
179
+ }
180
+ }
181
+ }
182
+ }