@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,87 +1,87 @@
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/elementdefinition
7
- */
8
- import type { ArrayOrItem } from '@ckeditor/ckeditor5-utils';
9
- /**
10
- * A plain object that describes a view element in a way that a concrete, exact view element could be created from that description.
11
- *
12
- * ```ts
13
- * const viewDefinition = {
14
- * name: 'h1',
15
- * classes: [ 'foo', 'bar' ]
16
- * };
17
- * ```
18
- *
19
- * Above describes a view element:
20
- *
21
- * ```html
22
- * <h1 class="foo bar"></h1>
23
- * ```
24
- *
25
- * An example with styles and attributes:
26
- *
27
- * ```ts
28
- * const viewDefinition = {
29
- * name: 'span',
30
- * styles: {
31
- * 'font-size': '12px',
32
- * 'font-weight': 'bold'
33
- * },
34
- * attributes: {
35
- * 'data-id': '123'
36
- * }
37
- * };
38
- * ```
39
- *
40
- * Describes:
41
- *
42
- * ```ts
43
- * <span style="font-size:12px;font-weight:bold" data-id="123"></span>
44
- * ```
45
- */
46
- export interface ElementObjectDefinition {
47
- /**
48
- * View element name.
49
- */
50
- name: string;
51
- /**
52
- * Class name or array of class names to match. Each name can be provided in a form of string.
53
- */
54
- classes?: ArrayOrItem<string>;
55
- /**
56
- * Object with key-value pairs representing styles. Each object key represents style name. Value under that key must be a string.
57
- */
58
- styles?: Record<string, string>;
59
- /**
60
- * Object with key-value pairs representing attributes. Each object key represents attribute name.
61
- * Value under that key must be a string.
62
- */
63
- attributes?: Record<string, string>;
64
- /**
65
- * Element's {@link module:engine/view/attributeelement~AttributeElement#priority priority}.
66
- */
67
- priority?: number;
68
- }
69
- /**
70
- * A plain object that describes a view element or element name.
71
- *
72
- * Elements without attributes can be given simply as a string:
73
- *
74
- * ```ts
75
- * const viewDefinition = 'p';
76
- * ```
77
- *
78
- * Which will be treated as:
79
- *
80
- * ```ts
81
- * const viewDefinition = {
82
- * name: 'p'
83
- * };
84
- * ```
85
- */
86
- type ElementDefinition = string | ElementObjectDefinition;
87
- export default ElementDefinition;
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/elementdefinition
7
+ */
8
+ import type { ArrayOrItem } from '@ckeditor/ckeditor5-utils';
9
+ /**
10
+ * A plain object that describes a view element in a way that a concrete, exact view element could be created from that description.
11
+ *
12
+ * ```ts
13
+ * const viewDefinition = {
14
+ * name: 'h1',
15
+ * classes: [ 'foo', 'bar' ]
16
+ * };
17
+ * ```
18
+ *
19
+ * Above describes a view element:
20
+ *
21
+ * ```html
22
+ * <h1 class="foo bar"></h1>
23
+ * ```
24
+ *
25
+ * An example with styles and attributes:
26
+ *
27
+ * ```ts
28
+ * const viewDefinition = {
29
+ * name: 'span',
30
+ * styles: {
31
+ * 'font-size': '12px',
32
+ * 'font-weight': 'bold'
33
+ * },
34
+ * attributes: {
35
+ * 'data-id': '123'
36
+ * }
37
+ * };
38
+ * ```
39
+ *
40
+ * Describes:
41
+ *
42
+ * ```ts
43
+ * <span style="font-size:12px;font-weight:bold" data-id="123"></span>
44
+ * ```
45
+ */
46
+ export interface ElementObjectDefinition {
47
+ /**
48
+ * View element name.
49
+ */
50
+ name: string;
51
+ /**
52
+ * Class name or array of class names to match. Each name can be provided in a form of string.
53
+ */
54
+ classes?: ArrayOrItem<string>;
55
+ /**
56
+ * Object with key-value pairs representing styles. Each object key represents style name. Value under that key must be a string.
57
+ */
58
+ styles?: Record<string, string>;
59
+ /**
60
+ * Object with key-value pairs representing attributes. Each object key represents attribute name.
61
+ * Value under that key must be a string.
62
+ */
63
+ attributes?: Record<string, string>;
64
+ /**
65
+ * Element's {@link module:engine/view/attributeelement~AttributeElement#priority priority}.
66
+ */
67
+ priority?: number;
68
+ }
69
+ /**
70
+ * A plain object that describes a view element or element name.
71
+ *
72
+ * Elements without attributes can be given simply as a string:
73
+ *
74
+ * ```ts
75
+ * const viewDefinition = 'p';
76
+ * ```
77
+ *
78
+ * Which will be treated as:
79
+ *
80
+ * ```ts
81
+ * const viewDefinition = {
82
+ * name: 'p'
83
+ * };
84
+ * ```
85
+ */
86
+ type ElementDefinition = string | ElementObjectDefinition;
87
+ export default ElementDefinition;
@@ -1,5 +1,5 @@
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
- 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
+ export {};
@@ -1,41 +1,41 @@
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/emptyelement
7
- */
8
- import Element, { type ElementAttributes } from './element';
9
- import Node from './node';
10
- import type Document from './document';
11
- import type Item from './item';
12
- /**
13
- * Empty element class. It is used to represent elements that cannot contain any child nodes (for example `<img>` elements).
14
- *
15
- * To create a new empty element use the
16
- * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement `downcastWriter#createEmptyElement()`} method.
17
- */
18
- export default class EmptyElement extends Element {
19
- /**
20
- * Creates new instance of EmptyElement.
21
- *
22
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
23
- * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
24
- *
25
- * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
26
- * @internal
27
- * @param document The document instance to which this element belongs.
28
- * @param name Node name.
29
- * @param attrs Collection of attributes.
30
- * @param children A list of nodes to be inserted into created element.
31
- */
32
- constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);
33
- /**
34
- * Overrides {@link module:engine/view/element~Element#_insertChild} method.
35
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
36
- * adding any child nodes to EmptyElement.
37
- *
38
- * @internal
39
- */
40
- _insertChild(index: number, items: Item | Iterable<Item>): number;
41
- }
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/emptyelement
7
+ */
8
+ import Element, { type ElementAttributes } from './element';
9
+ import Node from './node';
10
+ import type Document from './document';
11
+ import type Item from './item';
12
+ /**
13
+ * Empty element class. It is used to represent elements that cannot contain any child nodes (for example `<img>` elements).
14
+ *
15
+ * To create a new empty element use the
16
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement `downcastWriter#createEmptyElement()`} method.
17
+ */
18
+ export default class EmptyElement extends Element {
19
+ /**
20
+ * Creates new instance of EmptyElement.
21
+ *
22
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
23
+ * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
24
+ *
25
+ * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
26
+ * @internal
27
+ * @param document The document instance to which this element belongs.
28
+ * @param name Node name.
29
+ * @param attrs Collection of attributes.
30
+ * @param children A list of nodes to be inserted into created element.
31
+ */
32
+ constructor(document: Document, name: string, attributes?: ElementAttributes, children?: Node | Iterable<Node>);
33
+ /**
34
+ * Overrides {@link module:engine/view/element~Element#_insertChild} method.
35
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
36
+ * adding any child nodes to EmptyElement.
37
+ *
38
+ * @internal
39
+ */
40
+ _insertChild(index: number, items: Item | Iterable<Item>): number;
41
+ }
@@ -1,73 +1,73 @@
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/emptyelement
7
- */
8
- import Element from './element';
9
- import Node from './node';
10
- import { CKEditorError } from '@ckeditor/ckeditor5-utils';
11
- /**
12
- * Empty element class. It is used to represent elements that cannot contain any child nodes (for example `<img>` elements).
13
- *
14
- * To create a new empty element use the
15
- * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement `downcastWriter#createEmptyElement()`} method.
16
- */
17
- export default class EmptyElement extends Element {
18
- /**
19
- * Creates new instance of EmptyElement.
20
- *
21
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
22
- * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
23
- *
24
- * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
25
- * @internal
26
- * @param document The document instance to which this element belongs.
27
- * @param name Node name.
28
- * @param attrs Collection of attributes.
29
- * @param children A list of nodes to be inserted into created element.
30
- */
31
- constructor(document, name, attributes, children) {
32
- super(document, name, attributes, children);
33
- this.getFillerOffset = getFillerOffset;
34
- }
35
- /**
36
- * Overrides {@link module:engine/view/element~Element#_insertChild} method.
37
- * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
38
- * adding any child nodes to EmptyElement.
39
- *
40
- * @internal
41
- */
42
- _insertChild(index, items) {
43
- if (items && (items instanceof Node || Array.from(items).length > 0)) {
44
- /**
45
- * Cannot add children to {@link module:engine/view/emptyelement~EmptyElement}.
46
- *
47
- * @error view-emptyelement-cannot-add
48
- */
49
- throw new CKEditorError('view-emptyelement-cannot-add', [this, items]);
50
- }
51
- return 0;
52
- }
53
- }
54
- // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
55
- // Proper overload would interfere with that.
56
- EmptyElement.prototype.is = function (type, name) {
57
- if (!name) {
58
- return type === 'emptyElement' || type === 'view:emptyElement' ||
59
- // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
60
- type === 'element' || type === 'view:element' ||
61
- type === 'node' || type === 'view:node';
62
- }
63
- else {
64
- return name === this.name && (type === 'emptyElement' || type === 'view:emptyElement' ||
65
- type === 'element' || type === 'view:element');
66
- }
67
- };
68
- /**
69
- * Returns `null` because block filler is not needed for EmptyElements.
70
- */
71
- function getFillerOffset() {
72
- return null;
73
- }
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/emptyelement
7
+ */
8
+ import Element from './element';
9
+ import Node from './node';
10
+ import { CKEditorError } from '@ckeditor/ckeditor5-utils';
11
+ /**
12
+ * Empty element class. It is used to represent elements that cannot contain any child nodes (for example `<img>` elements).
13
+ *
14
+ * To create a new empty element use the
15
+ * {@link module:engine/view/downcastwriter~DowncastWriter#createEmptyElement `downcastWriter#createEmptyElement()`} method.
16
+ */
17
+ export default class EmptyElement extends Element {
18
+ /**
19
+ * Creates new instance of EmptyElement.
20
+ *
21
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` when third parameter is passed,
22
+ * to inform that usage of EmptyElement is incorrect (adding child nodes to EmptyElement is forbidden).
23
+ *
24
+ * @see module:engine/view/downcastwriter~DowncastWriter#createEmptyElement
25
+ * @internal
26
+ * @param document The document instance to which this element belongs.
27
+ * @param name Node name.
28
+ * @param attrs Collection of attributes.
29
+ * @param children A list of nodes to be inserted into created element.
30
+ */
31
+ constructor(document, name, attributes, children) {
32
+ super(document, name, attributes, children);
33
+ this.getFillerOffset = getFillerOffset;
34
+ }
35
+ /**
36
+ * Overrides {@link module:engine/view/element~Element#_insertChild} method.
37
+ * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `view-emptyelement-cannot-add` to prevent
38
+ * adding any child nodes to EmptyElement.
39
+ *
40
+ * @internal
41
+ */
42
+ _insertChild(index, items) {
43
+ if (items && (items instanceof Node || Array.from(items).length > 0)) {
44
+ /**
45
+ * Cannot add children to {@link module:engine/view/emptyelement~EmptyElement}.
46
+ *
47
+ * @error view-emptyelement-cannot-add
48
+ */
49
+ throw new CKEditorError('view-emptyelement-cannot-add', [this, items]);
50
+ }
51
+ return 0;
52
+ }
53
+ }
54
+ // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
55
+ // Proper overload would interfere with that.
56
+ EmptyElement.prototype.is = function (type, name) {
57
+ if (!name) {
58
+ return type === 'emptyElement' || type === 'view:emptyElement' ||
59
+ // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
60
+ type === 'element' || type === 'view:element' ||
61
+ type === 'node' || type === 'view:node';
62
+ }
63
+ else {
64
+ return name === this.name && (type === 'emptyElement' || type === 'view:emptyElement' ||
65
+ type === 'element' || type === 'view:element');
66
+ }
67
+ };
68
+ /**
69
+ * Returns `null` because block filler is not needed for EmptyElements.
70
+ */
71
+ function getFillerOffset() {
72
+ return null;
73
+ }
@@ -1,111 +1,111 @@
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 View from './view';
6
- /**
7
- * Set of utilities related to handling block and inline fillers.
8
- *
9
- * Browsers do not allow to put caret in elements which does not have height. Because of it, we need to fill all
10
- * empty elements which should be selectable with elements or characters called "fillers". Unfortunately there is no one
11
- * universal filler, this is why two types are uses:
12
- *
13
- * * Block filler is an element which fill block elements, like `<p>`. CKEditor uses `<br>` as a block filler during the editing,
14
- * as browsers do natively. So instead of an empty `<p>` there will be `<p><br></p>`. The advantage of block filler is that
15
- * it is transparent for the selection, so when the caret is before the `<br>` and user presses right arrow he will be
16
- * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it can not be used
17
- * in the middle of a line of text. The {@link module:engine/view/filler~BR_FILLER `<br>` filler} can be replaced with any other
18
- * character in the data output, for instance {@link module:engine/view/filler~NBSP_FILLER non-breaking space} or
19
- * {@link module:engine/view/filler~MARKED_NBSP_FILLER marked non-breaking space}.
20
- *
21
- * * Inline filler is a filler which does not break a line of text, so it can be used inside the text, for instance in the empty
22
- * `<b>` surrendered by text: `foo<b></b>bar`, if we want to put the caret there. CKEditor uses a sequence of the zero-width
23
- * spaces as an {@link module:engine/view/filler~INLINE_FILLER inline filler} having the predetermined
24
- * {@link module:engine/view/filler~INLINE_FILLER_LENGTH length}. A sequence is used, instead of a single character to
25
- * avoid treating random zero-width spaces as the inline filler. Disadvantage of the inline filler is that it is not
26
- * transparent for the selection. The arrow key moves the caret between zero-width spaces characters, so the additional
27
- * code is needed to handle the caret.
28
- *
29
- * Both inline and block fillers are handled by the {@link module:engine/view/renderer~Renderer renderer} and are not present in the
30
- * view.
31
- *
32
- * @module engine/view/filler
33
- */
34
- /**
35
- * Non-breaking space filler creator. This function creates the `&nbsp;` text node.
36
- * It defines how the filler is created.
37
- *
38
- * @see module:engine/view/filler~MARKED_NBSP_FILLER
39
- * @see module:engine/view/filler~BR_FILLER
40
- */
41
- export declare const NBSP_FILLER: (domDocument: Document) => Text;
42
- /**
43
- * Marked non-breaking space filler creator. This function creates the `<span data-cke-filler="true">&nbsp;</span>` element.
44
- * It defines how the filler is created.
45
- *
46
- * @see module:engine/view/filler~NBSP_FILLER
47
- * @see module:engine/view/filler~BR_FILLER
48
- */
49
- export declare const MARKED_NBSP_FILLER: (domDocument: Document) => HTMLSpanElement;
50
- /**
51
- * `<br>` filler creator. This function creates the `<br data-cke-filler="true">` element.
52
- * It defines how the filler is created.
53
- *
54
- * @see module:engine/view/filler~NBSP_FILLER
55
- * @see module:engine/view/filler~MARKED_NBSP_FILLER
56
- */
57
- export declare const BR_FILLER: (domDocument: Document) => HTMLBRElement;
58
- /**
59
- * Length of the {@link module:engine/view/filler~INLINE_FILLER INLINE_FILLER}.
60
- */
61
- export declare const INLINE_FILLER_LENGTH = 7;
62
- /**
63
- * Inline filler which is a sequence of the word joiners.
64
- */
65
- export declare const INLINE_FILLER: string;
66
- /**
67
- * Checks if the node is a text node which starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
68
- *
69
- * ```ts
70
- * startsWithFiller( document.createTextNode( INLINE_FILLER ) ); // true
71
- * startsWithFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // true
72
- * startsWithFiller( document.createTextNode( 'foo' ) ); // false
73
- * startsWithFiller( document.createElement( 'p' ) ); // false
74
- * ```
75
- *
76
- * @param domNode DOM node.
77
- * @returns True if the text node starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
78
- */
79
- export declare function startsWithFiller(domNode: Node | string): boolean;
80
- /**
81
- * Checks if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
82
- *
83
- * ```ts
84
- * isInlineFiller( document.createTextNode( INLINE_FILLER ) ); // true
85
- * isInlineFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // false
86
- * ```
87
- *
88
- * @param domText DOM text node.
89
- * @returns True if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
90
- */
91
- export declare function isInlineFiller(domText: Text): boolean;
92
- /**
93
- * Get string data from the text node, removing an {@link module:engine/view/filler~INLINE_FILLER inline filler} from it,
94
- * if text node contains it.
95
- *
96
- * ```ts
97
- * getDataWithoutFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ) == 'foo' // true
98
- * getDataWithoutFiller( document.createTextNode( 'foo' ) ) == 'foo' // true
99
- * ```
100
- *
101
- * @param domText DOM text node, possible with inline filler.
102
- * @returns Data without filler.
103
- */
104
- export declare function getDataWithoutFiller(domText: Text | string): string;
105
- /**
106
- * Assign key observer which move cursor from the end of the inline filler to the beginning of it when
107
- * the left arrow is pressed, so the filler does not break navigation.
108
- *
109
- * @param view View controller instance we should inject quirks handling on.
110
- */
111
- export declare function injectQuirksHandling(view: View): void;
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 View from './view';
6
+ /**
7
+ * Set of utilities related to handling block and inline fillers.
8
+ *
9
+ * Browsers do not allow to put caret in elements which does not have height. Because of it, we need to fill all
10
+ * empty elements which should be selectable with elements or characters called "fillers". Unfortunately there is no one
11
+ * universal filler, this is why two types are uses:
12
+ *
13
+ * * Block filler is an element which fill block elements, like `<p>`. CKEditor uses `<br>` as a block filler during the editing,
14
+ * as browsers do natively. So instead of an empty `<p>` there will be `<p><br></p>`. The advantage of block filler is that
15
+ * it is transparent for the selection, so when the caret is before the `<br>` and user presses right arrow he will be
16
+ * moved to the next paragraph, not after the `<br>`. The disadvantage is that it breaks a block, so it can not be used
17
+ * in the middle of a line of text. The {@link module:engine/view/filler~BR_FILLER `<br>` filler} can be replaced with any other
18
+ * character in the data output, for instance {@link module:engine/view/filler~NBSP_FILLER non-breaking space} or
19
+ * {@link module:engine/view/filler~MARKED_NBSP_FILLER marked non-breaking space}.
20
+ *
21
+ * * Inline filler is a filler which does not break a line of text, so it can be used inside the text, for instance in the empty
22
+ * `<b>` surrendered by text: `foo<b></b>bar`, if we want to put the caret there. CKEditor uses a sequence of the zero-width
23
+ * spaces as an {@link module:engine/view/filler~INLINE_FILLER inline filler} having the predetermined
24
+ * {@link module:engine/view/filler~INLINE_FILLER_LENGTH length}. A sequence is used, instead of a single character to
25
+ * avoid treating random zero-width spaces as the inline filler. Disadvantage of the inline filler is that it is not
26
+ * transparent for the selection. The arrow key moves the caret between zero-width spaces characters, so the additional
27
+ * code is needed to handle the caret.
28
+ *
29
+ * Both inline and block fillers are handled by the {@link module:engine/view/renderer~Renderer renderer} and are not present in the
30
+ * view.
31
+ *
32
+ * @module engine/view/filler
33
+ */
34
+ /**
35
+ * Non-breaking space filler creator. This function creates the `&nbsp;` text node.
36
+ * It defines how the filler is created.
37
+ *
38
+ * @see module:engine/view/filler~MARKED_NBSP_FILLER
39
+ * @see module:engine/view/filler~BR_FILLER
40
+ */
41
+ export declare const NBSP_FILLER: (domDocument: Document) => Text;
42
+ /**
43
+ * Marked non-breaking space filler creator. This function creates the `<span data-cke-filler="true">&nbsp;</span>` element.
44
+ * It defines how the filler is created.
45
+ *
46
+ * @see module:engine/view/filler~NBSP_FILLER
47
+ * @see module:engine/view/filler~BR_FILLER
48
+ */
49
+ export declare const MARKED_NBSP_FILLER: (domDocument: Document) => HTMLSpanElement;
50
+ /**
51
+ * `<br>` filler creator. This function creates the `<br data-cke-filler="true">` element.
52
+ * It defines how the filler is created.
53
+ *
54
+ * @see module:engine/view/filler~NBSP_FILLER
55
+ * @see module:engine/view/filler~MARKED_NBSP_FILLER
56
+ */
57
+ export declare const BR_FILLER: (domDocument: Document) => HTMLBRElement;
58
+ /**
59
+ * Length of the {@link module:engine/view/filler~INLINE_FILLER INLINE_FILLER}.
60
+ */
61
+ export declare const INLINE_FILLER_LENGTH = 7;
62
+ /**
63
+ * Inline filler which is a sequence of the word joiners.
64
+ */
65
+ export declare const INLINE_FILLER: string;
66
+ /**
67
+ * Checks if the node is a text node which starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
68
+ *
69
+ * ```ts
70
+ * startsWithFiller( document.createTextNode( INLINE_FILLER ) ); // true
71
+ * startsWithFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // true
72
+ * startsWithFiller( document.createTextNode( 'foo' ) ); // false
73
+ * startsWithFiller( document.createElement( 'p' ) ); // false
74
+ * ```
75
+ *
76
+ * @param domNode DOM node.
77
+ * @returns True if the text node starts with the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
78
+ */
79
+ export declare function startsWithFiller(domNode: Node | string): boolean;
80
+ /**
81
+ * Checks if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
82
+ *
83
+ * ```ts
84
+ * isInlineFiller( document.createTextNode( INLINE_FILLER ) ); // true
85
+ * isInlineFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ); // false
86
+ * ```
87
+ *
88
+ * @param domText DOM text node.
89
+ * @returns True if the text node contains only the {@link module:engine/view/filler~INLINE_FILLER inline filler}.
90
+ */
91
+ export declare function isInlineFiller(domText: Text): boolean;
92
+ /**
93
+ * Get string data from the text node, removing an {@link module:engine/view/filler~INLINE_FILLER inline filler} from it,
94
+ * if text node contains it.
95
+ *
96
+ * ```ts
97
+ * getDataWithoutFiller( document.createTextNode( INLINE_FILLER + 'foo' ) ) == 'foo' // true
98
+ * getDataWithoutFiller( document.createTextNode( 'foo' ) ) == 'foo' // true
99
+ * ```
100
+ *
101
+ * @param domText DOM text node, possible with inline filler.
102
+ * @returns Data without filler.
103
+ */
104
+ export declare function getDataWithoutFiller(domText: Text | string): string;
105
+ /**
106
+ * Assign key observer which move cursor from the end of the inline filler to the beginning of it when
107
+ * the left arrow is pressed, so the filler does not break navigation.
108
+ *
109
+ * @param view View controller instance we should inject quirks handling on.
110
+ */
111
+ export declare function injectQuirksHandling(view: View): void;