@ckeditor/ckeditor5-engine 38.1.0 → 38.1.1

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 (241) hide show
  1. package/package.json +2 -2
  2. package/src/controller/datacontroller.d.ts +334 -334
  3. package/src/controller/datacontroller.js +481 -481
  4. package/src/controller/editingcontroller.d.ts +98 -98
  5. package/src/controller/editingcontroller.js +191 -191
  6. package/src/conversion/conversion.d.ts +478 -478
  7. package/src/conversion/conversion.js +601 -601
  8. package/src/conversion/conversionhelpers.d.ts +26 -26
  9. package/src/conversion/conversionhelpers.js +32 -32
  10. package/src/conversion/downcastdispatcher.d.ts +547 -547
  11. package/src/conversion/downcastdispatcher.js +538 -538
  12. package/src/conversion/downcasthelpers.d.ts +1226 -1226
  13. package/src/conversion/downcasthelpers.js +2183 -2183
  14. package/src/conversion/mapper.d.ts +503 -503
  15. package/src/conversion/mapper.js +536 -536
  16. package/src/conversion/modelconsumable.d.ts +201 -201
  17. package/src/conversion/modelconsumable.js +333 -333
  18. package/src/conversion/upcastdispatcher.d.ts +492 -492
  19. package/src/conversion/upcastdispatcher.js +460 -460
  20. package/src/conversion/upcasthelpers.d.ts +499 -499
  21. package/src/conversion/upcasthelpers.js +950 -950
  22. package/src/conversion/viewconsumable.d.ts +369 -369
  23. package/src/conversion/viewconsumable.js +532 -532
  24. package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
  25. package/src/dataprocessor/basichtmlwriter.js +19 -19
  26. package/src/dataprocessor/dataprocessor.d.ts +61 -61
  27. package/src/dataprocessor/dataprocessor.js +5 -5
  28. package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
  29. package/src/dataprocessor/htmldataprocessor.js +96 -96
  30. package/src/dataprocessor/htmlwriter.d.ts +16 -16
  31. package/src/dataprocessor/htmlwriter.js +5 -5
  32. package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
  33. package/src/dataprocessor/xmldataprocessor.js +108 -108
  34. package/src/dev-utils/model.d.ts +124 -124
  35. package/src/dev-utils/model.js +395 -395
  36. package/src/dev-utils/operationreplayer.d.ts +51 -51
  37. package/src/dev-utils/operationreplayer.js +112 -112
  38. package/src/dev-utils/utils.d.ts +37 -37
  39. package/src/dev-utils/utils.js +73 -73
  40. package/src/dev-utils/view.d.ts +319 -319
  41. package/src/dev-utils/view.js +967 -967
  42. package/src/index.d.ts +113 -113
  43. package/src/index.js +77 -77
  44. package/src/model/batch.d.ts +106 -106
  45. package/src/model/batch.js +96 -96
  46. package/src/model/differ.d.ts +373 -373
  47. package/src/model/differ.js +1090 -1090
  48. package/src/model/document.d.ts +264 -264
  49. package/src/model/document.js +356 -356
  50. package/src/model/documentfragment.d.ts +200 -200
  51. package/src/model/documentfragment.js +306 -306
  52. package/src/model/documentselection.d.ts +420 -420
  53. package/src/model/documentselection.js +987 -987
  54. package/src/model/element.d.ts +165 -165
  55. package/src/model/element.js +281 -281
  56. package/src/model/history.d.ts +114 -114
  57. package/src/model/history.js +207 -207
  58. package/src/model/item.d.ts +14 -14
  59. package/src/model/item.js +5 -5
  60. package/src/model/liveposition.d.ts +77 -77
  61. package/src/model/liveposition.js +93 -93
  62. package/src/model/liverange.d.ts +102 -102
  63. package/src/model/liverange.js +120 -120
  64. package/src/model/markercollection.d.ts +335 -335
  65. package/src/model/markercollection.js +403 -403
  66. package/src/model/model.d.ts +920 -920
  67. package/src/model/model.js +843 -843
  68. package/src/model/node.d.ts +256 -256
  69. package/src/model/node.js +375 -375
  70. package/src/model/nodelist.d.ts +91 -91
  71. package/src/model/nodelist.js +163 -163
  72. package/src/model/operation/attributeoperation.d.ts +103 -103
  73. package/src/model/operation/attributeoperation.js +148 -148
  74. package/src/model/operation/detachoperation.d.ts +60 -60
  75. package/src/model/operation/detachoperation.js +77 -77
  76. package/src/model/operation/insertoperation.d.ts +90 -90
  77. package/src/model/operation/insertoperation.js +135 -135
  78. package/src/model/operation/markeroperation.d.ts +91 -91
  79. package/src/model/operation/markeroperation.js +107 -107
  80. package/src/model/operation/mergeoperation.d.ts +100 -100
  81. package/src/model/operation/mergeoperation.js +167 -167
  82. package/src/model/operation/moveoperation.d.ts +96 -96
  83. package/src/model/operation/moveoperation.js +164 -164
  84. package/src/model/operation/nooperation.d.ts +38 -38
  85. package/src/model/operation/nooperation.js +48 -48
  86. package/src/model/operation/operation.d.ts +96 -96
  87. package/src/model/operation/operation.js +62 -62
  88. package/src/model/operation/operationfactory.d.ts +18 -18
  89. package/src/model/operation/operationfactory.js +44 -44
  90. package/src/model/operation/renameoperation.d.ts +83 -83
  91. package/src/model/operation/renameoperation.js +115 -115
  92. package/src/model/operation/rootattributeoperation.d.ts +98 -98
  93. package/src/model/operation/rootattributeoperation.js +155 -155
  94. package/src/model/operation/rootoperation.d.ts +80 -80
  95. package/src/model/operation/rootoperation.js +114 -114
  96. package/src/model/operation/splitoperation.d.ts +109 -109
  97. package/src/model/operation/splitoperation.js +194 -194
  98. package/src/model/operation/transform.d.ts +100 -100
  99. package/src/model/operation/transform.js +1985 -1985
  100. package/src/model/operation/utils.d.ts +71 -71
  101. package/src/model/operation/utils.js +213 -213
  102. package/src/model/position.d.ts +539 -539
  103. package/src/model/position.js +979 -979
  104. package/src/model/range.d.ts +458 -458
  105. package/src/model/range.js +875 -875
  106. package/src/model/rootelement.d.ts +54 -54
  107. package/src/model/rootelement.js +68 -68
  108. package/src/model/schema.d.ts +1176 -1176
  109. package/src/model/schema.js +1237 -1237
  110. package/src/model/selection.d.ts +482 -482
  111. package/src/model/selection.js +789 -789
  112. package/src/model/text.d.ts +66 -66
  113. package/src/model/text.js +85 -85
  114. package/src/model/textproxy.d.ts +144 -144
  115. package/src/model/textproxy.js +189 -189
  116. package/src/model/treewalker.d.ts +186 -186
  117. package/src/model/treewalker.js +244 -244
  118. package/src/model/typecheckable.d.ts +285 -285
  119. package/src/model/typecheckable.js +16 -16
  120. package/src/model/utils/autoparagraphing.d.ts +37 -37
  121. package/src/model/utils/autoparagraphing.js +64 -64
  122. package/src/model/utils/deletecontent.d.ts +58 -58
  123. package/src/model/utils/deletecontent.js +488 -488
  124. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
  125. package/src/model/utils/findoptimalinsertionrange.js +57 -57
  126. package/src/model/utils/getselectedcontent.d.ts +30 -30
  127. package/src/model/utils/getselectedcontent.js +125 -125
  128. package/src/model/utils/insertcontent.d.ts +46 -46
  129. package/src/model/utils/insertcontent.js +705 -705
  130. package/src/model/utils/insertobject.d.ts +44 -44
  131. package/src/model/utils/insertobject.js +139 -139
  132. package/src/model/utils/modifyselection.d.ts +48 -48
  133. package/src/model/utils/modifyselection.js +186 -186
  134. package/src/model/utils/selection-post-fixer.d.ts +74 -74
  135. package/src/model/utils/selection-post-fixer.js +260 -260
  136. package/src/model/writer.d.ts +851 -851
  137. package/src/model/writer.js +1306 -1306
  138. package/src/view/attributeelement.d.ts +108 -108
  139. package/src/view/attributeelement.js +184 -184
  140. package/src/view/containerelement.d.ts +49 -49
  141. package/src/view/containerelement.js +80 -80
  142. package/src/view/datatransfer.d.ts +79 -79
  143. package/src/view/datatransfer.js +98 -98
  144. package/src/view/document.d.ts +184 -184
  145. package/src/view/document.js +120 -120
  146. package/src/view/documentfragment.d.ts +149 -149
  147. package/src/view/documentfragment.js +228 -228
  148. package/src/view/documentselection.d.ts +306 -306
  149. package/src/view/documentselection.js +256 -256
  150. package/src/view/domconverter.d.ts +650 -650
  151. package/src/view/domconverter.js +1373 -1373
  152. package/src/view/downcastwriter.d.ts +996 -996
  153. package/src/view/downcastwriter.js +1696 -1696
  154. package/src/view/editableelement.d.ts +52 -52
  155. package/src/view/editableelement.js +61 -61
  156. package/src/view/element.d.ts +468 -468
  157. package/src/view/element.js +724 -724
  158. package/src/view/elementdefinition.d.ts +87 -87
  159. package/src/view/elementdefinition.js +5 -5
  160. package/src/view/emptyelement.d.ts +41 -41
  161. package/src/view/emptyelement.js +73 -73
  162. package/src/view/filler.d.ts +111 -111
  163. package/src/view/filler.js +148 -148
  164. package/src/view/item.d.ts +14 -14
  165. package/src/view/item.js +5 -5
  166. package/src/view/matcher.d.ts +486 -486
  167. package/src/view/matcher.js +507 -507
  168. package/src/view/node.d.ts +163 -163
  169. package/src/view/node.js +228 -228
  170. package/src/view/observer/arrowkeysobserver.d.ts +45 -45
  171. package/src/view/observer/arrowkeysobserver.js +40 -40
  172. package/src/view/observer/bubblingemittermixin.d.ts +166 -166
  173. package/src/view/observer/bubblingemittermixin.js +172 -172
  174. package/src/view/observer/bubblingeventinfo.d.ts +47 -47
  175. package/src/view/observer/bubblingeventinfo.js +37 -37
  176. package/src/view/observer/clickobserver.d.ts +43 -43
  177. package/src/view/observer/clickobserver.js +29 -29
  178. package/src/view/observer/compositionobserver.d.ts +82 -82
  179. package/src/view/observer/compositionobserver.js +60 -60
  180. package/src/view/observer/domeventdata.d.ts +50 -50
  181. package/src/view/observer/domeventdata.js +47 -47
  182. package/src/view/observer/domeventobserver.d.ts +73 -73
  183. package/src/view/observer/domeventobserver.js +79 -79
  184. package/src/view/observer/fakeselectionobserver.d.ts +47 -47
  185. package/src/view/observer/fakeselectionobserver.js +91 -91
  186. package/src/view/observer/focusobserver.d.ts +82 -82
  187. package/src/view/observer/focusobserver.js +86 -86
  188. package/src/view/observer/inputobserver.d.ts +86 -86
  189. package/src/view/observer/inputobserver.js +164 -164
  190. package/src/view/observer/keyobserver.d.ts +66 -66
  191. package/src/view/observer/keyobserver.js +39 -39
  192. package/src/view/observer/mouseobserver.d.ts +89 -89
  193. package/src/view/observer/mouseobserver.js +29 -29
  194. package/src/view/observer/mutationobserver.d.ts +86 -86
  195. package/src/view/observer/mutationobserver.js +206 -206
  196. package/src/view/observer/observer.d.ts +89 -89
  197. package/src/view/observer/observer.js +84 -84
  198. package/src/view/observer/selectionobserver.d.ts +148 -148
  199. package/src/view/observer/selectionobserver.js +202 -202
  200. package/src/view/observer/tabobserver.d.ts +46 -46
  201. package/src/view/observer/tabobserver.js +42 -42
  202. package/src/view/placeholder.d.ts +85 -85
  203. package/src/view/placeholder.js +230 -230
  204. package/src/view/position.d.ts +189 -189
  205. package/src/view/position.js +324 -324
  206. package/src/view/range.d.ts +279 -279
  207. package/src/view/range.js +430 -430
  208. package/src/view/rawelement.d.ts +73 -73
  209. package/src/view/rawelement.js +105 -105
  210. package/src/view/renderer.d.ts +265 -265
  211. package/src/view/renderer.js +1000 -1000
  212. package/src/view/rooteditableelement.d.ts +41 -41
  213. package/src/view/rooteditableelement.js +69 -69
  214. package/src/view/selection.d.ts +375 -375
  215. package/src/view/selection.js +559 -559
  216. package/src/view/styles/background.d.ts +33 -33
  217. package/src/view/styles/background.js +74 -74
  218. package/src/view/styles/border.d.ts +43 -43
  219. package/src/view/styles/border.js +316 -316
  220. package/src/view/styles/margin.d.ts +29 -29
  221. package/src/view/styles/margin.js +34 -34
  222. package/src/view/styles/padding.d.ts +29 -29
  223. package/src/view/styles/padding.js +34 -34
  224. package/src/view/styles/utils.d.ts +93 -93
  225. package/src/view/styles/utils.js +219 -219
  226. package/src/view/stylesmap.d.ts +675 -675
  227. package/src/view/stylesmap.js +766 -766
  228. package/src/view/text.d.ts +74 -74
  229. package/src/view/text.js +93 -93
  230. package/src/view/textproxy.d.ts +97 -97
  231. package/src/view/textproxy.js +124 -124
  232. package/src/view/treewalker.d.ts +195 -195
  233. package/src/view/treewalker.js +327 -327
  234. package/src/view/typecheckable.d.ts +448 -448
  235. package/src/view/typecheckable.js +19 -19
  236. package/src/view/uielement.d.ts +96 -96
  237. package/src/view/uielement.js +182 -182
  238. package/src/view/upcastwriter.d.ts +417 -417
  239. package/src/view/upcastwriter.js +359 -359
  240. package/src/view/view.d.ts +480 -480
  241. package/src/view/view.js +534 -534
