@ckeditor/ckeditor5-table 36.0.1 → 37.0.0-alpha.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 (170) hide show
  1. package/README.md +1 -1
  2. package/build/table.js +1 -1
  3. package/ckeditor5-metadata.json +6 -6
  4. package/package.json +34 -29
  5. package/src/augmentation.d.ts +76 -0
  6. package/src/augmentation.js +5 -0
  7. package/src/commands/insertcolumncommand.d.ts +55 -0
  8. package/src/commands/insertcolumncommand.js +45 -60
  9. package/src/commands/insertrowcommand.d.ts +54 -0
  10. package/src/commands/insertrowcommand.js +44 -59
  11. package/src/commands/inserttablecommand.d.ts +44 -0
  12. package/src/commands/inserttablecommand.js +50 -68
  13. package/src/commands/mergecellcommand.d.ts +68 -0
  14. package/src/commands/mergecellcommand.js +169 -244
  15. package/src/commands/mergecellscommand.d.ts +28 -0
  16. package/src/commands/mergecellscommand.js +72 -101
  17. package/src/commands/removecolumncommand.d.ts +29 -0
  18. package/src/commands/removecolumncommand.js +88 -102
  19. package/src/commands/removerowcommand.d.ts +29 -0
  20. package/src/commands/removerowcommand.js +63 -80
  21. package/src/commands/selectcolumncommand.d.ts +33 -0
  22. package/src/commands/selectcolumncommand.js +41 -54
  23. package/src/commands/selectrowcommand.d.ts +33 -0
  24. package/src/commands/selectrowcommand.js +38 -48
  25. package/src/commands/setheadercolumncommand.d.ts +50 -0
  26. package/src/commands/setheadercolumncommand.js +48 -73
  27. package/src/commands/setheaderrowcommand.d.ts +53 -0
  28. package/src/commands/setheaderrowcommand.js +56 -85
  29. package/src/commands/splitcellcommand.d.ts +43 -0
  30. package/src/commands/splitcellcommand.js +35 -49
  31. package/src/converters/downcast.d.ts +63 -0
  32. package/src/converters/downcast.js +98 -130
  33. package/src/converters/table-caption-post-fixer.d.ts +20 -0
  34. package/src/converters/table-caption-post-fixer.js +36 -52
  35. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -0
  36. package/src/converters/table-cell-paragraph-post-fixer.js +88 -119
  37. package/src/converters/table-cell-refresh-handler.d.ts +18 -0
  38. package/src/converters/table-cell-refresh-handler.js +29 -48
  39. package/src/converters/table-headings-refresh-handler.d.ts +17 -0
  40. package/src/converters/table-headings-refresh-handler.js +35 -54
  41. package/src/converters/table-layout-post-fixer.d.ts +226 -0
  42. package/src/converters/table-layout-post-fixer.js +276 -313
  43. package/src/converters/tableproperties.d.ts +54 -0
  44. package/src/converters/tableproperties.js +136 -168
  45. package/src/converters/upcasttable.d.ts +49 -0
  46. package/src/converters/upcasttable.js +199 -251
  47. package/src/index.d.ts +60 -0
  48. package/src/index.js +1 -2
  49. package/src/plaintableoutput.d.ts +25 -0
  50. package/src/plaintableoutput.js +107 -135
  51. package/src/table.d.ts +33 -0
  52. package/src/table.js +12 -88
  53. package/src/tablecaption/tablecaptionediting.d.ts +63 -0
  54. package/src/tablecaption/tablecaptionediting.js +104 -135
  55. package/src/tablecaption/tablecaptionui.d.ts +21 -0
  56. package/src/tablecaption/tablecaptionui.js +42 -58
  57. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -0
  58. package/src/tablecaption/toggletablecaptioncommand.js +77 -92
  59. package/src/tablecaption/utils.d.ts +42 -0
  60. package/src/tablecaption/utils.js +35 -61
  61. package/src/tablecaption.d.ts +22 -0
  62. package/src/tablecaption.js +12 -19
  63. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -0
  64. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +14 -20
  65. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -0
  66. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +27 -37
  67. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -0
  68. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +27 -37
  69. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -0
  70. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +42 -53
  71. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -0
  72. package/src/tablecellproperties/commands/tablecellheightcommand.js +29 -36
  73. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -0
  74. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +14 -20
  75. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -0
  76. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +42 -53
  77. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -0
  78. package/src/tablecellproperties/commands/tablecellpropertycommand.js +77 -122
  79. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -0
  80. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +14 -20
  81. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +41 -0
  82. package/src/tablecellproperties/tablecellpropertiesediting.js +193 -236
  83. package/src/tablecellproperties/tablecellpropertiesui.d.ts +111 -0
  84. package/src/tablecellproperties/tablecellpropertiesui.js +302 -456
  85. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -0
  86. package/src/tablecellproperties/ui/tablecellpropertiesview.js +509 -844
  87. package/src/tablecellproperties.d.ts +28 -0
  88. package/src/tablecellproperties.js +12 -98
  89. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -0
  90. package/src/tablecellwidth/commands/tablecellwidthcommand.js +29 -35
  91. package/src/tablecellwidth/tablecellwidthediting.d.ts +28 -0
  92. package/src/tablecellwidth/tablecellwidthediting.js +25 -38
  93. package/src/tableclipboard.d.ts +63 -0
  94. package/src/tableclipboard.js +429 -568
  95. package/src/tablecolumnresize/constants.d.ts +20 -0
  96. package/src/tablecolumnresize/constants.js +0 -10
  97. package/src/tablecolumnresize/converters.d.ts +18 -0
  98. package/src/tablecolumnresize/converters.js +35 -119
  99. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +137 -0
  100. package/src/tablecolumnresize/tablecolumnresizeediting.js +545 -711
  101. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -0
  102. package/src/tablecolumnresize/tablewidthscommand.js +61 -0
  103. package/src/tablecolumnresize/utils.d.ts +141 -0
  104. package/src/tablecolumnresize/utils.js +256 -233
  105. package/src/tablecolumnresize.d.ts +24 -0
  106. package/src/tablecolumnresize.js +12 -19
  107. package/src/tableconfig.d.ts +331 -0
  108. package/src/tableconfig.js +5 -0
  109. package/src/tableediting.d.ts +97 -0
  110. package/src/tableediting.js +157 -176
  111. package/src/tablekeyboard.d.ts +63 -0
  112. package/src/tablekeyboard.js +261 -344
  113. package/src/tablemouse/mouseeventsobserver.d.ts +62 -0
  114. package/src/tablemouse/mouseeventsobserver.js +13 -50
  115. package/src/tablemouse.d.ts +46 -0
  116. package/src/tablemouse.js +154 -202
  117. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -0
  118. package/src/tableproperties/commands/tablealignmentcommand.js +14 -20
  119. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -0
  120. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +14 -20
  121. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -0
  122. package/src/tableproperties/commands/tablebordercolorcommand.js +27 -37
  123. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -0
  124. package/src/tableproperties/commands/tableborderstylecommand.js +27 -37
  125. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -0
  126. package/src/tableproperties/commands/tableborderwidthcommand.js +42 -53
  127. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -0
  128. package/src/tableproperties/commands/tableheightcommand.js +29 -33
  129. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -0
  130. package/src/tableproperties/commands/tablepropertycommand.js +68 -112
  131. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -0
  132. package/src/tableproperties/commands/tablewidthcommand.js +29 -33
  133. package/src/tableproperties/tablepropertiesediting.d.ts +39 -0
  134. package/src/tableproperties/tablepropertiesediting.js +163 -210
  135. package/src/tableproperties/tablepropertiesui.d.ts +113 -0
  136. package/src/tableproperties/tablepropertiesui.js +293 -439
  137. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -0
  138. package/src/tableproperties/ui/tablepropertiesview.js +427 -718
  139. package/src/tableproperties.d.ts +28 -0
  140. package/src/tableproperties.js +12 -95
  141. package/src/tableselection.d.ts +106 -0
  142. package/src/tableselection.js +279 -376
  143. package/src/tabletoolbar.d.ts +31 -0
  144. package/src/tabletoolbar.js +38 -92
  145. package/src/tableui.d.ts +53 -0
  146. package/src/tableui.js +281 -338
  147. package/src/tableutils.d.ts +448 -0
  148. package/src/tableutils.js +1015 -1229
  149. package/src/tablewalker.d.ts +323 -0
  150. package/src/tablewalker.js +308 -548
  151. package/src/ui/colorinputview.d.ts +143 -0
  152. package/src/ui/colorinputview.js +229 -366
  153. package/src/ui/formrowview.d.ts +61 -0
  154. package/src/ui/formrowview.js +38 -84
  155. package/src/ui/inserttableview.d.ts +77 -0
  156. package/src/ui/inserttableview.js +152 -242
  157. package/src/utils/common.d.ts +42 -0
  158. package/src/utils/common.js +33 -57
  159. package/src/utils/structure.d.ts +245 -0
  160. package/src/utils/structure.js +261 -379
  161. package/src/utils/table-properties.d.ts +67 -0
  162. package/src/utils/table-properties.js +60 -81
  163. package/src/utils/ui/contextualballoon.d.ts +34 -0
  164. package/src/utils/ui/contextualballoon.js +70 -89
  165. package/src/utils/ui/table-properties.d.ts +193 -0
  166. package/src/utils/ui/table-properties.js +259 -319
  167. package/src/utils/ui/widget.d.ts +16 -0
  168. package/src/utils/ui/widget.js +24 -46
  169. package/src/tablecolumnresize/tablecolumnwidthscommand.js +0 -55
  170. package/src/tablecolumnresize/tablewidthresizecommand.js +0 -65
