@ckeditor/ckeditor5-table 40.0.0 → 40.2.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 (171) hide show
  1. package/CHANGELOG.md +15 -15
  2. package/LICENSE.md +3 -3
  3. package/build/table.js +1 -1
  4. package/build/translations/fi.js +1 -1
  5. package/lang/translations/fi.po +3 -3
  6. package/package.json +2 -2
  7. package/src/augmentation.d.ts +76 -76
  8. package/src/augmentation.js +5 -5
  9. package/src/commands/insertcolumncommand.d.ts +55 -55
  10. package/src/commands/insertcolumncommand.js +67 -67
  11. package/src/commands/insertrowcommand.d.ts +54 -54
  12. package/src/commands/insertrowcommand.js +66 -66
  13. package/src/commands/inserttablecommand.d.ts +44 -44
  14. package/src/commands/inserttablecommand.js +69 -69
  15. package/src/commands/mergecellcommand.d.ts +68 -68
  16. package/src/commands/mergecellcommand.js +198 -198
  17. package/src/commands/mergecellscommand.d.ts +28 -28
  18. package/src/commands/mergecellscommand.js +94 -94
  19. package/src/commands/removecolumncommand.d.ts +29 -29
  20. package/src/commands/removecolumncommand.js +109 -109
  21. package/src/commands/removerowcommand.d.ts +29 -29
  22. package/src/commands/removerowcommand.js +82 -82
  23. package/src/commands/selectcolumncommand.d.ts +33 -33
  24. package/src/commands/selectcolumncommand.js +60 -60
  25. package/src/commands/selectrowcommand.d.ts +33 -33
  26. package/src/commands/selectrowcommand.js +56 -56
  27. package/src/commands/setheadercolumncommand.d.ts +50 -50
  28. package/src/commands/setheadercolumncommand.js +71 -71
  29. package/src/commands/setheaderrowcommand.d.ts +53 -53
  30. package/src/commands/setheaderrowcommand.js +79 -79
  31. package/src/commands/splitcellcommand.d.ts +43 -43
  32. package/src/commands/splitcellcommand.js +54 -54
  33. package/src/converters/downcast.d.ts +63 -63
  34. package/src/converters/downcast.js +146 -146
  35. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  36. package/src/converters/table-caption-post-fixer.js +53 -53
  37. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  38. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  39. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  40. package/src/converters/table-cell-refresh-handler.js +45 -45
  41. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  42. package/src/converters/table-headings-refresh-handler.js +49 -49
  43. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  44. package/src/converters/table-layout-post-fixer.js +367 -367
  45. package/src/converters/tableproperties.d.ts +54 -54
  46. package/src/converters/tableproperties.js +159 -159
  47. package/src/converters/upcasttable.d.ts +49 -49
  48. package/src/converters/upcasttable.js +243 -243
  49. package/src/index.d.ts +60 -60
  50. package/src/index.js +30 -30
  51. package/src/plaintableoutput.d.ts +26 -26
  52. package/src/plaintableoutput.js +123 -123
  53. package/src/table.d.ts +40 -40
  54. package/src/table.js +44 -44
  55. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  56. package/src/tablecaption/tablecaptionediting.js +122 -122
  57. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  58. package/src/tablecaption/tablecaptionui.js +57 -57
  59. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  60. package/src/tablecaption/toggletablecaptioncommand.js +105 -104
  61. package/src/tablecaption/utils.d.ts +38 -42
  62. package/src/tablecaption/utils.js +57 -67
  63. package/src/tablecaption.d.ts +24 -24
  64. package/src/tablecaption.js +28 -28
  65. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  66. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  67. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  68. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  69. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  70. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  71. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  72. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  73. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  74. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  75. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  76. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  77. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  78. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  79. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  80. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  81. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  82. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  83. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  84. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  85. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  86. package/src/tablecellproperties/tablecellpropertiesui.js +330 -330
  87. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +228 -228
  88. package/src/tablecellproperties/ui/tablecellpropertiesview.js +548 -548
  89. package/src/tablecellproperties.d.ts +30 -30
  90. package/src/tablecellproperties.js +34 -34
  91. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  92. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  93. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  94. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  95. package/src/tableclipboard.d.ts +65 -65
  96. package/src/tableclipboard.js +450 -450
  97. package/src/tablecolumnresize/constants.d.ts +20 -20
  98. package/src/tablecolumnresize/constants.js +20 -20
  99. package/src/tablecolumnresize/converters.d.ts +18 -18
  100. package/src/tablecolumnresize/converters.js +46 -46
  101. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  102. package/src/tablecolumnresize/tablecolumnresizeediting.js +583 -583
  103. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  104. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  105. package/src/tablecolumnresize/utils.d.ts +148 -148
  106. package/src/tablecolumnresize/utils.js +358 -358
  107. package/src/tablecolumnresize.d.ts +26 -26
  108. package/src/tablecolumnresize.js +30 -30
  109. package/src/tableconfig.d.ts +343 -343
  110. package/src/tableconfig.js +5 -5
  111. package/src/tableediting.d.ts +98 -98
  112. package/src/tableediting.js +191 -191
  113. package/src/tablekeyboard.d.ts +68 -68
  114. package/src/tablekeyboard.js +279 -279
  115. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  116. package/src/tablemouse/mouseeventsobserver.js +35 -35
  117. package/src/tablemouse.d.ts +48 -48
  118. package/src/tablemouse.js +172 -172
  119. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  120. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  121. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  122. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  123. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  124. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  125. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  126. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  127. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  128. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  129. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  130. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  131. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  132. package/src/tableproperties/commands/tablepropertycommand.js +81 -80
  133. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  134. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  135. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  136. package/src/tableproperties/tablepropertiesediting.js +206 -206
  137. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  138. package/src/tableproperties/tablepropertiesui.js +321 -321
  139. package/src/tableproperties/ui/tablepropertiesview.d.ts +207 -207
  140. package/src/tableproperties/ui/tablepropertiesview.js +466 -466
  141. package/src/tableproperties.d.ts +30 -30
  142. package/src/tableproperties.js +34 -34
  143. package/src/tableselection.d.ts +107 -107
  144. package/src/tableselection.js +297 -297
  145. package/src/tabletoolbar.d.ts +32 -32
  146. package/src/tabletoolbar.js +57 -57
  147. package/src/tableui.d.ts +53 -53
  148. package/src/tableui.js +309 -309
  149. package/src/tableutils.d.ts +448 -448
  150. package/src/tableutils.js +1055 -1055
  151. package/src/tablewalker.d.ts +362 -362
  152. package/src/tablewalker.js +393 -393
  153. package/src/ui/colorinputview.d.ts +140 -140
  154. package/src/ui/colorinputview.js +271 -271
  155. package/src/ui/formrowview.d.ts +61 -61
  156. package/src/ui/formrowview.js +57 -57
  157. package/src/ui/inserttableview.d.ts +77 -77
  158. package/src/ui/inserttableview.js +169 -169
  159. package/src/utils/common.d.ts +46 -42
  160. package/src/utils/common.js +68 -57
  161. package/src/utils/structure.d.ts +245 -245
  162. package/src/utils/structure.js +426 -426
  163. package/src/utils/table-properties.d.ts +67 -67
  164. package/src/utils/table-properties.js +86 -86
  165. package/src/utils/ui/contextualballoon.d.ts +34 -34
  166. package/src/utils/ui/contextualballoon.js +110 -106
  167. package/src/utils/ui/table-properties.d.ts +195 -195
  168. package/src/utils/ui/table-properties.js +362 -362
  169. package/src/utils/ui/widget.d.ts +20 -16
  170. package/src/utils/ui/widget.js +48 -38
  171. package/build/table.js.map +0 -1