@@ -1,85 +1,85 @@
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/placeholder
7
- */
8
- import '../../theme/placeholder.css';
9
- import type DowncastWriter from './downcastwriter';
10
- import type Element from './element';
11
- import type View from './view';
12
- /**
13
- * A helper that enables a placeholder on the provided view element (also updates its visibility).
14
- * The placeholder is a CSS pseudo–element (with a text content) attached to the element.
15
- *
16
- * To change the placeholder text, simply call this method again with new options.
17
- *
18
- * To disable the placeholder, use {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} helper.
19
- *
20
- * @param options Configuration options of the placeholder.
21
- * @param options.view Editing view instance.
22
- * @param options.element Element that will gain a placeholder. See `options.isDirectHost` to learn more.
23
- * @param options.text Placeholder text.
24
- * @param options.isDirectHost If set `false`, the placeholder will not be enabled directly
25
- * in the passed `element` but in one of its children (selected automatically, i.e. a first empty child element).
26
- * Useful when attaching placeholders to elements that can host other elements (not just text), for instance,
27
- * editable root elements.
28
- * @param options.keepOnFocus If set `true`, the placeholder stay visible when the host element is focused.
29
- */
30
- export declare function enablePlaceholder({ view, element, text, isDirectHost, keepOnFocus }: {
31
- view: View;
32
- element: Element;
33
- text: string;
34
- isDirectHost?: boolean;
35
- keepOnFocus?: boolean;
36
- }): void;
37
- /**
38
- * Disables the placeholder functionality from a given element.
39
- *
40
- * See {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} to learn more.
41
- */
42
- export declare function disablePlaceholder(view: View, element: Element): void;
43
- /**
44
- * Shows a placeholder in the provided element by changing related attributes and CSS classes.
45
- *
46
- * **Note**: This helper will not update the placeholder visibility nor manage the
47
- * it in any way in the future. What it does is a one–time state change of an element. Use
48
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
49
- * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
50
- * placeholder functionality.
51
- *
52
- * **Note**: This helper will blindly show the placeholder directly in the root editable element if
53
- * one is passed, which could result in a visual clash if the editable element has some children
54
- * (for instance, an empty paragraph). Use {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`}
55
- * in that case or make sure the correct element is passed to the helper.
56
- *
57
- * @returns `true`, if any changes were made to the `element`.
58
- */
59
- export declare function showPlaceholder(writer: DowncastWriter, element: Element): boolean;
60
- /**
61
- * Hides a placeholder in the element by changing related attributes and CSS classes.
62
- *
63
- * **Note**: This helper will not update the placeholder visibility nor manage the
64
- * it in any way in the future. What it does is a one–time state change of an element. Use
65
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
66
- * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
67
- * placeholder functionality.
68
- *
69
- * @returns `true`, if any changes were made to the `element`.
70
- */
71
- export declare function hidePlaceholder(writer: DowncastWriter, element: Element): boolean;
72
- /**
73
- * Checks if a placeholder should be displayed in the element.
74
- *
75
- * **Note**: This helper will blindly check the possibility of showing a placeholder directly in the
76
- * root editable element if one is passed, which may not be the expected result. If an element can
77
- * host other elements (not just text), most likely one of its children should be checked instead
78
- * because it will be the final host for the placeholder. Use
79
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} in that case or make
80
- * sure the correct element is passed to the helper.
81
- *
82
- * @param element Element that holds the placeholder.
83
- * @param keepOnFocus Focusing the element will keep the placeholder visible.
84
- */
85
- export declare function needsPlaceholder(element: Element, keepOnFocus: boolean): boolean;
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/placeholder
7
+ */
8
+ import '../../theme/placeholder.css';
9
+ import type DowncastWriter from './downcastwriter';
10
+ import type Element from './element';
11
+ import type View from './view';
12
+ /**
13
+ * A helper that enables a placeholder on the provided view element (also updates its visibility).
14
+ * The placeholder is a CSS pseudo–element (with a text content) attached to the element.
15
+ *
16
+ * To change the placeholder text, simply call this method again with new options.
17
+ *
18
+ * To disable the placeholder, use {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} helper.
19
+ *
20
+ * @param options Configuration options of the placeholder.
21
+ * @param options.view Editing view instance.
22
+ * @param options.element Element that will gain a placeholder. See `options.isDirectHost` to learn more.
23
+ * @param options.text Placeholder text.
24
+ * @param options.isDirectHost If set `false`, the placeholder will not be enabled directly
25
+ * in the passed `element` but in one of its children (selected automatically, i.e. a first empty child element).
26
+ * Useful when attaching placeholders to elements that can host other elements (not just text), for instance,
27
+ * editable root elements.
28
+ * @param options.keepOnFocus If set `true`, the placeholder stay visible when the host element is focused.
29
+ */
30
+ export declare function enablePlaceholder({ view, element, text, isDirectHost, keepOnFocus }: {
31
+ view: View;
32
+ element: Element;
33
+ text: string;
34
+ isDirectHost?: boolean;
35
+ keepOnFocus?: boolean;
36
+ }): void;
37
+ /**
38
+ * Disables the placeholder functionality from a given element.
39
+ *
40
+ * See {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} to learn more.
41
+ */
42
+ export declare function disablePlaceholder(view: View, element: Element): void;
43
+ /**
44
+ * Shows a placeholder in the provided element by changing related attributes and CSS classes.
45
+ *
46
+ * **Note**: This helper will not update the placeholder visibility nor manage the
47
+ * it in any way in the future. What it does is a one–time state change of an element. Use
48
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
49
+ * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
50
+ * placeholder functionality.
51
+ *
52
+ * **Note**: This helper will blindly show the placeholder directly in the root editable element if
53
+ * one is passed, which could result in a visual clash if the editable element has some children
54
+ * (for instance, an empty paragraph). Use {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`}
55
+ * in that case or make sure the correct element is passed to the helper.
56
+ *
57
+ * @returns `true`, if any changes were made to the `element`.
58
+ */
59
+ export declare function showPlaceholder(writer: DowncastWriter, element: Element): boolean;
60
+ /**
61
+ * Hides a placeholder in the element by changing related attributes and CSS classes.
62
+ *
63
+ * **Note**: This helper will not update the placeholder visibility nor manage the
64
+ * it in any way in the future. What it does is a one–time state change of an element. Use
65
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
66
+ * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
67
+ * placeholder functionality.
68
+ *
69
+ * @returns `true`, if any changes were made to the `element`.
70
+ */
71
+ export declare function hidePlaceholder(writer: DowncastWriter, element: Element): boolean;
72
+ /**
73
+ * Checks if a placeholder should be displayed in the element.
74
+ *
75
+ * **Note**: This helper will blindly check the possibility of showing a placeholder directly in the
76
+ * root editable element if one is passed, which may not be the expected result. If an element can
77
+ * host other elements (not just text), most likely one of its children should be checked instead
78
+ * because it will be the final host for the placeholder. Use
79
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} in that case or make
80
+ * sure the correct element is passed to the helper.
81
+ *
82
+ * @param element Element that holds the placeholder.
83
+ * @param keepOnFocus Focusing the element will keep the placeholder visible.
84
+ */
85
+ export declare function needsPlaceholder(element: Element, keepOnFocus: boolean): boolean;
@@ -1,230 +1,230 @@
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/placeholder
7
- */
8
- import '../../theme/placeholder.css';
9
- // Each document stores information about its placeholder elements and check functions.
10
- const documentPlaceholders = new WeakMap();
11
- /**
12
- * A helper that enables a placeholder on the provided view element (also updates its visibility).
13
- * The placeholder is a CSS pseudo–element (with a text content) attached to the element.
14
- *
15
- * To change the placeholder text, simply call this method again with new options.
16
- *
17
- * To disable the placeholder, use {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} helper.
18
- *
19
- * @param options Configuration options of the placeholder.
20
- * @param options.view Editing view instance.
21
- * @param options.element Element that will gain a placeholder. See `options.isDirectHost` to learn more.
22
- * @param options.text Placeholder text.
23
- * @param options.isDirectHost If set `false`, the placeholder will not be enabled directly
24
- * in the passed `element` but in one of its children (selected automatically, i.e. a first empty child element).
25
- * Useful when attaching placeholders to elements that can host other elements (not just text), for instance,
26
- * editable root elements.
27
- * @param options.keepOnFocus If set `true`, the placeholder stay visible when the host element is focused.
28
- */
29
- export function enablePlaceholder({ view, element, text, isDirectHost = true, keepOnFocus = false }) {
30
- const doc = view.document;
31
- // Use a single a single post fixer per—document to update all placeholders.
32
- if (!documentPlaceholders.has(doc)) {
33
- documentPlaceholders.set(doc, new Map());
34
- // If a post-fixer callback makes a change, it should return `true` so other post–fixers
35
- // can re–evaluate the document again.
36
- doc.registerPostFixer(writer => updateDocumentPlaceholders(doc, writer));
37
- // Update placeholders on isComposing state change since rendering is disabled while in composition mode.
38
- doc.on('change:isComposing', () => {
39
- view.change(writer => updateDocumentPlaceholders(doc, writer));
40
- }, { priority: 'high' });
41
- }
42
- // Store information about the element placeholder under its document.
43
- documentPlaceholders.get(doc).set(element, {
44
- text,
45
- isDirectHost,
46
- keepOnFocus,
47
- hostElement: isDirectHost ? element : null
48
- });
49
- // Update the placeholders right away.
50
- view.change(writer => updateDocumentPlaceholders(doc, writer));
51
- }
52
- /**
53
- * Disables the placeholder functionality from a given element.
54
- *
55
- * See {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} to learn more.
56
- */
57
- export function disablePlaceholder(view, element) {
58
- const doc = element.document;
59
- if (!documentPlaceholders.has(doc)) {
60
- return;
61
- }
62
- view.change(writer => {
63
- const placeholders = documentPlaceholders.get(doc);
64
- const config = placeholders.get(element);
65
- writer.removeAttribute('data-placeholder', config.hostElement);
66
- hidePlaceholder(writer, config.hostElement);
67
- placeholders.delete(element);
68
- });
69
- }
70
- /**
71
- * Shows a placeholder in the provided element by changing related attributes and CSS classes.
72
- *
73
- * **Note**: This helper will not update the placeholder visibility nor manage the
74
- * it in any way in the future. What it does is a one–time state change of an element. Use
75
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
76
- * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
77
- * placeholder functionality.
78
- *
79
- * **Note**: This helper will blindly show the placeholder directly in the root editable element if
80
- * one is passed, which could result in a visual clash if the editable element has some children
81
- * (for instance, an empty paragraph). Use {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`}
82
- * in that case or make sure the correct element is passed to the helper.
83
- *
84
- * @returns `true`, if any changes were made to the `element`.
85
- */
86
- export function showPlaceholder(writer, element) {
87
- if (!element.hasClass('ck-placeholder')) {
88
- writer.addClass('ck-placeholder', element);
89
- return true;
90
- }
91
- return false;
92
- }
93
- /**
94
- * Hides a placeholder in the element by changing related attributes and CSS classes.
95
- *
96
- * **Note**: This helper will not update the placeholder visibility nor manage the
97
- * it in any way in the future. What it does is a one–time state change of an element. Use
98
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
99
- * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
100
- * placeholder functionality.
101
- *
102
- * @returns `true`, if any changes were made to the `element`.
103
- */
104
- export function hidePlaceholder(writer, element) {
105
- if (element.hasClass('ck-placeholder')) {
106
- writer.removeClass('ck-placeholder', element);
107
- return true;
108
- }
109
- return false;
110
- }
111
- /**
112
- * Checks if a placeholder should be displayed in the element.
113
- *
114
- * **Note**: This helper will blindly check the possibility of showing a placeholder directly in the
115
- * root editable element if one is passed, which may not be the expected result. If an element can
116
- * host other elements (not just text), most likely one of its children should be checked instead
117
- * because it will be the final host for the placeholder. Use
118
- * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} in that case or make
119
- * sure the correct element is passed to the helper.
120
- *
121
- * @param element Element that holds the placeholder.
122
- * @param keepOnFocus Focusing the element will keep the placeholder visible.
123
- */
124
- export function needsPlaceholder(element, keepOnFocus) {
125
- if (!element.isAttached()) {
126
- return false;
127
- }
128
- // Anything but uiElement(s) counts as content.
129
- const hasContent = Array.from(element.getChildren())
130
- .some(element => !element.is('uiElement'));
131
- if (hasContent) {
132
- return false;
133
- }
134
- const doc = element.document;
135
- const viewSelection = doc.selection;
136
- const selectionAnchor = viewSelection.anchor;
137
- if (doc.isComposing && selectionAnchor && selectionAnchor.parent === element) {
138
- return false;
139
- }
140
- // Skip the focus check and make the placeholder visible already regardless of document focus state.
141
- if (keepOnFocus) {
142
- return true;
143
- }
144
- // If the document is blurred.
145
- if (!doc.isFocused) {
146
- return true;
147
- }
148
- // If document is focused and the element is empty but the selection is not anchored inside it.
149
- return !!selectionAnchor && selectionAnchor.parent !== element;
150
- }
151
- /**
152
- * Updates all placeholders associated with a document in a post–fixer callback.
153
- *
154
- * @returns True if any changes were made to the view document.
155
- */
156
- function updateDocumentPlaceholders(doc, writer) {
157
- const placeholders = documentPlaceholders.get(doc);
158
- const directHostElements = [];
159
- let wasViewModified = false;
160
- // First set placeholders on the direct hosts.
161
- for (const [element, config] of placeholders) {
162
- if (config.isDirectHost) {
163
- directHostElements.push(element);
164
- if (updatePlaceholder(writer, element, config)) {
165
- wasViewModified = true;
166
- }
167
- }
168
- }
169
- // Then set placeholders on the indirect hosts but only on those that does not already have an direct host placeholder.
170
- for (const [element, config] of placeholders) {
171
- if (config.isDirectHost) {
172
- continue;
173
- }
174
- const hostElement = getChildPlaceholderHostSubstitute(element);
175
- // When not a direct host, it could happen that there is no child element
176
- // capable of displaying a placeholder.
177
- if (!hostElement) {
178
- continue;
179
- }
180
- // Don't override placeholder if the host element already has some direct placeholder.
181
- if (directHostElements.includes(hostElement)) {
182
- continue;
183
- }
184
- // Update the host element (used for setting and removing the placeholder).
185
- config.hostElement = hostElement;
186
- if (updatePlaceholder(writer, element, config)) {
187
- wasViewModified = true;
188
- }
189
- }
190
- return wasViewModified;
191
- }
192
- /**
193
- * Updates a single placeholder in a post–fixer callback.
194
- *
195
- * @returns True if any changes were made to the view document.
196
- */
197
- function updatePlaceholder(writer, element, config) {
198
- const { text, isDirectHost, hostElement } = config;
199
- let wasViewModified = false;
200
- // This may be necessary when updating the placeholder text to something else.
201
- if (hostElement.getAttribute('data-placeholder') !== text) {
202
- writer.setAttribute('data-placeholder', text, hostElement);
203
- wasViewModified = true;
204
- }
205
- // If the host element is not a direct host then placeholder is needed only when there is only one element.
206
- const isOnlyChild = isDirectHost || element.childCount == 1;
207
- if (isOnlyChild && needsPlaceholder(hostElement, config.keepOnFocus)) {
208
- if (showPlaceholder(writer, hostElement)) {
209
- wasViewModified = true;
210
- }
211
- }
212
- else if (hidePlaceholder(writer, hostElement)) {
213
- wasViewModified = true;
214
- }
215
- return wasViewModified;
216
- }
217
- /**
218
- * Gets a child element capable of displaying a placeholder if a parent element can host more
219
- * than just text (for instance, when it is a root editable element). The child element
220
- * can then be used in other placeholder helpers as a substitute of its parent.
221
- */
222
- function getChildPlaceholderHostSubstitute(parent) {
223
- if (parent.childCount) {
224
- const firstChild = parent.getChild(0);
225
- if (firstChild.is('element') && !firstChild.is('uiElement') && !firstChild.is('attributeElement')) {
226
- return firstChild;
227
- }
228
- }
229
- return null;
230
- }
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/placeholder
7
+ */
8
+ import '../../theme/placeholder.css';
9
+ // Each document stores information about its placeholder elements and check functions.
10
+ const documentPlaceholders = new WeakMap();
11
+ /**
12
+ * A helper that enables a placeholder on the provided view element (also updates its visibility).
13
+ * The placeholder is a CSS pseudo–element (with a text content) attached to the element.
14
+ *
15
+ * To change the placeholder text, simply call this method again with new options.
16
+ *
17
+ * To disable the placeholder, use {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} helper.
18
+ *
19
+ * @param options Configuration options of the placeholder.
20
+ * @param options.view Editing view instance.
21
+ * @param options.element Element that will gain a placeholder. See `options.isDirectHost` to learn more.
22
+ * @param options.text Placeholder text.
23
+ * @param options.isDirectHost If set `false`, the placeholder will not be enabled directly
24
+ * in the passed `element` but in one of its children (selected automatically, i.e. a first empty child element).
25
+ * Useful when attaching placeholders to elements that can host other elements (not just text), for instance,
26
+ * editable root elements.
27
+ * @param options.keepOnFocus If set `true`, the placeholder stay visible when the host element is focused.
28
+ */
29
+ export function enablePlaceholder({ view, element, text, isDirectHost = true, keepOnFocus = false }) {
30
+ const doc = view.document;
31
+ // Use a single a single post fixer per—document to update all placeholders.
32
+ if (!documentPlaceholders.has(doc)) {
33
+ documentPlaceholders.set(doc, new Map());
34
+ // If a post-fixer callback makes a change, it should return `true` so other post–fixers
35
+ // can re–evaluate the document again.
36
+ doc.registerPostFixer(writer => updateDocumentPlaceholders(doc, writer));
37
+ // Update placeholders on isComposing state change since rendering is disabled while in composition mode.
38
+ doc.on('change:isComposing', () => {
39
+ view.change(writer => updateDocumentPlaceholders(doc, writer));
40
+ }, { priority: 'high' });
41
+ }
42
+ // Store information about the element placeholder under its document.
43
+ documentPlaceholders.get(doc).set(element, {
44
+ text,
45
+ isDirectHost,
46
+ keepOnFocus,
47
+ hostElement: isDirectHost ? element : null
48
+ });
49
+ // Update the placeholders right away.
50
+ view.change(writer => updateDocumentPlaceholders(doc, writer));
51
+ }
52
+ /**
53
+ * Disables the placeholder functionality from a given element.
54
+ *
55
+ * See {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} to learn more.
56
+ */
57
+ export function disablePlaceholder(view, element) {
58
+ const doc = element.document;
59
+ if (!documentPlaceholders.has(doc)) {
60
+ return;
61
+ }
62
+ view.change(writer => {
63
+ const placeholders = documentPlaceholders.get(doc);
64
+ const config = placeholders.get(element);
65
+ writer.removeAttribute('data-placeholder', config.hostElement);
66
+ hidePlaceholder(writer, config.hostElement);
67
+ placeholders.delete(element);
68
+ });
69
+ }
70
+ /**
71
+ * Shows a placeholder in the provided element by changing related attributes and CSS classes.
72
+ *
73
+ * **Note**: This helper will not update the placeholder visibility nor manage the
74
+ * it in any way in the future. What it does is a one–time state change of an element. Use
75
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
76
+ * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
77
+ * placeholder functionality.
78
+ *
79
+ * **Note**: This helper will blindly show the placeholder directly in the root editable element if
80
+ * one is passed, which could result in a visual clash if the editable element has some children
81
+ * (for instance, an empty paragraph). Use {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`}
82
+ * in that case or make sure the correct element is passed to the helper.
83
+ *
84
+ * @returns `true`, if any changes were made to the `element`.
85
+ */
86
+ export function showPlaceholder(writer, element) {
87
+ if (!element.hasClass('ck-placeholder')) {
88
+ writer.addClass('ck-placeholder', element);
89
+ return true;
90
+ }
91
+ return false;
92
+ }
93
+ /**
94
+ * Hides a placeholder in the element by changing related attributes and CSS classes.
95
+ *
96
+ * **Note**: This helper will not update the placeholder visibility nor manage the
97
+ * it in any way in the future. What it does is a one–time state change of an element. Use
98
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} and
99
+ * {@link module:engine/view/placeholder~disablePlaceholder `disablePlaceholder()`} for full
100
+ * placeholder functionality.
101
+ *
102
+ * @returns `true`, if any changes were made to the `element`.
103
+ */
104
+ export function hidePlaceholder(writer, element) {
105
+ if (element.hasClass('ck-placeholder')) {
106
+ writer.removeClass('ck-placeholder', element);
107
+ return true;
108
+ }
109
+ return false;
110
+ }
111
+ /**
112
+ * Checks if a placeholder should be displayed in the element.
113
+ *
114
+ * **Note**: This helper will blindly check the possibility of showing a placeholder directly in the
115
+ * root editable element if one is passed, which may not be the expected result. If an element can
116
+ * host other elements (not just text), most likely one of its children should be checked instead
117
+ * because it will be the final host for the placeholder. Use
118
+ * {@link module:engine/view/placeholder~enablePlaceholder `enablePlaceholder()`} in that case or make
119
+ * sure the correct element is passed to the helper.
120
+ *
121
+ * @param element Element that holds the placeholder.
122
+ * @param keepOnFocus Focusing the element will keep the placeholder visible.
123
+ */
124
+ export function needsPlaceholder(element, keepOnFocus) {
125
+ if (!element.isAttached()) {
126
+ return false;
127
+ }
128
+ // Anything but uiElement(s) counts as content.
129
+ const hasContent = Array.from(element.getChildren())
130
+ .some(element => !element.is('uiElement'));
131
+ if (hasContent) {
132
+ return false;
133
+ }
134
+ const doc = element.document;
135
+ const viewSelection = doc.selection;
136
+ const selectionAnchor = viewSelection.anchor;
137
+ if (doc.isComposing && selectionAnchor && selectionAnchor.parent === element) {
138
+ return false;
139
+ }
140
+ // Skip the focus check and make the placeholder visible already regardless of document focus state.
141
+ if (keepOnFocus) {
142
+ return true;
143
+ }
144
+ // If the document is blurred.
145
+ if (!doc.isFocused) {
146
+ return true;
147
+ }
148
+ // If document is focused and the element is empty but the selection is not anchored inside it.
149
+ return !!selectionAnchor && selectionAnchor.parent !== element;
150
+ }
151
+ /**
152
+ * Updates all placeholders associated with a document in a post–fixer callback.
153
+ *
154
+ * @returns True if any changes were made to the view document.
155
+ */
156
+ function updateDocumentPlaceholders(doc, writer) {
157
+ const placeholders = documentPlaceholders.get(doc);
158
+ const directHostElements = [];
159
+ let wasViewModified = false;
160
+ // First set placeholders on the direct hosts.
161
+ for (const [element, config] of placeholders) {
162
+ if (config.isDirectHost) {
163
+ directHostElements.push(element);
164
+ if (updatePlaceholder(writer, element, config)) {
165
+ wasViewModified = true;
166
+ }
167
+ }
168
+ }
169
+ // Then set placeholders on the indirect hosts but only on those that does not already have an direct host placeholder.
170
+ for (const [element, config] of placeholders) {
171
+ if (config.isDirectHost) {
172
+ continue;
173
+ }
174
+ const hostElement = getChildPlaceholderHostSubstitute(element);
175
+ // When not a direct host, it could happen that there is no child element
176
+ // capable of displaying a placeholder.
177
+ if (!hostElement) {
178
+ continue;
179
+ }
180
+ // Don't override placeholder if the host element already has some direct placeholder.
181
+ if (directHostElements.includes(hostElement)) {
182
+ continue;
183
+ }
184
+ // Update the host element (used for setting and removing the placeholder).
185
+ config.hostElement = hostElement;
186
+ if (updatePlaceholder(writer, element, config)) {
187
+ wasViewModified = true;
188
+ }
189
+ }
190
+ return wasViewModified;
191
+ }
192
+ /**
193
+ * Updates a single placeholder in a post–fixer callback.
194
+ *
195
+ * @returns True if any changes were made to the view document.
196
+ */
197
+ function updatePlaceholder(writer, element, config) {
198
+ const { text, isDirectHost, hostElement } = config;
199
+ let wasViewModified = false;
200
+ // This may be necessary when updating the placeholder text to something else.
201
+ if (hostElement.getAttribute('data-placeholder') !== text) {
202
+ writer.setAttribute('data-placeholder', text, hostElement);
203
+ wasViewModified = true;
204
+ }
205
+ // If the host element is not a direct host then placeholder is needed only when there is only one element.
206
+ const isOnlyChild = isDirectHost || element.childCount == 1;
207
+ if (isOnlyChild && needsPlaceholder(hostElement, config.keepOnFocus)) {
208
+ if (showPlaceholder(writer, hostElement)) {
209
+ wasViewModified = true;
210
+ }
211
+ }
212
+ else if (hidePlaceholder(writer, hostElement)) {
213
+ wasViewModified = true;
214
+ }
215
+ return wasViewModified;
216
+ }
217
+ /**
218
+ * Gets a child element capable of displaying a placeholder if a parent element can host more
219
+ * than just text (for instance, when it is a root editable element). The child element
220
+ * can then be used in other placeholder helpers as a substitute of its parent.
221
+ */
222
+ function getChildPlaceholderHostSubstitute(parent) {
223
+ if (parent.childCount) {
224
+ const firstChild = parent.getChild(0);
225
+ if (firstChild.is('element') && !firstChild.is('uiElement') && !firstChild.is('attributeElement')) {
226
+ return firstChild;
227
+ }
228
+ }
229
+ return null;
230
+ }