@@ -2,16 +2,12 @@
2
2
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
4
  */
5
-
6
5
  /**
7
6
  * @module table/commands/setheaderrowcommand
8
7
  */
9
-
10
8
  import { Command } from 'ckeditor5/src/core';
11
-
12
9
  import { updateNumericAttribute } from '../utils/common';
13
10
  import { getVerticallyOverlappingCells, splitHorizontally } from '../utils/structure';
14
-
15
11
  /**
16
12
  * The header row command.
17
13
  *
@@ -19,90 +15,65 @@ import { getVerticallyOverlappingCells, splitHorizontally } from '../utils/struc
19
15
  *
20
16
  * You can make the row containing the selected cell a [header](https://www.w3.org/TR/html50/tabular-data.html#the-th-element) by executing:
21
17
  *
22
- * editor.execute( 'setTableRowHeader' );
18
+ * ```ts
19
+ * editor.execute( 'setTableRowHeader' );
20
+ * ```
23
21
  *
24
22
  * **Note:** All preceding rows will also become headers. If the current row is already a header, executing this command
25
23
  * will make it a regular row back again (including the following rows).
26
- *
27
- * @extends module:core/command~Command
28
24
  */
29
25
  export default class SetHeaderRowCommand extends Command {
30
- /**
31
- * @inheritDoc
32
- */
33
- refresh() {
34
- const tableUtils = this.editor.plugins.get( 'TableUtils' );
35
- const model = this.editor.model;
36
- const selectedCells = tableUtils.getSelectionAffectedTableCells( model.document.selection );
37
- const isInTable = selectedCells.length > 0;
38
-
39
- this.isEnabled = isInTable;
40
-
41
- /**
42
- * Flag indicating whether the command is active. The command is active when the
43
- * {@link module:engine/model/selection~Selection} is in a header row.
44
- *
45
- * @observable
46
- * @readonly
47
- * @member {Boolean} #value
48
- */
49
- this.value = isInTable && selectedCells.every( cell => this._isInHeading( cell, cell.parent.parent ) );
50
- }
51
-
52
- /**
53
- * Executes the command.
54
- *
55
- * When the selection is in a non-header row, the command will set the `headingRows` table attribute to cover that row.
56
- *
57
- * When the selection is already in a header row, it will set `headingRows` so the heading section will end before that row.
58
- *
59
- * @fires execute
60
- * @param {Object} options
61
- * @param {Boolean} [options.forceValue] If set, the command will set (`true`) or unset (`false`) the header rows according to
62
- * the `forceValue` parameter instead of the current model state.
63
- */
64
- execute( options = {} ) {
65
- if ( options.forceValue === this.value ) {
66
- return;
67
- }
68
-
69
- const tableUtils = this.editor.plugins.get( 'TableUtils' );
70
- const model = this.editor.model;
71
-
72
- const selectedCells = tableUtils.getSelectionAffectedTableCells( model.document.selection );
73
- const table = selectedCells[ 0 ].findAncestor( 'table' );
74
-
75
- const { first, last } = tableUtils.getRowIndexes( selectedCells );
76
- const headingRowsToSet = this.value ? first : last + 1;
77
- const currentHeadingRows = table.getAttribute( 'headingRows' ) || 0;
78
-
79
- model.change( writer => {
80
- if ( headingRowsToSet ) {
81
- // Changing heading rows requires to check if any of a heading cell is overlapping vertically the table head.
82
- // Any table cell that has a rowspan attribute > 1 will not exceed the table head so we need to fix it in rows below.
83
- const startRow = headingRowsToSet > currentHeadingRows ? currentHeadingRows : 0;
84
- const overlappingCells = getVerticallyOverlappingCells( table, headingRowsToSet, startRow );
85
-
86
- for ( const { cell } of overlappingCells ) {
87
- splitHorizontally( cell, headingRowsToSet, writer );
88
- }
89
- }
90
-
91
- updateNumericAttribute( 'headingRows', headingRowsToSet, table, writer, 0 );
92
- } );
93
- }
94
-
95
- /**
96
- * Checks if a table cell is in the heading section.
97
- *
98
- * @param {module:engine/model/element~Element} tableCell
99
- * @param {module:engine/model/element~Element} table
100
- * @returns {Boolean}
101
- * @private
102
- */
103
- _isInHeading( tableCell, table ) {
104
- const headingRows = parseInt( table.getAttribute( 'headingRows' ) || 0 );
105
-
106
- return !!headingRows && tableCell.parent.index < headingRows;
107
- }
26
+ /**
27
+ * @inheritDoc
28
+ */
29
+ refresh() {
30
+ const tableUtils = this.editor.plugins.get('TableUtils');
31
+ const model = this.editor.model;
32
+ const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
33
+ const isInTable = selectedCells.length > 0;
34
+ this.isEnabled = isInTable;
35
+ this.value = isInTable && selectedCells.every(cell => this._isInHeading(cell, cell.parent.parent));
36
+ }
37
+ /**
38
+ * Executes the command.
39
+ *
40
+ * When the selection is in a non-header row, the command will set the `headingRows` table attribute to cover that row.
41
+ *
42
+ * When the selection is already in a header row, it will set `headingRows` so the heading section will end before that row.
43
+ *
44
+ * @fires execute
45
+ * @param options.forceValue If set, the command will set (`true`) or unset (`false`) the header rows according to
46
+ * the `forceValue` parameter instead of the current model state.
47
+ */
48
+ execute(options = {}) {
49
+ if (options.forceValue === this.value) {
50
+ return;
51
+ }
52
+ const tableUtils = this.editor.plugins.get('TableUtils');
53
+ const model = this.editor.model;
54
+ const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
55
+ const table = selectedCells[0].findAncestor('table');
56
+ const { first, last } = tableUtils.getRowIndexes(selectedCells);
57
+ const headingRowsToSet = this.value ? first : last + 1;
58
+ const currentHeadingRows = table.getAttribute('headingRows') || 0;
59
+ model.change(writer => {
60
+ if (headingRowsToSet) {
61
+ // Changing heading rows requires to check if any of a heading cell is overlapping vertically the table head.
62
+ // Any table cell that has a rowspan attribute > 1 will not exceed the table head so we need to fix it in rows below.
63
+ const startRow = headingRowsToSet > currentHeadingRows ? currentHeadingRows : 0;
64
+ const overlappingCells = getVerticallyOverlappingCells(table, headingRowsToSet, startRow);
65
+ for (const { cell } of overlappingCells) {
66
+ splitHorizontally(cell, headingRowsToSet, writer);
67
+ }
68
+ }
69
+ updateNumericAttribute('headingRows', headingRowsToSet, table, writer, 0);
70
+ });
71
+ }
72
+ /**
73
+ * Checks if a table cell is in the heading section.
74
+ */
75
+ _isInHeading(tableCell, table) {
76
+ const headingRows = parseInt(table.getAttribute('headingRows') || '0');
77
+ return !!headingRows && tableCell.parent.index < headingRows;
78
+ }
108
79
  }
