@ckeditor/ckeditor5-table 36.0.0 → 37.0.0-alpha.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 (166) hide show
  1. package/build/table.js +1 -1
  2. package/package.json +34 -29
  3. package/src/commands/insertcolumncommand.d.ts +61 -0
  4. package/src/commands/insertcolumncommand.js +45 -60
  5. package/src/commands/insertrowcommand.d.ts +60 -0
  6. package/src/commands/insertrowcommand.js +44 -59
  7. package/src/commands/inserttablecommand.d.ts +50 -0
  8. package/src/commands/inserttablecommand.js +51 -68
  9. package/src/commands/mergecellcommand.d.ts +76 -0
  10. package/src/commands/mergecellcommand.js +169 -244
  11. package/src/commands/mergecellscommand.d.ts +33 -0
  12. package/src/commands/mergecellscommand.js +72 -101
  13. package/src/commands/removecolumncommand.d.ts +34 -0
  14. package/src/commands/removecolumncommand.js +88 -102
  15. package/src/commands/removerowcommand.d.ts +34 -0
  16. package/src/commands/removerowcommand.js +63 -80
  17. package/src/commands/selectcolumncommand.d.ts +38 -0
  18. package/src/commands/selectcolumncommand.js +41 -54
  19. package/src/commands/selectrowcommand.d.ts +38 -0
  20. package/src/commands/selectrowcommand.js +38 -48
  21. package/src/commands/setheadercolumncommand.d.ts +55 -0
  22. package/src/commands/setheadercolumncommand.js +48 -73
  23. package/src/commands/setheaderrowcommand.d.ts +58 -0
  24. package/src/commands/setheaderrowcommand.js +56 -85
  25. package/src/commands/splitcellcommand.d.ts +49 -0
  26. package/src/commands/splitcellcommand.js +35 -49
  27. package/src/converters/downcast.d.ts +63 -0
  28. package/src/converters/downcast.js +98 -130
  29. package/src/converters/table-caption-post-fixer.d.ts +20 -0
  30. package/src/converters/table-caption-post-fixer.js +36 -52
  31. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -0
  32. package/src/converters/table-cell-paragraph-post-fixer.js +88 -119
  33. package/src/converters/table-cell-refresh-handler.d.ts +18 -0
  34. package/src/converters/table-cell-refresh-handler.js +29 -48
  35. package/src/converters/table-headings-refresh-handler.d.ts +17 -0
  36. package/src/converters/table-headings-refresh-handler.js +35 -54
  37. package/src/converters/table-layout-post-fixer.d.ts +226 -0
  38. package/src/converters/table-layout-post-fixer.js +276 -313
  39. package/src/converters/tableproperties.d.ts +54 -0
  40. package/src/converters/tableproperties.js +136 -168
  41. package/src/converters/upcasttable.d.ts +49 -0
  42. package/src/converters/upcasttable.js +196 -251
  43. package/src/index.d.ts +29 -0
  44. package/src/index.js +0 -2
  45. package/src/plaintableoutput.d.ts +30 -0
  46. package/src/plaintableoutput.js +107 -135
  47. package/src/table.d.ts +38 -0
  48. package/src/table.js +12 -88
  49. package/src/tablecaption/tablecaptionediting.d.ts +68 -0
  50. package/src/tablecaption/tablecaptionediting.js +104 -135
  51. package/src/tablecaption/tablecaptionui.d.ts +26 -0
  52. package/src/tablecaption/tablecaptionui.js +42 -58
  53. package/src/tablecaption/toggletablecaptioncommand.d.ts +73 -0
  54. package/src/tablecaption/toggletablecaptioncommand.js +77 -92
  55. package/src/tablecaption/utils.d.ts +42 -0
  56. package/src/tablecaption/utils.js +35 -61
  57. package/src/tablecaption.d.ts +27 -0
  58. package/src/tablecaption.js +12 -19
  59. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +37 -0
  60. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +14 -20
  61. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +42 -0
  62. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +27 -37
  63. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +42 -0
  64. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +27 -37
  65. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +56 -0
  66. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +42 -53
  67. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +51 -0
  68. package/src/tablecellproperties/commands/tablecellheightcommand.js +29 -36
  69. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +37 -0
  70. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +14 -20
  71. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +56 -0
  72. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +42 -53
  73. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -0
  74. package/src/tablecellproperties/commands/tablecellpropertycommand.js +77 -122
  75. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +45 -0
  76. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +14 -20
  77. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +47 -0
  78. package/src/tablecellproperties/tablecellpropertiesediting.js +194 -236
  79. package/src/tablecellproperties/tablecellpropertiesui.d.ts +117 -0
  80. package/src/tablecellproperties/tablecellpropertiesui.js +303 -456
  81. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -0
  82. package/src/tablecellproperties/ui/tablecellpropertiesview.js +509 -844
  83. package/src/tablecellproperties.d.ts +33 -0
  84. package/src/tablecellproperties.js +12 -98
  85. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +51 -0
  86. package/src/tablecellwidth/commands/tablecellwidthcommand.js +29 -35
  87. package/src/tablecellwidth/tablecellwidthediting.d.ts +34 -0
  88. package/src/tablecellwidth/tablecellwidthediting.js +26 -38
  89. package/src/tableclipboard.d.ts +68 -0
  90. package/src/tableclipboard.js +429 -568
  91. package/src/tablecolumnresize/constants.d.ts +20 -0
  92. package/src/tablecolumnresize/constants.js +0 -10
  93. package/src/tablecolumnresize/converters.d.ts +18 -0
  94. package/src/tablecolumnresize/converters.js +35 -119
  95. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +142 -0
  96. package/src/tablecolumnresize/tablecolumnresizeediting.js +545 -711
  97. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -0
  98. package/src/tablecolumnresize/tablewidthscommand.js +61 -0
  99. package/src/tablecolumnresize/utils.d.ts +141 -0
  100. package/src/tablecolumnresize/utils.js +256 -233
  101. package/src/tablecolumnresize.d.ts +29 -0
  102. package/src/tablecolumnresize.js +12 -19
  103. package/src/tableconfig.d.ts +341 -0
  104. package/src/tableconfig.js +5 -0
  105. package/src/tableediting.d.ts +102 -0
  106. package/src/tableediting.js +157 -176
  107. package/src/tablekeyboard.d.ts +68 -0
  108. package/src/tablekeyboard.js +261 -344
  109. package/src/tablemouse/mouseeventsobserver.d.ts +62 -0
  110. package/src/tablemouse/mouseeventsobserver.js +12 -49
  111. package/src/tablemouse.d.ts +51 -0
  112. package/src/tablemouse.js +154 -202
  113. package/src/tableproperties/commands/tablealignmentcommand.d.ts +37 -0
  114. package/src/tableproperties/commands/tablealignmentcommand.js +14 -20
  115. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +37 -0
  116. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +14 -20
  117. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +42 -0
  118. package/src/tableproperties/commands/tablebordercolorcommand.js +27 -37
  119. package/src/tableproperties/commands/tableborderstylecommand.d.ts +42 -0
  120. package/src/tableproperties/commands/tableborderstylecommand.js +27 -37
  121. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +56 -0
  122. package/src/tableproperties/commands/tableborderwidthcommand.js +42 -53
  123. package/src/tableproperties/commands/tableheightcommand.d.ts +51 -0
  124. package/src/tableproperties/commands/tableheightcommand.js +29 -33
  125. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -0
  126. package/src/tableproperties/commands/tablepropertycommand.js +68 -112
  127. package/src/tableproperties/commands/tablewidthcommand.d.ts +51 -0
  128. package/src/tableproperties/commands/tablewidthcommand.js +29 -33
  129. package/src/tableproperties/tablepropertiesediting.d.ts +45 -0
  130. package/src/tableproperties/tablepropertiesediting.js +164 -210
  131. package/src/tableproperties/tablepropertiesui.d.ts +119 -0
  132. package/src/tableproperties/tablepropertiesui.js +294 -439
  133. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -0
  134. package/src/tableproperties/ui/tablepropertiesview.js +427 -718
  135. package/src/tableproperties.d.ts +33 -0
  136. package/src/tableproperties.js +12 -95
  137. package/src/tableselection.d.ts +111 -0
  138. package/src/tableselection.js +279 -376
  139. package/src/tabletoolbar.d.ts +37 -0
  140. package/src/tabletoolbar.js +39 -92
  141. package/src/tableui.d.ts +58 -0
  142. package/src/tableui.js +281 -338
  143. package/src/tableutils.d.ts +453 -0
  144. package/src/tableutils.js +1015 -1229
  145. package/src/tablewalker.d.ts +323 -0
  146. package/src/tablewalker.js +308 -548
  147. package/src/ui/colorinputview.d.ts +143 -0
  148. package/src/ui/colorinputview.js +229 -366
  149. package/src/ui/formrowview.d.ts +61 -0
  150. package/src/ui/formrowview.js +38 -84
  151. package/src/ui/inserttableview.d.ts +77 -0
  152. package/src/ui/inserttableview.js +152 -242
  153. package/src/utils/common.d.ts +42 -0
  154. package/src/utils/common.js +33 -57
  155. package/src/utils/structure.d.ts +245 -0
  156. package/src/utils/structure.js +261 -379
  157. package/src/utils/table-properties.d.ts +67 -0
  158. package/src/utils/table-properties.js +60 -81
  159. package/src/utils/ui/contextualballoon.d.ts +34 -0
  160. package/src/utils/ui/contextualballoon.js +70 -89
  161. package/src/utils/ui/table-properties.d.ts +193 -0
  162. package/src/utils/ui/table-properties.js +259 -319
  163. package/src/utils/ui/widget.d.ts +16 -0
  164. package/src/utils/ui/widget.js +24 -46
  165. package/src/tablecolumnresize/tablecolumnwidthscommand.js +0 -55
  166. package/src/tablecolumnresize/tablewidthresizecommand.js +0 -65