@@ -1,62 +1,62 @@
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 table/tablemouse/mouseeventsobserver
7
- */
8
- import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine';
9
- /**
10
- * The mouse selection event observer.
11
- *
12
- * It registers listeners for the following DOM events:
13
- *
14
- * - `'mousemove'`
15
- * - `'mouseleave'`
16
- *
17
- * Note that this observer is disabled by default. To enable this observer, it needs to be added to
18
- * {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
19
- *
20
- * The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
21
- */
22
- export default class MouseEventsObserver extends DomEventObserver<'mousemove' | 'mouseleave'> {
23
- readonly domEventType: readonly ["mousemove", "mouseleave"];
24
- /**
25
- * @inheritDoc
26
- */
27
- onDomEvent(domEvent: MouseEvent): void;
28
- }
29
- /**
30
- * Fired when the mouse is moved over one of the editables.
31
- *
32
- * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
33
- *
34
- * Note that this event is not available by default. To make it available,
35
- * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
36
- * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
37
- *
38
- * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
39
- * @eventName module:engine/view/document~Document#mousemove
40
- * @param data Event data.
41
- */
42
- export type ViewDocumentMouseMoveEvent = {
43
- name: 'mousemove';
44
- args: [data: DomEventData<MouseEvent>];
45
- };
46
- /**
47
- * Fired when the mouse is moved out of one of the editables.
48
- *
49
- * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
50
- *
51
- * Note that this event is not available by default. To make it available,
52
- * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
53
- * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
54
- *
55
- * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
56
- * @eventName module:engine/view/document~Document#mouseleave
57
- * @param data Event data.
58
- */
59
- export type ViewDocumentMouseLeaveEvent = {
60
- name: 'mouseleave';
61
- args: [data: DomEventData<MouseEvent>];
62
- };
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 table/tablemouse/mouseeventsobserver
7
+ */
8
+ import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine';
9
+ /**
10
+ * The mouse selection event observer.
11
+ *
12
+ * It registers listeners for the following DOM events:
13
+ *
14
+ * - `'mousemove'`
15
+ * - `'mouseleave'`
16
+ *
17
+ * Note that this observer is disabled by default. To enable this observer, it needs to be added to
18
+ * {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
19
+ *
20
+ * The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
21
+ */
22
+ export default class MouseEventsObserver extends DomEventObserver<'mousemove' | 'mouseleave'> {
23
+ readonly domEventType: readonly ["mousemove", "mouseleave"];
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ onDomEvent(domEvent: MouseEvent): void;
28
+ }
29
+ /**
30
+ * Fired when the mouse is moved over one of the editables.
31
+ *
32
+ * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
33
+ *
34
+ * Note that this event is not available by default. To make it available,
35
+ * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
36
+ * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
37
+ *
38
+ * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
39
+ * @eventName module:engine/view/document~Document#mousemove
40
+ * @param data Event data.
41
+ */
42
+ export type ViewDocumentMouseMoveEvent = {
43
+ name: 'mousemove';
44
+ args: [data: DomEventData<MouseEvent>];
45
+ };
46
+ /**
47
+ * Fired when the mouse is moved out of one of the editables.
48
+ *
49
+ * Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
50
+ *
51
+ * Note that this event is not available by default. To make it available,
52
+ * {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
53
+ * to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
54
+ *
55
+ * @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
56
+ * @eventName module:engine/view/document~Document#mouseleave
57
+ * @param data Event data.
58
+ */
59
+ export type ViewDocumentMouseLeaveEvent = {
60
+ name: 'mouseleave';
61
+ args: [data: DomEventData<MouseEvent>];
62
+ };
@@ -1,35 +1,35 @@
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 table/tablemouse/mouseeventsobserver
7
- */
8
- import { DomEventObserver } from 'ckeditor5/src/engine';
9
- /**
10
- * The mouse selection event observer.
11
- *
12
- * It registers listeners for the following DOM events:
13
- *
14
- * - `'mousemove'`
15
- * - `'mouseleave'`
16
- *
17
- * Note that this observer is disabled by default. To enable this observer, it needs to be added to
18
- * {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
19
- *
20
- * The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
21
- */
22
- export default class MouseEventsObserver extends DomEventObserver {
23
- constructor() {
24
- super(...arguments);
25
- this.domEventType = [
26
- 'mousemove', 'mouseleave'
27
- ];
28
- }
29
- /**
30
- * @inheritDoc
31
- */
32
- onDomEvent(domEvent) {
33
- this.fire(domEvent.type, domEvent);
34
- }
35
- }
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 table/tablemouse/mouseeventsobserver
7
+ */
8
+ import { DomEventObserver } from 'ckeditor5/src/engine';
9
+ /**
10
+ * The mouse selection event observer.
11
+ *
12
+ * It registers listeners for the following DOM events:
13
+ *
14
+ * - `'mousemove'`
15
+ * - `'mouseleave'`
16
+ *
17
+ * Note that this observer is disabled by default. To enable this observer, it needs to be added to
18
+ * {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
19
+ *
20
+ * The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
21
+ */
22
+ export default class MouseEventsObserver extends DomEventObserver {
23
+ constructor() {
24
+ super(...arguments);
25
+ this.domEventType = [
26
+ 'mousemove', 'mouseleave'
27
+ ];
28
+ }
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ onDomEvent(domEvent) {
33
+ this.fire(domEvent.type, domEvent);
34
+ }
35
+ }
@@ -1,48 +1,48 @@
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 table/tablemouse
7
- */
8
- import { Plugin } from 'ckeditor5/src/core';
9
- import TableSelection from './tableselection';
10
- import TableUtils from './tableutils';
11
- /**
12
- * This plugin enables a table cells' selection with the mouse.
13
- * It is loaded automatically by the {@link module:table/table~Table} plugin.
14
- */
15
- export default class TableMouse extends Plugin {
16
- /**
17
- * @inheritDoc
18
- */
19
- static get pluginName(): "TableMouse";
20
- /**
21
- * @inheritDoc
22
- */
23
- static get requires(): readonly [typeof TableSelection, typeof TableUtils];
24
- /**
25
- * @inheritDoc
26
- */
27
- init(): void;
28
- /**
29
- * Enables making cells selection by <kbd>Shift</kbd>+click. Creates a selection from the cell which previously held
30
- * the selection to the cell which was clicked. It can be the same cell, in which case it selects a single cell.
31
- */
32
- private _enableShiftClickSelection;
33
- /**
34
- * Enables making cells selection by dragging.
35
- *
36
- * The selection is made only on mousemove. Mouse tracking is started on mousedown.
37
- * However, the cells selection is enabled only after the mouse cursor left the anchor cell.
38
- * Thanks to that normal text selection within one cell works just fine. However, you can still select
39
- * just one cell by leaving the anchor cell and moving back to it.
40
- */
41
- private _enableMouseDragSelection;
42
- /**
43
- * Returns the model table cell element based on the target element of the passed DOM event.
44
- *
45
- * @returns Returns the table cell or `undefined`.
46
- */
47
- private _getModelTableCellFromDomEvent;
48
- }
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 table/tablemouse
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ import TableSelection from './tableselection';
10
+ import TableUtils from './tableutils';
11
+ /**
12
+ * This plugin enables a table cells' selection with the mouse.
13
+ * It is loaded automatically by the {@link module:table/table~Table} plugin.
14
+ */
15
+ export default class TableMouse extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): "TableMouse";
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get requires(): readonly [typeof TableSelection, typeof TableUtils];
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ init(): void;
28
+ /**
29
+ * Enables making cells selection by <kbd>Shift</kbd>+click. Creates a selection from the cell which previously held
30
+ * the selection to the cell which was clicked. It can be the same cell, in which case it selects a single cell.
31
+ */
32
+ private _enableShiftClickSelection;
33
+ /**
34
+ * Enables making cells selection by dragging.
35
+ *
36
+ * The selection is made only on mousemove. Mouse tracking is started on mousedown.
37
+ * However, the cells selection is enabled only after the mouse cursor left the anchor cell.
38
+ * Thanks to that normal text selection within one cell works just fine. However, you can still select
39
+ * just one cell by leaving the anchor cell and moving back to it.
40
+ */
41
+ private _enableMouseDragSelection;
42
+ /**
43
+ * Returns the model table cell element based on the target element of the passed DOM event.
44
+ *
45
+ * @returns Returns the table cell or `undefined`.
46
+ */
47
+ private _getModelTableCellFromDomEvent;
48
+ }
package/src/tablemouse.js CHANGED
@@ -1,172 +1,172 @@
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 table/tablemouse
7
- */
8
- import { Plugin } from 'ckeditor5/src/core';
9
- import TableSelection from './tableselection';
10
- import MouseEventsObserver from './tablemouse/mouseeventsobserver';
11
- import TableUtils from './tableutils';
12
- /**
13
- * This plugin enables a table cells' selection with the mouse.
14
- * It is loaded automatically by the {@link module:table/table~Table} plugin.
15
- */
16
- export default class TableMouse extends Plugin {
17
- /**
18
- * @inheritDoc
19
- */
20
- static get pluginName() {
21
- return 'TableMouse';
22
- }
23
- /**
24
- * @inheritDoc
25
- */
26
- static get requires() {
27
- return [TableSelection, TableUtils];
28
- }
29
- /**
30
- * @inheritDoc
31
- */
32
- init() {
33
- const editor = this.editor;
34
- // Currently the MouseObserver only handles `mousedown` and `mouseup` events.
35
- // TODO move to the engine?
36
- editor.editing.view.addObserver(MouseEventsObserver);
37
- this._enableShiftClickSelection();
38
- this._enableMouseDragSelection();
39
- }
40
- /**
41
- * Enables making cells selection by <kbd>Shift</kbd>+click. Creates a selection from the cell which previously held
42
- * the selection to the cell which was clicked. It can be the same cell, in which case it selects a single cell.
43
- */
44
- _enableShiftClickSelection() {
45
- const editor = this.editor;
46
- const tableUtils = editor.plugins.get(TableUtils);
47
- let blockSelectionChange = false;
48
- const tableSelection = editor.plugins.get(TableSelection);
49
- this.listenTo(editor.editing.view.document, 'mousedown', (evt, domEventData) => {
50
- const selection = editor.model.document.selection;
51
- if (!this.isEnabled || !tableSelection.isEnabled) {
52
- return;
53
- }
54
- if (!domEventData.domEvent.shiftKey) {
55
- return;
56
- }
57
- const anchorCell = tableSelection.getAnchorCell() || tableUtils.getTableCellsContainingSelection(selection)[0];
58
- if (!anchorCell) {
59
- return;
60
- }
61
- const targetCell = this._getModelTableCellFromDomEvent(domEventData);
62
- if (targetCell && haveSameTableParent(anchorCell, targetCell)) {
63
- blockSelectionChange = true;
64
- tableSelection.setCellSelection(anchorCell, targetCell);
65
- domEventData.preventDefault();
66
- }
67
- });
68
- this.listenTo(editor.editing.view.document, 'mouseup', () => {
69
- blockSelectionChange = false;
70
- });
71
- // We need to ignore a `selectionChange` event that is fired after we render our new table cells selection.
72
- // When downcasting table cells selection to the view, we put the view selection in the last selected cell
73
- // in a place that may not be natively a "correct" location. This is – we put it directly in the `<td>` element.
74
- // All browsers fire the native `selectionchange` event.
75
- // However, all browsers except Safari return the selection in the exact place where we put it
76
- // (even though it's visually normalized). Safari returns `<td><p>^foo` that makes our selection observer
77
- // fire our `selectionChange` event (because the view selection that we set in the first step differs from the DOM selection).
78
- // Since `selectionChange` is fired, we automatically update the model selection that moves it that paragraph.
79
- // This breaks our dear cells selection.
80
- //
81
- // Theoretically this issue concerns only Safari that is the only browser that do normalize the selection.
82
- // However, to avoid code branching and to have a good coverage for this event blocker, I enabled it for all browsers.
83
- //
84
- // Note: I'm keeping the `blockSelectionChange` state separately for shift+click and mouse drag (exact same logic)
85
- // so I don't have to try to analyze whether they don't overlap in some weird cases. Probably they don't.
86
- // But I have other things to do, like writing this comment.
87
- this.listenTo(editor.editing.view.document, 'selectionChange', evt => {
88
- if (blockSelectionChange) {
89
- // @if CK_DEBUG // console.log( 'Blocked selectionChange to avoid breaking table cells selection.' );
90
- evt.stop();
91
- }
92
- }, { priority: 'highest' });
93
- }
94
- /**
95
- * Enables making cells selection by dragging.
96
- *
97
- * The selection is made only on mousemove. Mouse tracking is started on mousedown.
98
- * However, the cells selection is enabled only after the mouse cursor left the anchor cell.
99
- * Thanks to that normal text selection within one cell works just fine. However, you can still select
100
- * just one cell by leaving the anchor cell and moving back to it.
101
- */
102
- _enableMouseDragSelection() {
103
- const editor = this.editor;
104
- let anchorCell, targetCell;
105
- let beganCellSelection = false;
106
- let blockSelectionChange = false;
107
- const tableSelection = editor.plugins.get(TableSelection);
108
- this.listenTo(editor.editing.view.document, 'mousedown', (evt, domEventData) => {
109
- if (!this.isEnabled || !tableSelection.isEnabled) {
110
- return;
111
- }
112
- // Make sure to not conflict with the shift+click listener and any other possible handler.
113
- if (domEventData.domEvent.shiftKey || domEventData.domEvent.ctrlKey || domEventData.domEvent.altKey) {
114
- return;
115
- }
116
- anchorCell = this._getModelTableCellFromDomEvent(domEventData);
117
- });
118
- this.listenTo(editor.editing.view.document, 'mousemove', (evt, domEventData) => {
119
- if (!domEventData.domEvent.buttons) {
120
- return;
121
- }
122
- if (!anchorCell) {
123
- return;
124
- }
125
- const newTargetCell = this._getModelTableCellFromDomEvent(domEventData);
126
- if (newTargetCell && haveSameTableParent(anchorCell, newTargetCell)) {
127
- targetCell = newTargetCell;
128
- // Switch to the cell selection mode after the mouse cursor left the anchor cell.
129
- // Switch off only on mouseup (makes selecting a single cell possible).
130
- if (!beganCellSelection && targetCell != anchorCell) {
131
- beganCellSelection = true;
132
- }
133
- }
134
- // Yep, not making a cell selection yet. See method docs.
135
- if (!beganCellSelection) {
136
- return;
137
- }
138
- blockSelectionChange = true;
139
- tableSelection.setCellSelection(anchorCell, targetCell);
140
- domEventData.preventDefault();
141
- });
142
- this.listenTo(editor.editing.view.document, 'mouseup', () => {
143
- beganCellSelection = false;
144
- blockSelectionChange = false;
145
- anchorCell = null;
146
- targetCell = null;
147
- });
148
- // See the explanation in `_enableShiftClickSelection()`.
149
- this.listenTo(editor.editing.view.document, 'selectionChange', evt => {
150
- if (blockSelectionChange) {
151
- // @if CK_DEBUG // console.log( 'Blocked selectionChange to avoid breaking table cells selection.' );
152
- evt.stop();
153
- }
154
- }, { priority: 'highest' });
155
- }
156
- /**
157
- * Returns the model table cell element based on the target element of the passed DOM event.
158
- *
159
- * @returns Returns the table cell or `undefined`.
160
- */
161
- _getModelTableCellFromDomEvent(domEventData) {
162
- // Note: Work with positions (not element mapping) because the target element can be an attribute or other non-mapped element.
163
- const viewTargetElement = domEventData.target;
164
- const viewPosition = this.editor.editing.view.createPositionAt(viewTargetElement, 0);
165
- const modelPosition = this.editor.editing.mapper.toModelPosition(viewPosition);
166
- const modelElement = modelPosition.parent;
167
- return modelElement.findAncestor('tableCell', { includeSelf: true });
168
- }
169
- }
170
- function haveSameTableParent(cellA, cellB) {
171
- return cellA.parent.parent == cellB.parent.parent;
172
- }
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 table/tablemouse
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ import TableSelection from './tableselection';
10
+ import MouseEventsObserver from './tablemouse/mouseeventsobserver';
11
+ import TableUtils from './tableutils';
12
+ /**
13
+ * This plugin enables a table cells' selection with the mouse.
14
+ * It is loaded automatically by the {@link module:table/table~Table} plugin.
15
+ */
16
+ export default class TableMouse extends Plugin {
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static get pluginName() {
21
+ return 'TableMouse';
22
+ }
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get requires() {
27
+ return [TableSelection, TableUtils];
28
+ }
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ init() {
33
+ const editor = this.editor;
34
+ // Currently the MouseObserver only handles `mousedown` and `mouseup` events.
35
+ // TODO move to the engine?
36
+ editor.editing.view.addObserver(MouseEventsObserver);
37
+ this._enableShiftClickSelection();
38
+ this._enableMouseDragSelection();
39
+ }
40
+ /**
41
+ * Enables making cells selection by <kbd>Shift</kbd>+click. Creates a selection from the cell which previously held
42
+ * the selection to the cell which was clicked. It can be the same cell, in which case it selects a single cell.
43
+ */
44
+ _enableShiftClickSelection() {
45
+ const editor = this.editor;
46
+ const tableUtils = editor.plugins.get(TableUtils);
47
+ let blockSelectionChange = false;
48
+ const tableSelection = editor.plugins.get(TableSelection);
49
+ this.listenTo(editor.editing.view.document, 'mousedown', (evt, domEventData) => {
50
+ const selection = editor.model.document.selection;
51
+ if (!this.isEnabled || !tableSelection.isEnabled) {
52
+ return;
53
+ }
54
+ if (!domEventData.domEvent.shiftKey) {
55
+ return;
56
+ }
57
+ const anchorCell = tableSelection.getAnchorCell() || tableUtils.getTableCellsContainingSelection(selection)[0];
58
+ if (!anchorCell) {
59
+ return;
60
+ }
61
+ const targetCell = this._getModelTableCellFromDomEvent(domEventData);
62
+ if (targetCell && haveSameTableParent(anchorCell, targetCell)) {
63
+ blockSelectionChange = true;
64
+ tableSelection.setCellSelection(anchorCell, targetCell);
65
+ domEventData.preventDefault();
66
+ }
67
+ });
68
+ this.listenTo(editor.editing.view.document, 'mouseup', () => {
69
+ blockSelectionChange = false;
70
+ });
71
+ // We need to ignore a `selectionChange` event that is fired after we render our new table cells selection.
72
+ // When downcasting table cells selection to the view, we put the view selection in the last selected cell
73
+ // in a place that may not be natively a "correct" location. This is – we put it directly in the `<td>` element.
74
+ // All browsers fire the native `selectionchange` event.
75
+ // However, all browsers except Safari return the selection in the exact place where we put it
76
+ // (even though it's visually normalized). Safari returns `<td><p>^foo` that makes our selection observer
77
+ // fire our `selectionChange` event (because the view selection that we set in the first step differs from the DOM selection).
78
+ // Since `selectionChange` is fired, we automatically update the model selection that moves it that paragraph.
79
+ // This breaks our dear cells selection.
80
+ //
81
+ // Theoretically this issue concerns only Safari that is the only browser that do normalize the selection.
82
+ // However, to avoid code branching and to have a good coverage for this event blocker, I enabled it for all browsers.
83
+ //
84
+ // Note: I'm keeping the `blockSelectionChange` state separately for shift+click and mouse drag (exact same logic)
85
+ // so I don't have to try to analyze whether they don't overlap in some weird cases. Probably they don't.
86
+ // But I have other things to do, like writing this comment.
87
+ this.listenTo(editor.editing.view.document, 'selectionChange', evt => {
88
+ if (blockSelectionChange) {
89
+ // @if CK_DEBUG // console.log( 'Blocked selectionChange to avoid breaking table cells selection.' );
90
+ evt.stop();
91
+ }
92
+ }, { priority: 'highest' });
93
+ }
94
+ /**
95
+ * Enables making cells selection by dragging.
96
+ *
97
+ * The selection is made only on mousemove. Mouse tracking is started on mousedown.
98
+ * However, the cells selection is enabled only after the mouse cursor left the anchor cell.
99
+ * Thanks to that normal text selection within one cell works just fine. However, you can still select
100
+ * just one cell by leaving the anchor cell and moving back to it.
101
+ */
102
+ _enableMouseDragSelection() {
103
+ const editor = this.editor;
104
+ let anchorCell, targetCell;
105
+ let beganCellSelection = false;
106
+ let blockSelectionChange = false;
107
+ const tableSelection = editor.plugins.get(TableSelection);
108
+ this.listenTo(editor.editing.view.document, 'mousedown', (evt, domEventData) => {
109
+ if (!this.isEnabled || !tableSelection.isEnabled) {
110
+ return;
111
+ }
112
+ // Make sure to not conflict with the shift+click listener and any other possible handler.
113
+ if (domEventData.domEvent.shiftKey || domEventData.domEvent.ctrlKey || domEventData.domEvent.altKey) {
114
+ return;
115
+ }
116
+ anchorCell = this._getModelTableCellFromDomEvent(domEventData);
117
+ });
118
+ this.listenTo(editor.editing.view.document, 'mousemove', (evt, domEventData) => {
119
+ if (!domEventData.domEvent.buttons) {
120
+ return;
121
+ }
122
+ if (!anchorCell) {
123
+ return;
124
+ }
125
+ const newTargetCell = this._getModelTableCellFromDomEvent(domEventData);
126
+ if (newTargetCell && haveSameTableParent(anchorCell, newTargetCell)) {
127
+ targetCell = newTargetCell;
128
+ // Switch to the cell selection mode after the mouse cursor left the anchor cell.
129
+ // Switch off only on mouseup (makes selecting a single cell possible).
130
+ if (!beganCellSelection && targetCell != anchorCell) {
131
+ beganCellSelection = true;
132
+ }
133
+ }
134
+ // Yep, not making a cell selection yet. See method docs.
135
+ if (!beganCellSelection) {
136
+ return;
137
+ }
138
+ blockSelectionChange = true;
139
+ tableSelection.setCellSelection(anchorCell, targetCell);
140
+ domEventData.preventDefault();
141
+ });
142
+ this.listenTo(editor.editing.view.document, 'mouseup', () => {
143
+ beganCellSelection = false;
144
+ blockSelectionChange = false;
145
+ anchorCell = null;
146
+ targetCell = null;
147
+ });
148
+ // See the explanation in `_enableShiftClickSelection()`.
149
+ this.listenTo(editor.editing.view.document, 'selectionChange', evt => {
150
+ if (blockSelectionChange) {
151
+ // @if CK_DEBUG // console.log( 'Blocked selectionChange to avoid breaking table cells selection.' );
152
+ evt.stop();
153
+ }
154
+ }, { priority: 'highest' });
155
+ }
156
+ /**
157
+ * Returns the model table cell element based on the target element of the passed DOM event.
158
+ *
159
+ * @returns Returns the table cell or `undefined`.
160
+ */
161
+ _getModelTableCellFromDomEvent(domEventData) {
162
+ // Note: Work with positions (not element mapping) because the target element can be an attribute or other non-mapped element.
163
+ const viewTargetElement = domEventData.target;
164
+ const viewPosition = this.editor.editing.view.createPositionAt(viewTargetElement, 0);
165
+ const modelPosition = this.editor.editing.mapper.toModelPosition(viewPosition);
166
+ const modelElement = modelPosition.parent;
167
+ return modelElement.findAncestor('tableCell', { includeSelf: true });
168
+ }
169
+ }
170
+ function haveSameTableParent(cellA, cellB) {
171
+ return cellA.parent.parent == cellB.parent.parent;
172
+ }