@@ -0,0 +1,43 @@
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/commands/splitcellcommand
7
+ */
8
+ import { Command, type Editor } from 'ckeditor5/src/core';
9
+ /**
10
+ * The split cell command.
11
+ *
12
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'splitTableCellVertically'`
13
+ * and `'splitTableCellHorizontally'` editor commands.
14
+ *
15
+ * You can split any cell vertically or horizontally by executing this command. For example, to split the selected table cell vertically:
16
+ *
17
+ * ```ts
18
+ * editor.execute( 'splitTableCellVertically' );
19
+ * ```
20
+ */
21
+ export default class SplitCellCommand extends Command {
22
+ /**
23
+ * The direction that indicates which cell will be split.
24
+ */
25
+ readonly direction: 'horizontally' | 'vertically';
26
+ /**
27
+ * Creates a new `SplitCellCommand` instance.
28
+ *
29
+ * @param editor The editor on which this command will be used.
30
+ * @param options.direction Indicates whether the command should split cells `'horizontally'` or `'vertically'`.
31
+ */
32
+ constructor(editor: Editor, options?: {
33
+ direction?: 'horizontally' | 'vertically';
34
+ });
35
+ /**
36
+ * @inheritDoc
37
+ */
38
+ refresh(): void;
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ execute(): void;
43
+ }
@@ -2,13 +2,10 @@
2
2
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
4
  */