@@ -2,221 +2,187 @@
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
- /**
7
- * @module table/tablecolumnresize/utils
8
- */
9
-
10
5
  import { global } from 'ckeditor5/src/utils';
11
- import {
12
- COLUMN_WIDTH_PRECISION,
13
- COLUMN_MIN_WIDTH_AS_PERCENTAGE,
14
- COLUMN_MIN_WIDTH_IN_PIXELS
15
- } from './constants';
16
-
6
+ import { COLUMN_WIDTH_PRECISION, COLUMN_MIN_WIDTH_AS_PERCENTAGE, COLUMN_MIN_WIDTH_IN_PIXELS } from './constants';
17
7
  /**
18
8
  * Returns all the inserted or changed table model elements in a given change set. Only the tables
19
9
  * with 'columnsWidth' attribute are taken into account. The returned set may be empty.
20
10
  *
21
11
  * Most notably if an entire table is removed it will not be included in returned set.
22
12
  *
23
- * @param {module:engine/model/model~Model} model The model to collect the affected elements from.
24
- * @returns {Set.<module:engine/model/element~Element>} A set of table model elements.
13
+ * @param model The model to collect the affected elements from.
14
+ * @returns A set of table model elements.
25
15
  */
26
- export function getChangedResizedTables( model ) {
27
- const affectedTables = new Set();
28
-
29
- for ( const change of model.document.differ.getChanges() ) {
30
- let referencePosition = null;
31
-
32
- // Checks if the particular change from the differ is:
33
- // - an insertion or removal of a table, a row or a cell,
34
- // - an attribute change on a table, a row or a cell.
35
- switch ( change.type ) {
36
- case 'insert':
37
- referencePosition = [ 'table', 'tableRow', 'tableCell' ].includes( change.name ) ?
38
- change.position :
39
- null;
40
-
41
- break;
42
-
43
- case 'remove':
44
- // If the whole table is removed, there's no need to update its column widths (#12201).
45
- referencePosition = [ 'tableRow', 'tableCell' ].includes( change.name ) ?
46
- change.position :
47
- null;
48
-
49
- break;
50
-
51
- case 'attribute':
52
- if ( change.range.start.nodeAfter ) {
53
- referencePosition = [ 'table', 'tableRow', 'tableCell' ].includes( change.range.start.nodeAfter.name ) ?
54
- change.range.start :
55
- null;
56
- }
57
-
58
- break;
59
- }
60
-
61
- if ( !referencePosition ) {
62
- continue;
63
- }
64
-
65
- const tableNode = ( referencePosition.nodeAfter && referencePosition.nodeAfter.name === 'table' ) ?
66
- referencePosition.nodeAfter : referencePosition.findAncestor( 'table' );
67
-
68
- // We iterate over the whole table looking for the nested tables that are also affected.
69
- for ( const node of model.createRangeOn( tableNode ).getItems() ) {
70
- if ( node.is( 'element' ) && node.name === 'table' && node.hasAttribute( 'columnWidths' ) ) {
71
- affectedTables.add( node );
72
- }
73
- }
74
- }
75
-
76
- return affectedTables;
16
+ export function getChangedResizedTables(model) {
17
+ const affectedTables = new Set();
18
+ for (const change of model.document.differ.getChanges()) {
19
+ let referencePosition = null;
20
+ // Checks if the particular change from the differ is:
21
+ // - an insertion or removal of a table, a row or a cell,
22
+ // - an attribute change on a table, a row or a cell.
23
+ switch (change.type) {
24
+ case 'insert':
25
+ referencePosition = ['table', 'tableRow', 'tableCell'].includes(change.name) ?
26
+ change.position :
27
+ null;
28
+ break;
29
+ case 'remove':
30
+ // If the whole table is removed, there's no need to update its column widths (#12201).
31
+ referencePosition = ['tableRow', 'tableCell'].includes(change.name) ?
32
+ change.position :
33
+ null;
34
+ break;
35
+ case 'attribute':
36
+ if (change.range.start.nodeAfter) {
37
+ referencePosition = ['table', 'tableRow', 'tableCell'].includes(change.range.start.nodeAfter.name) ?
38
+ change.range.start :
39
+ null;
40
+ }
41
+ break;
42
+ }
43
+ if (!referencePosition) {
44
+ continue;
45
+ }
46
+ const tableNode = (referencePosition.nodeAfter && referencePosition.nodeAfter.is('element', 'table')) ?
47
+ referencePosition.nodeAfter : referencePosition.findAncestor('table');
48
+ // We iterate over the whole table looking for the nested tables that are also affected.
49
+ for (const node of model.createRangeOn(tableNode).getItems()) {
50
+ if (!node.is('element', 'table')) {
51
+ continue;
52
+ }
53
+ if (!getColumnGroupElement(node)) {
54
+ continue;
55
+ }
56
+ affectedTables.add(node);
57
+ }
58
+ }
59
+ return affectedTables;
77
60
  }
78
-
79
61
  /**
80
62
  * Calculates the percentage of the minimum column width given in pixels for a given table.
81
63
  *
82
- * @param {module:engine/model/element~Element} modelTable A table model element.
83
- * @param {module:core/editor/editor~Editor} editor The editor instance.
84
- * @returns {Number} The minimal column width in percentage.
64
+ * @param modelTable A table model element.
65
+ * @param editor The editor instance.
66
+ * @returns The minimal column width in percentage.
85
67
  */
86
- export function getColumnMinWidthAsPercentage( modelTable, editor ) {
87
- return COLUMN_MIN_WIDTH_IN_PIXELS * 100 / getTableWidthInPixels( modelTable, editor );
68
+ export function getColumnMinWidthAsPercentage(modelTable, editor) {
69
+ return COLUMN_MIN_WIDTH_IN_PIXELS * 100 / getTableWidthInPixels(modelTable, editor);
88
70
  }
89
-
90
71
  /**
91
72
  * Calculates the table width in pixels.
92
73
  *
93
- * @param {module:engine/model/element~Element} modelTable A table model element.
94
- * @param {module:core/editor/editor~Editor} editor The editor instance.
95
- * @returns {Number} The width of the table in pixels.
74
+ * @param modelTable A table model element.
75
+ * @param editor The editor instance.
76
+ * @returns The width of the table in pixels.
96
77
  */
97
- export function getTableWidthInPixels( modelTable, editor ) {
98
- // It is possible for a table to not have a <tbody> element - see #11878.
99
- const referenceElement = getChildrenViewElement( modelTable, 'tbody', editor ) || getChildrenViewElement( modelTable, 'thead', editor );
100
- const domReferenceElement = editor.editing.view.domConverter.mapViewToDom( referenceElement );
101
-
102
- return getElementWidthInPixels( domReferenceElement );
78
+ export function getTableWidthInPixels(modelTable, editor) {
79
+ // It is possible for a table to not have a <tbody> element - see #11878.
80
+ const referenceElement = getChildrenViewElement(modelTable, 'tbody', editor) || getChildrenViewElement(modelTable, 'thead', editor);
81
+ const domReferenceElement = editor.editing.view.domConverter.mapViewToDom(referenceElement);
82
+ return getElementWidthInPixels(domReferenceElement);
103
83
  }
104
-
105
- // Returns the a view element with a given name that is nested directly in a `<table>` element
106
- // related to a given `modelTable`.
107
- //
108
- // @private
109
- // @param {module:engine/model/element~Element} table
110
- // @param {module:core/editor/editor~Editor} editor
111
- // @param {String} elementName Name of a view to be looked for, e.g. `'colgroup`', `'thead`'.
112
- // @returns {module:engine/view/element~Element|undefined} Matched view or `undefined` otherwise.
113
- function getChildrenViewElement( modelTable, elementName, editor ) {
114
- const viewFigure = editor.editing.mapper.toViewElement( modelTable );
115
- const viewTable = [ ...viewFigure.getChildren() ].find( viewChild => viewChild.is( 'element', 'table' ) );
116
-
117
- return [ ...viewTable.getChildren() ].find( viewChild => viewChild.is( 'element', elementName ) );
84
+ /**
85
+ * Returns the a view element with a given name that is nested directly in a `<table>` element
86
+ * related to a given `modelTable`.
87
+ *
88
+ * @param elementName Name of a view to be looked for, e.g. `'colgroup`', `'thead`'.
89
+ * @returns Matched view or `undefined` otherwise.
90
+ */
91
+ function getChildrenViewElement(modelTable, elementName, editor) {
92
+ const viewFigure = editor.editing.mapper.toViewElement(modelTable);
93
+ const viewTable = [...viewFigure.getChildren()]
94
+ .find((node) => node.is('element', 'table'));
95
+ return [...viewTable.getChildren()]
96
+ .find((node) => node.is('element', elementName));
118
97
  }
119
-
120
98
  /**
121
99
  * Returns the computed width (in pixels) of the DOM element without padding and borders.
122
100
  *
123
- * @param {HTMLElement} domElement A DOM element.
124
- * @returns {Number} The width of the DOM element in pixels.
101
+ * @param domElement A DOM element.
102
+ * @returns The width of the DOM element in pixels.
125
103
  */
126
- export function getElementWidthInPixels( domElement ) {
127
- const styles = global.window.getComputedStyle( domElement );
128
-
129
- // In the 'border-box' box sizing algorithm, the element's width
130
- // already includes the padding and border width (#12335).
131
- if ( styles.boxSizing === 'border-box' ) {
132
- return parseFloat( styles.width ) -
133
- parseFloat( styles.paddingLeft ) -
134
- parseFloat( styles.paddingRight ) -
135
- parseFloat( styles.borderLeftWidth ) -
136
- parseFloat( styles.borderRightWidth );
137
- } else {
138
- return parseFloat( styles.width );
139
- }
104
+ export function getElementWidthInPixels(domElement) {
105
+ const styles = global.window.getComputedStyle(domElement);
106
+ // In the 'border-box' box sizing algorithm, the element's width
107
+ // already includes the padding and border width (#12335).
108
+ if (styles.boxSizing === 'border-box') {
109
+ return parseFloat(styles.width) -
110
+ parseFloat(styles.paddingLeft) -
111
+ parseFloat(styles.paddingRight) -
112
+ parseFloat(styles.borderLeftWidth) -
113
+ parseFloat(styles.borderRightWidth);
114
+ }
115
+ else {
116
+ return parseFloat(styles.width);
117
+ }
140
118
  }
141
-
142
119
  /**
143
120
  * Returns the column indexes on the left and right edges of a cell. They differ if the cell spans
144
121
  * across multiple columns.
145
122
  *
146
- * @param {module:engine/model/element~Element} cell A table cell model element.
147
- * @param {module:table/tableutils~TableUtils} tableUtils The Table Utils plugin instance.
148
- * @returns {Object} An object containing the indexes of the left and right edges of the cell.
149
- * @returns {Number} return.leftEdge The index of the left edge of the cell.
150
- * @returns {Number} return.rightEdge The index of the right edge of the cell.
123
+ * @param cell A table cell model element.
124
+ * @param tableUtils The Table Utils plugin instance.
125
+ * @returns An object containing the indexes of the left and right edges of the cell.
151
126
  */
152
- export function getColumnEdgesIndexes( cell, tableUtils ) {
153
- const cellColumnIndex = tableUtils.getCellLocation( cell ).column;
154
- const cellWidth = cell.getAttribute( 'colspan' ) || 1;
155
-
156
- return {
157
- leftEdge: cellColumnIndex,
158
- rightEdge: cellColumnIndex + cellWidth - 1
159
- };
127
+ export function getColumnEdgesIndexes(cell, tableUtils) {
128
+ const cellColumnIndex = tableUtils.getCellLocation(cell).column;
129
+ const cellWidth = cell.getAttribute('colspan') || 1;
130
+ return {
131
+ leftEdge: cellColumnIndex,
132
+ rightEdge: cellColumnIndex + cellWidth - 1
133
+ };
160
134
  }
161
-
162
135
  /**
163
136
  * Rounds the provided value to a fixed-point number with defined number of digits after the decimal point.
164
137
  *
165
- * @param {Number|String} value A number to be rounded.
166
- * @returns {Number} The rounded number.
138
+ * @param value A number to be rounded.
139
+ * @returns The rounded number.
167
140
  */
168
- export function toPrecision( value ) {
169
- const multiplier = Math.pow( 10, COLUMN_WIDTH_PRECISION );
170
- const number = parseFloat( value );
171
-
172
- return Math.round( number * multiplier ) / multiplier;
141
+ export function toPrecision(value) {
142
+ const multiplier = Math.pow(10, COLUMN_WIDTH_PRECISION);
143
+ const number = typeof value === 'number' ? value : parseFloat(value);
144
+ return Math.round(number * multiplier) / multiplier;
173
145
  }
174
-
175
146
  /**
176
147
  * Clamps the number within the inclusive lower (min) and upper (max) bounds. Returned number is rounded using the
177
148
  * {@link ~toPrecision `toPrecision()`} function.
178
149
  *
179
- * @param {Number} number A number to be clamped.
180
- * @param {Number} min A lower bound.
181
- * @param {Number} max An upper bound.
182
- * @returns {Number} The clamped number.
150
+ * @param number A number to be clamped.
151
+ * @param min A lower bound.
152
+ * @param max An upper bound.
153
+ * @returns The clamped number.
183
154
  */
184
- export function clamp( number, min, max ) {
185
- if ( number <= min ) {
186
- return toPrecision( min );
187
- }
188
-
189
- if ( number >= max ) {
190
- return toPrecision( max );
191
- }
192
-
193
- return toPrecision( number );
155
+ export function clamp(number, min, max) {
156
+ if (number <= min) {
157
+ return toPrecision(min);
158
+ }
159
+ if (number >= max) {
160
+ return toPrecision(max);
161
+ }
162
+ return toPrecision(number);
194
163
  }
195
-
196
164
  /**
197
165
  * Creates an array with defined length and fills all elements with defined value.
198
166
  *
199
- * @param {Number} length The length of the array.
200
- * @param {*} value The value to fill the array with.
201
- * @returns {Array.<*>} An array with defined length and filled with defined value.
167
+ * @param length The length of the array.
168
+ * @param value The value to fill the array with.
169
+ * @returns An array with defined length and filled with defined value.
202
170
  */
203
- export function createFilledArray( length, value ) {
204
- return Array( length ).fill( value );
171
+ export function createFilledArray(length, value) {
172
+ return Array(length).fill(value);
205
173
  }
206
-
207
174
  /**
208
175
  * Sums all array values that can be parsed to a float.
209
176
  *
210
- * @param {Array.<Number>} array An array of numbers.
211
- * @returns {Number} The sum of all array values.
177
+ * @param array An array of numbers.
178
+ * @returns The sum of all array values.
212
179
  */
213
- export function sumArray( array ) {
214
- return array
215
- .map( value => parseFloat( value ) )
216
- .filter( value => !Number.isNaN( value ) )
217
- .reduce( ( result, item ) => result + item, 0 );
180
+ export function sumArray(array) {
181
+ return array
182
+ .map(value => typeof value === 'number' ? value : parseFloat(value))
183
+ .filter(value => !Number.isNaN(value))
184
+ .reduce((result, item) => result + item, 0);
218
185
  }
219
-
220
186
  /**
221
187
  * Makes sure that the sum of the widths from all columns is 100%. If the sum of all the widths is not equal 100%, all the widths are
222
188
  * changed proportionally so that they all sum back to 100%. If there are columns without specified width, the amount remaining
@@ -224,84 +190,141 @@ export function sumArray( array ) {
224
190
  *
225
191
  * Currently, only widths provided as percentage values are supported.
226
192
  *
227
- * @param {Array.<Number>} columnWidths An array of column widths.
228
- * @returns {Array.<Number>} An array of column widths guaranteed to sum up to 100%.
193
+ * @param columnWidths An array of column widths.
194
+ * @returns An array of column widths guaranteed to sum up to 100%.
229
195
  */
230
- export function normalizeColumnWidths( columnWidths ) {
231
- columnWidths = calculateMissingColumnWidths( columnWidths );
232
- const totalWidth = sumArray( columnWidths );
233
-
234
- if ( totalWidth === 100 ) {
235
- return columnWidths;
236
- }
237
-
238
- return columnWidths
239
- // Adjust all the columns proportionally.
240
- .map( columnWidth => toPrecision( columnWidth * 100 / totalWidth ) )
241
- // Due to rounding of numbers it may happen that the sum of the widths of all columns will not be exactly 100%. Therefore, the width
242
- // of the last column is explicitly adjusted (narrowed or expanded), since all the columns have been proportionally changed already.
243
- .map( ( columnWidth, columnIndex, columnWidths ) => {
244
- const isLastColumn = columnIndex === columnWidths.length - 1;
245
-
246
- if ( !isLastColumn ) {
247
- return columnWidth;
248
- }
249
-
250
- const totalWidth = sumArray( columnWidths );
251
-
252
- return toPrecision( columnWidth + 100 - totalWidth );
253
- } );
196
+ export function normalizeColumnWidths(columnWidths) {
197
+ const widths = columnWidths.map(width => {
198
+ // Possible values are 'auto' or string ending with '%'
199
+ if (width === 'auto') {
200
+ return width;
201
+ }
202
+ return parseFloat(width.replace('%', ''));
203
+ });
204
+ let normalizedWidths = calculateMissingColumnWidths(widths);
205
+ const totalWidth = sumArray(normalizedWidths);
206
+ if (totalWidth !== 100) {
207
+ normalizedWidths = normalizedWidths
208
+ // Adjust all the columns proportionally.
209
+ .map(width => toPrecision(width * 100 / totalWidth))
210
+ // Due to rounding of numbers it may happen that the sum of the widths of all columns will not be exactly 100%.
211
+ // Therefore, the width of the last column is explicitly adjusted (narrowed or expanded), since all the columns
212
+ // have been proportionally changed already.
213
+ .map((columnWidth, columnIndex, width) => {
214
+ const isLastColumn = columnIndex === width.length - 1;
215
+ if (!isLastColumn) {
216
+ return columnWidth;
217
+ }
218
+ const totalWidth = sumArray(width);
219
+ return toPrecision(columnWidth + 100 - totalWidth);
220
+ });
221
+ }
222
+ return normalizedWidths.map(width => width + '%');
254
223
  }
255
-
256
- // Initializes the column widths by parsing the attribute value and calculating the uninitialized column widths. The special value 'auto'
257
- // indicates that width for the column must be calculated. The width of such uninitialized column is calculated as follows:
258
- // - If there is enough free space in the table for all uninitialized columns to have at least the minimum allowed width for all of them,
259
- // then set this width equally for all uninitialized columns.
260
- // - Otherwise, just set the minimum allowed width for all uninitialized columns. The sum of all column widths will be greater than 100%,
261
- // but then it will be adjusted proportionally to 100% in {@link #normalizeColumnWidths `normalizeColumnWidths()`}.
262
- //
263
- // @private
264
- // @param {Array.<Number>} columnWidths An array of column widths.
265
- // @returns {Array.<Number>} An array with 'auto' values replaced with calculated widths.
266
- function calculateMissingColumnWidths( columnWidths ) {
267
- const numberOfUninitializedColumns = columnWidths.filter( columnWidth => columnWidth === 'auto' ).length;
268
-
269
- if ( numberOfUninitializedColumns === 0 ) {
270
- return columnWidths.map( columnWidth => toPrecision( columnWidth ) );
271
- }
272
-
273
- const totalWidthOfInitializedColumns = sumArray( columnWidths );
274
-
275
- const widthForUninitializedColumn = Math.max(
276
- ( 100 - totalWidthOfInitializedColumns ) / numberOfUninitializedColumns,
277
- COLUMN_MIN_WIDTH_AS_PERCENTAGE
278
- );
279
-
280
- return columnWidths
281
- .map( columnWidth => columnWidth === 'auto' ? widthForUninitializedColumn : columnWidth )
282
- .map( columnWidth => toPrecision( columnWidth ) );
224
+ /**
225
+ * Initializes the column widths by parsing the attribute value and calculating the uninitialized column widths. The special value 'auto'
226
+ * indicates that width for the column must be calculated. The width of such uninitialized column is calculated as follows:
227
+ * - If there is enough free space in the table for all uninitialized columns to have at least the minimum allowed width for all of them,
228
+ * then set this width equally for all uninitialized columns.
229
+ * - Otherwise, just set the minimum allowed width for all uninitialized columns. The sum of all column widths will be greater than 100%,
230
+ * but then it will be adjusted proportionally to 100% in {@link #normalizeColumnWidths `normalizeColumnWidths()`}.
231
+ *
232
+ * @param columnWidths An array of column widths.
233
+ * @returns An array with 'auto' values replaced with calculated widths.
234
+ */
235
+ function calculateMissingColumnWidths(columnWidths) {
236
+ const numberOfUninitializedColumns = columnWidths.filter(columnWidth => columnWidth === 'auto').length;
237
+ if (numberOfUninitializedColumns === 0) {
238
+ return columnWidths.map(columnWidth => toPrecision(columnWidth));
239
+ }
240
+ const totalWidthOfInitializedColumns = sumArray(columnWidths);
241
+ const widthForUninitializedColumn = Math.max((100 - totalWidthOfInitializedColumns) / numberOfUninitializedColumns, COLUMN_MIN_WIDTH_AS_PERCENTAGE);
242
+ return columnWidths
243
+ .map(columnWidth => columnWidth === 'auto' ? widthForUninitializedColumn : columnWidth)
244
+ .map(columnWidth => toPrecision(columnWidth));
283
245
  }
284
-
285
246
  /**
286
247
  * Calculates the total horizontal space taken by the cell. That includes:
287
248
  * * width,
288
249
  * * left and red padding,
289
250
  * * border width.
290
251
  *
291
- * @param {HTMLElement} domCell A DOM cell element.
292
- * @returns {Number} Width in pixels without `px` at the end.
252
+ * @param domCell A DOM cell element.
253
+ * @returns Width in pixels without `px` at the end.
254
+ */
255
+ export function getDomCellOuterWidth(domCell) {
256
+ const styles = global.window.getComputedStyle(domCell);
257
+ // In the 'border-box' box sizing algorithm, the element's width
258
+ // already includes the padding and border width (#12335).
259
+ if (styles.boxSizing === 'border-box') {
260
+ return parseInt(styles.width);
261
+ }
262
+ else {
263
+ return parseFloat(styles.width) +
264
+ parseFloat(styles.paddingLeft) +
265
+ parseFloat(styles.paddingRight) +
266
+ parseFloat(styles.borderWidth);
267
+ }
268
+ }
269
+ /**
270
+ * Updates column elements to match columns widths.
271
+ *
272
+ * @param columns
273
+ * @param tableColumnGroup
274
+ * @param normalizedWidths
275
+ * @param writer
276
+ */
277
+ export function updateColumnElements(columns, tableColumnGroup, normalizedWidths, writer) {
278
+ for (let i = 0; i < Math.max(normalizedWidths.length, columns.length); i++) {
279
+ const column = columns[i];
280
+ const columnWidth = normalizedWidths[i];
281
+ if (!columnWidth) {
282
+ // Number of `<tableColumn>` elements exceeds actual number of columns.
283
+ writer.remove(column);
284
+ }
285
+ else if (!column) {
286
+ // There is fewer `<tableColumn>` elements than actual columns.
287
+ writer.appendElement('tableColumn', { columnWidth }, tableColumnGroup);
288
+ }
289
+ else {
290
+ // Update column width.
291
+ writer.setAttribute('columnWidth', columnWidth, column);
292
+ }
293
+ }
294
+ }
295
+ /**
296
+ * Returns a 'tableColumnGroup' element from the 'table'.
297
+ *
298
+ * @internal
299
+ * @param element A 'table' or 'tableColumnGroup' element.
300
+ * @returns A 'tableColumnGroup' element.
301
+ */
302
+ export function getColumnGroupElement(element) {
303
+ if (element.is('element', 'tableColumnGroup')) {
304
+ return element;
305
+ }
306
+ const children = element.getChildren();
307
+ return Array
308
+ .from(children)
309
+ .find(element => element.is('element', 'tableColumnGroup'));
310
+ }
311
+ /**
312
+ * Returns an array of 'tableColumn' elements.
313
+ *
314
+ * @internal
315
+ * @param element A 'table' or 'tableColumnGroup' element.
316
+ * @returns An array of 'tableColumn' elements.
317
+ */
318
+ export function getTableColumnElements(element) {
319
+ return Array.from(getColumnGroupElement(element).getChildren());
320
+ }
321
+ /**
322
+ * Returns an array of table column widths.
323
+ *
324
+ * @internal
325
+ * @param element A 'table' or 'tableColumnGroup' element.
326
+ * @returns An array of table column widths.
293
327
  */
294
- export function getDomCellOuterWidth( domCell ) {
295
- const styles = global.window.getComputedStyle( domCell );
296
-
297
- // In the 'border-box' box sizing algorithm, the element's width
298
- // already includes the padding and border width (#12335).
299
- if ( styles.boxSizing === 'border-box' ) {
300
- return parseInt( styles.width );
301
- } else {
302
- return parseFloat( styles.width ) +
303
- parseFloat( styles.paddingLeft ) +
304
- parseFloat( styles.paddingRight ) +
305
- parseFloat( styles.borderWidth );
306
- }
328
+ export function getTableColumnsWidths(element) {
329
+ return getTableColumnElements(element).map(column => column.getAttribute('columnWidth'));
307
330
  }
@@ -0,0 +1,29 @@
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/tablecolumnresize
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ import '../theme/tablecolumnresize.css';
10
+ /**
11
+ * The table column resize feature.
12
+ *
13
+ * It provides the possibility to set the width of each column in a table using a resize handler.
14
+ */
15
+ export default class TableColumnResize extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get requires(): PluginDependencies;
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get pluginName(): 'TableColumnResize';
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [TableColumnResize.pluginName]: TableColumnResize;
28
+ }
29
+ }
@@ -2,36 +2,29 @@
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/tablecolumnresize
8
7
  */
9
-
10
8
  import { Plugin } from 'ckeditor5/src/core';
11
9
  import TableColumnResizeEditing from './tablecolumnresize/tablecolumnresizeediting';
12
10
  import TableCellWidthEditing from './tablecellwidth/tablecellwidthediting';
13
-
14
11
  import '../theme/tablecolumnresize.css';
15
-
16
12
  /**
17
13
  * The table column resize feature.
18
14
  *
19
15
  * It provides the possibility to set the width of each column in a table using a resize handler.
20
- *
21
- * @extends module:core/plugin~Plugin
22
16
  */
23
17
  export default class TableColumnResize extends Plugin {
24
- /**
25
- * @inheritDoc
26
- */
27
- static get requires() {
28
- return [ TableColumnResizeEditing, TableCellWidthEditing ];
29
- }
30
-
31
- /**
32
- * @inheritDoc
33
- */
34
- static get pluginName() {
35
- return 'TableColumnResize';
36
- }
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ static get requires() {
22
+ return [TableColumnResizeEditing, TableCellWidthEditing];
23
+ }
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static get pluginName() {
28
+ return 'TableColumnResize';
29
+ }
37
30
  }