5
-
6
5
  /**
7
6
  * @module table/commands/splitcellcommand
8
7
  */
9
-
10
8
  import { Command } from 'ckeditor5/src/core';
11
-
12
9
  /**
13
10
  * The split cell command.
14
11
  *
@@ -17,52 +14,41 @@ import { Command } from 'ckeditor5/src/core';
17
14
  *
18
15
  * You can split any cell vertically or horizontally by executing this command. For example, to split the selected table cell vertically:
19
16
  *
20
- * editor.execute( 'splitTableCellVertically' );
21
- *
22
- * @extends module:core/command~Command
17
+ * ```ts
18
+ * editor.execute( 'splitTableCellVertically' );
19
+ * ```
23
20
  */
24
21
  export default class SplitCellCommand extends Command {
25
- /**
26
- * Creates a new `SplitCellCommand` instance.
27
- *
28
- * @param {module:core/editor/editor~Editor} editor The editor on which this command will be used.
29
- * @param {Object} options
30
- * @param {String} options.direction Indicates whether the command should split cells `'horizontally'` or `'vertically'`.
31
- */
32
- constructor( editor, options = {} ) {
33
- super( editor );
34
-
35
- /**
36
- * The direction that indicates which cell will be split.
37
- *
38
- * @readonly
39
- * @member {String} #direction
40
- */
41
- this.direction = options.direction || 'horizontally';
42
- }
43
-
44
- /**
45
- * @inheritDoc
46
- */
47
- refresh() {
48
- const tableUtils = this.editor.plugins.get( 'TableUtils' );
49
- const selectedCells = tableUtils.getSelectionAffectedTableCells( this.editor.model.document.selection );
50
-
51
- this.isEnabled = selectedCells.length === 1;
52
- }
53
-
54
- /**
55
- * @inheritDoc
56
- */
57
- execute() {
58
- const tableUtils = this.editor.plugins.get( 'TableUtils' );
59
- const tableCell = tableUtils.getSelectionAffectedTableCells( this.editor.model.document.selection )[ 0 ];
60
- const isHorizontal = this.direction === 'horizontally';
61
-
62
- if ( isHorizontal ) {
63
- tableUtils.splitCellHorizontally( tableCell, 2 );
64
- } else {
65
- tableUtils.splitCellVertically( tableCell, 2 );
66
- }
67
- }
22
+ /**
23
+ * Creates a new `SplitCellCommand` instance.
24
+ *
25
+ * @param editor The editor on which this command will be used.
26
+ * @param options.direction Indicates whether the command should split cells `'horizontally'` or `'vertically'`.
27
+ */
28
+ constructor(editor, options = {}) {
29
+ super(editor);
30
+ this.direction = options.direction || 'horizontally';
31
+ }
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ refresh() {
36
+ const tableUtils = this.editor.plugins.get('TableUtils');
37
+ const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
38
+ this.isEnabled = selectedCells.length === 1;
39
+ }
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ execute() {
44
+ const tableUtils = this.editor.plugins.get('TableUtils');
45
+ const tableCell = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection)[0];
46
+ const isHorizontal = this.direction === 'horizontally';
47
+ if (isHorizontal) {
48
+ tableUtils.splitCellHorizontally(tableCell, 2);
49
+ }
50
+ else {
51
+ tableUtils.splitCellVertically(tableCell, 2);
52
+ }
53
+ }
68
54
  }
@@ -0,0 +1,63 @@
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 { Element, ElementCreatorFunction } from 'ckeditor5/src/engine';
6
+ import type TableUtils from '../tableutils';
7
+ import type { AdditionalSlot } from '../tableediting';
8
+ /**
9
+ * Model table element to view table element conversion helper.
10
+ */
11
+ export declare function downcastTable(tableUtils: TableUtils, options: DowncastTableOptions): ElementCreatorFunction;
12
+ /**
13
+ * Model table row element to view `<tr>` element conversion helper.
14
+ *
15
+ * @returns Element creator.
16
+ */
17
+ export declare function downcastRow(): ElementCreatorFunction;
18
+ /**
19
+ * Model table cell element to view `<td>` or `<th>` element conversion helper.
20
+ *
21
+ * This conversion helper will create proper `<th>` elements for table cells that are in the heading section (heading row or column)
22
+ * and `<td>` otherwise.
23
+ *
24
+ * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
25
+ * @returns Element creator.
26
+ */
27
+ export declare function downcastCell(options?: {
28
+ asWidget?: boolean;
29
+ }): ElementCreatorFunction;
30
+ /**
31
+ * Overrides paragraph inside table cell conversion.
32
+ *
33
+ * This converter:
34
+ * * should be used to override default paragraph conversion.
35
+ * * It will only convert `<paragraph>` placed directly inside `<tableCell>`.
36
+ * * For a single paragraph without attributes it returns `<span>` to simulate data table.
37
+ * * For all other cases it returns `<p>` element.
38
+ *
39
+ * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
40
+ * @returns Element creator.
41
+ */
42
+ export declare function convertParagraphInTableCell(options?: {
43
+ asWidget?: boolean;
44
+ }): ElementCreatorFunction;
45
+ /**
46
+ * Checks if given model `<paragraph>` is an only child of a parent (`<tableCell>`) and if it has any attribute set.
47
+ *
48
+ * The paragraph should be converted in the editing view to:
49
+ *
50
+ * * If returned `true` - to a `<span class="ck-table-bogus-paragraph">`
51
+ * * If returned `false` - to a `<p>`
52
+ */
53
+ export declare function isSingleParagraphWithoutAttributes(modelElement: Element): boolean;
54
+ export interface DowncastTableOptions {
55
+ /**
56
+ * If set to `true`, the downcast conversion will produce a widget.
57
+ */
58
+ asWidget?: boolean;
59
+ /**
60
+ * Array of additional slot handlers.
61
+ */
62
+ additionalSlots: Array<AdditionalSlot>;
63
+ }
@@ -2,104 +2,85 @@
2
2
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
4
  */
5
-
6
5
  /**
7
6
  * @module table/converters/downcast
8
7
  */
9
-
10
- import TableWalker from './../tablewalker';
11
8
  import { toWidget, toWidgetEditable } from 'ckeditor5/src/widget';
12
-
9
+ import TableWalker from './../tablewalker';
13
10
  /**
14
11
  * Model table element to view table element conversion helper.
15
- *
16
- * @param {module:table/tableutils~TableUtils} tableUtils The `TableUtils` plugin instance.
17
- * @param {Object} [options]
18
- * @param {Boolean} [options.asWidget] If set to `true`, the downcast conversion will produce a widget.
19
- * @returns {Function} Element creator.
20
12
  */
21
- export function downcastTable( tableUtils, options = {} ) {
22
- return ( table, { writer } ) => {
23
- const headingRows = table.getAttribute( 'headingRows' ) || 0;
24
- const tableSections = [];
25
-
26
- // Table head slot.
27
- if ( headingRows > 0 ) {
28
- tableSections.push(
29
- writer.createContainerElement( 'thead', null,
30
- writer.createSlot( element => element.is( 'element', 'tableRow' ) && element.index < headingRows )
31
- )
32
- );
33
- }
34
-
35
- // Table body slot.
36
- if ( headingRows < tableUtils.getRows( table ) ) {
37
- tableSections.push(
38
- writer.createContainerElement( 'tbody', null,
39
- writer.createSlot( element => element.is( 'element', 'tableRow' ) && element.index >= headingRows )
40
- )
41
- );
42
- }
43
-
44
- const figureElement = writer.createContainerElement( 'figure', { class: 'table' }, [
45
- // Table with proper sections (thead, tbody).
46
- writer.createContainerElement( 'table', null, tableSections ),
47
-
48
- // Slot for the rest (for example caption).
49
- writer.createSlot( element => !element.is( 'element', 'tableRow' ) )
50
- ] );
51
-
52
- return options.asWidget ? toTableWidget( figureElement, writer ) : figureElement;
53
- };
13
+ export function downcastTable(tableUtils, options) {
14
+ return (table, { writer }) => {
15
+ const headingRows = table.getAttribute('headingRows') || 0;
16
+ const tableElement = writer.createContainerElement('table', null, []);
17
+ const figureElement = writer.createContainerElement('figure', { class: 'table' }, tableElement);
18
+ // Table head slot.
19
+ if (headingRows > 0) {
20
+ writer.insert(writer.createPositionAt(tableElement, 'end'), writer.createContainerElement('thead', null, writer.createSlot(element => element.is('element', 'tableRow') && element.index < headingRows)));
21
+ }
22
+ // Table body slot.
23
+ if (headingRows < tableUtils.getRows(table)) {
24
+ writer.insert(writer.createPositionAt(tableElement, 'end'), writer.createContainerElement('tbody', null, writer.createSlot(element => element.is('element', 'tableRow') && element.index >= headingRows)));
25
+ }
26
+ // Dynamic slots.
27
+ for (const { positionOffset, filter } of options.additionalSlots) {
28
+ writer.insert(writer.createPositionAt(tableElement, positionOffset), writer.createSlot(filter));
29
+ }
30
+ // Create a slot with items that don't fit into the table.
31
+ writer.insert(writer.createPositionAt(tableElement, 'after'), writer.createSlot(element => {
32
+ if (element.is('element', 'tableRow')) {
33
+ return false;
34
+ }
35
+ return !options.additionalSlots.some(({ filter }) => filter(element));
36
+ }));
37
+ return options.asWidget ? toTableWidget(figureElement, writer) : figureElement;
38
+ };
54
39
  }
55
-
56
40
  /**
57
41
  * Model table row element to view `<tr>` element conversion helper.
58
42
  *
59
- * @returns {Function} Element creator.
43
+ * @returns Element creator.
60
44
  */
61
45
  export function downcastRow() {
62
- return ( tableRow, { writer } ) => {
63
- return tableRow.isEmpty ?
64
- writer.createEmptyElement( 'tr' ) :
65
- writer.createContainerElement( 'tr' );
66
- };
46
+ return (tableRow, { writer }) => {
47
+ return tableRow.isEmpty ?
48
+ writer.createEmptyElement('tr') :
49
+ writer.createContainerElement('tr');
50
+ };
67
51
  }
68
-
69
52
  /**
70
53
  * Model table cell element to view `<td>` or `<th>` element conversion helper.
71
54
  *
72
55
  * This conversion helper will create proper `<th>` elements for table cells that are in the heading section (heading row or column)
73
56
  * and `<td>` otherwise.
74
57
  *
75
- * @param {Object} [options]
76
- * @param {Boolean} [options.asWidget] If set to `true`, the downcast conversion will produce a widget.
77
- * @returns {Function} Element creator.
58
+ * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
59
+ * @returns Element creator.
78
60
  */
79
- export function downcastCell( options = {} ) {
80
- return ( tableCell, { writer } ) => {
81
- const tableRow = tableCell.parent;
82
- const table = tableRow.parent;
83
- const rowIndex = table.getChildIndex( tableRow );
84
-
85
- const tableWalker = new TableWalker( table, { row: rowIndex } );
86
- const headingRows = table.getAttribute( 'headingRows' ) || 0;
87
- const headingColumns = table.getAttribute( 'headingColumns' ) || 0;
88
-
89
- // We need to iterate over a table in order to get proper row & column values from a walker.
90
- for ( const tableSlot of tableWalker ) {
91
- if ( tableSlot.cell == tableCell ) {
92
- const isHeading = tableSlot.row < headingRows || tableSlot.column < headingColumns;
93
- const cellElementName = isHeading ? 'th' : 'td';
94
-
95
- return options.asWidget ?
96
- toWidgetEditable( writer.createEditableElement( cellElementName ), writer ) :
97
- writer.createContainerElement( cellElementName );
98
- }
99
- }
100
- };
61
+ export function downcastCell(options = {}) {
62
+ return (tableCell, { writer }) => {
63
+ const tableRow = tableCell.parent;
64
+ const table = tableRow.parent;
65
+ const rowIndex = table.getChildIndex(tableRow);
66
+ const tableWalker = new TableWalker(table, { row: rowIndex });
67
+ const headingRows = table.getAttribute('headingRows') || 0;
68
+ const headingColumns = table.getAttribute('headingColumns') || 0;
69
+ let result = null;
70
+ // We need to iterate over a table in order to get proper row & column values from a walker.
71
+ for (const tableSlot of tableWalker) {
72
+ if (tableSlot.cell == tableCell) {
73
+ const isHeading = tableSlot.row < headingRows || tableSlot.column < headingColumns;
74
+ const cellElementName = isHeading ? 'th' : 'td';
75
+ result = options.asWidget ?
76
+ toWidgetEditable(writer.createEditableElement(cellElementName), writer) :
77
+ writer.createContainerElement(cellElementName);
78
+ break;
79
+ }
80
+ }
81
+ return result;
82
+ };
101
83
  }
102
-
103
84
  /**
104
85
  * Overrides paragraph inside table cell conversion.
105
86
  *
@@ -109,33 +90,28 @@ export function downcastCell( options = {} ) {
109
90
  * * For a single paragraph without attributes it returns `<span>` to simulate data table.
110
91
  * * For all other cases it returns `<p>` element.
111
92
  *
112
- * @param {Object} [options]
113
- * @param {Boolean} [options.asWidget] If set to `true`, the downcast conversion will produce a widget.
114
- * @returns {Function} Element creator.
93
+ * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
94
+ * @returns Element creator.
115
95
  */
116
- export function convertParagraphInTableCell( options = {} ) {
117
- return ( modelElement, { writer } ) => {
118
- if ( !modelElement.parent.is( 'element', 'tableCell' ) ) {
119
- return;
120
- }
121
-
122
- if ( !isSingleParagraphWithoutAttributes( modelElement ) ) {
123
- return;
124
- }
125
-
126
- if ( options.asWidget ) {
127
- return writer.createContainerElement( 'span', { class: 'ck-table-bogus-paragraph' } );
128
- } else {
129
- // Using `<p>` in case there are some markers on it and transparentRendering will render it anyway.
130
- const viewElement = writer.createContainerElement( 'p' );
131
-
132
- writer.setCustomProperty( 'dataPipeline:transparentRendering', true, viewElement );
133
-
134
- return viewElement;
135
- }
136
- };
96
+ export function convertParagraphInTableCell(options = {}) {
97
+ return (modelElement, { writer }) => {
98
+ if (!modelElement.parent.is('element', 'tableCell')) {
99
+ return null;
100
+ }
101
+ if (!isSingleParagraphWithoutAttributes(modelElement)) {
102
+ return null;
103
+ }
104
+ if (options.asWidget) {
105
+ return writer.createContainerElement('span', { class: 'ck-table-bogus-paragraph' });
106
+ }
107
+ else {
108
+ // Using `<p>` in case there are some markers on it and transparentRendering will render it anyway.
109
+ const viewElement = writer.createContainerElement('p');
110
+ writer.setCustomProperty('dataPipeline:transparentRendering', true, viewElement);
111
+ return viewElement;
112
+ }
113
+ };
137
114
  }
138
-
139
115
  /**
140
116
  * Checks if given model `<paragraph>` is an only child of a parent (`<tableCell>`) and if it has any attribute set.
141
117
  *
@@ -143,36 +119,28 @@ export function convertParagraphInTableCell( options = {} ) {
143
119
  *
144
120
  * * If returned `true` - to a `<span class="ck-table-bogus-paragraph">`
145
121
  * * If returned `false` - to a `<p>`
146
- *
147
- * @param {module:engine/model/element~Element} modelElement
148
- * @returns {Boolean}
149
122
  */
150
- export function isSingleParagraphWithoutAttributes( modelElement ) {
151
- const tableCell = modelElement.parent;
152
-
153
- const isSingleParagraph = tableCell.childCount == 1;
154
-
155
- return isSingleParagraph && !hasAnyAttribute( modelElement );
123
+ export function isSingleParagraphWithoutAttributes(modelElement) {
124
+ const tableCell = modelElement.parent;
125
+ const isSingleParagraph = tableCell.childCount == 1;
126
+ return isSingleParagraph && !hasAnyAttribute(modelElement);
156
127
  }
157
-
158
- // Converts a given {@link module:engine/view/element~Element} to a table widget:
159
- // * Adds a {@link module:engine/view/element~Element#_setCustomProperty custom property} allowing to recognize the table widget element.
160
- // * Calls the {@link module:widget/utils~toWidget} function with the proper element's label creator.
161
- //
162
- // @param {module:engine/view/element~Element} viewElement
163
- // @param {module:engine/view/downcastwriter~DowncastWriter} writer An instance of the view writer.
164
- // @param {String} label The element's label. It will be concatenated with the table `alt` attribute if one is present.
165
- // @returns {module:engine/view/element~Element}
166
- function toTableWidget( viewElement, writer ) {
167
- writer.setCustomProperty( 'table', true, viewElement );
168
-
169
- return toWidget( viewElement, writer, { hasSelectionHandle: true } );
128
+ /**
129
+ * Converts a given {@link module:engine/view/element~Element} to a table widget:
130
+ * * Adds a {@link module:engine/view/element~Element#_setCustomProperty custom property} allowing to recognize the table widget element.
131
+ * * Calls the {@link module:widget/utils~toWidget} function with the proper element's label creator.
132
+ *
133
+ * @param writer An instance of the view writer.
134
+ * @param label The element's label. It will be concatenated with the table `alt` attribute if one is present.
135
+ */
136
+ function toTableWidget(viewElement, writer) {
137
+ writer.setCustomProperty('table', true, viewElement);
138
+ return toWidget(viewElement, writer, { hasSelectionHandle: true });
170
139
  }
171
-
172
- // Checks if an element has any attributes set.
173
- //
174
- // @param {module:engine/model/element~Element element
175
- // @returns {Boolean}
176
- function hasAnyAttribute( element ) {
177
- return !![ ...element.getAttributeKeys() ].length;
140
+ /**
141
+ * Checks if an element has any attributes set.
142
+ */
143
+ function hasAnyAttribute(element) {
144
+ const iteratorItem = element.getAttributeKeys().next();
145
+ return !iteratorItem.done;
178
146
  }