@ckeditor/ckeditor5-table 40.0.0 → 40.1.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 (170) hide show
  1. package/LICENSE.md +3 -3
  2. package/build/table.js +1 -1
  3. package/build/translations/fi.js +1 -1
  4. package/lang/translations/fi.po +3 -3
  5. package/package.json +2 -2
  6. package/src/augmentation.d.ts +76 -76
  7. package/src/augmentation.js +5 -5
  8. package/src/commands/insertcolumncommand.d.ts +55 -55
  9. package/src/commands/insertcolumncommand.js +67 -67
  10. package/src/commands/insertrowcommand.d.ts +54 -54
  11. package/src/commands/insertrowcommand.js +66 -66
  12. package/src/commands/inserttablecommand.d.ts +44 -44
  13. package/src/commands/inserttablecommand.js +69 -69
  14. package/src/commands/mergecellcommand.d.ts +68 -68
  15. package/src/commands/mergecellcommand.js +198 -198
  16. package/src/commands/mergecellscommand.d.ts +28 -28
  17. package/src/commands/mergecellscommand.js +94 -94
  18. package/src/commands/removecolumncommand.d.ts +29 -29
  19. package/src/commands/removecolumncommand.js +109 -109
  20. package/src/commands/removerowcommand.d.ts +29 -29
  21. package/src/commands/removerowcommand.js +82 -82
  22. package/src/commands/selectcolumncommand.d.ts +33 -33
  23. package/src/commands/selectcolumncommand.js +60 -60
  24. package/src/commands/selectrowcommand.d.ts +33 -33
  25. package/src/commands/selectrowcommand.js +56 -56
  26. package/src/commands/setheadercolumncommand.d.ts +50 -50
  27. package/src/commands/setheadercolumncommand.js +71 -71
  28. package/src/commands/setheaderrowcommand.d.ts +53 -53
  29. package/src/commands/setheaderrowcommand.js +79 -79
  30. package/src/commands/splitcellcommand.d.ts +43 -43
  31. package/src/commands/splitcellcommand.js +54 -54
  32. package/src/converters/downcast.d.ts +63 -63
  33. package/src/converters/downcast.js +146 -146
  34. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  35. package/src/converters/table-caption-post-fixer.js +53 -53
  36. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  37. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  38. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  39. package/src/converters/table-cell-refresh-handler.js +45 -45
  40. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  41. package/src/converters/table-headings-refresh-handler.js +49 -49
  42. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  43. package/src/converters/table-layout-post-fixer.js +367 -367
  44. package/src/converters/tableproperties.d.ts +54 -54
  45. package/src/converters/tableproperties.js +159 -159
  46. package/src/converters/upcasttable.d.ts +49 -49
  47. package/src/converters/upcasttable.js +243 -243
  48. package/src/index.d.ts +60 -60
  49. package/src/index.js +30 -30
  50. package/src/plaintableoutput.d.ts +26 -26
  51. package/src/plaintableoutput.js +123 -123
  52. package/src/table.d.ts +40 -40
  53. package/src/table.js +44 -44
  54. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  55. package/src/tablecaption/tablecaptionediting.js +122 -122
  56. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  57. package/src/tablecaption/tablecaptionui.js +57 -57
  58. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  59. package/src/tablecaption/toggletablecaptioncommand.js +105 -104
  60. package/src/tablecaption/utils.d.ts +38 -42
  61. package/src/tablecaption/utils.js +57 -67
  62. package/src/tablecaption.d.ts +24 -24
  63. package/src/tablecaption.js +28 -28
  64. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  65. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  66. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  67. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  68. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  69. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  70. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  71. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  72. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  73. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  74. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  75. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  76. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  77. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  78. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  79. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  80. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  81. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  82. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  83. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  84. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  85. package/src/tablecellproperties/tablecellpropertiesui.js +330 -330
  86. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +228 -228
  87. package/src/tablecellproperties/ui/tablecellpropertiesview.js +548 -548
  88. package/src/tablecellproperties.d.ts +30 -30
  89. package/src/tablecellproperties.js +34 -34
  90. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  91. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  92. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  93. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  94. package/src/tableclipboard.d.ts +65 -65
  95. package/src/tableclipboard.js +450 -450
  96. package/src/tablecolumnresize/constants.d.ts +20 -20
  97. package/src/tablecolumnresize/constants.js +20 -20
  98. package/src/tablecolumnresize/converters.d.ts +18 -18
  99. package/src/tablecolumnresize/converters.js +46 -46
  100. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  101. package/src/tablecolumnresize/tablecolumnresizeediting.js +583 -583
  102. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  103. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  104. package/src/tablecolumnresize/utils.d.ts +148 -148
  105. package/src/tablecolumnresize/utils.js +358 -358
  106. package/src/tablecolumnresize.d.ts +26 -26
  107. package/src/tablecolumnresize.js +30 -30
  108. package/src/tableconfig.d.ts +343 -343
  109. package/src/tableconfig.js +5 -5
  110. package/src/tableediting.d.ts +98 -98
  111. package/src/tableediting.js +191 -191
  112. package/src/tablekeyboard.d.ts +68 -68
  113. package/src/tablekeyboard.js +279 -279
  114. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  115. package/src/tablemouse/mouseeventsobserver.js +35 -35
  116. package/src/tablemouse.d.ts +48 -48
  117. package/src/tablemouse.js +172 -172
  118. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  119. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  120. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  121. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  122. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  123. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  124. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  125. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  126. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  127. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  128. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  129. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  130. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  131. package/src/tableproperties/commands/tablepropertycommand.js +81 -80
  132. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  133. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  134. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  135. package/src/tableproperties/tablepropertiesediting.js +206 -206
  136. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  137. package/src/tableproperties/tablepropertiesui.js +321 -321
  138. package/src/tableproperties/ui/tablepropertiesview.d.ts +207 -207
  139. package/src/tableproperties/ui/tablepropertiesview.js +466 -466
  140. package/src/tableproperties.d.ts +30 -30
  141. package/src/tableproperties.js +34 -34
  142. package/src/tableselection.d.ts +107 -107
  143. package/src/tableselection.js +297 -297
  144. package/src/tabletoolbar.d.ts +32 -32
  145. package/src/tabletoolbar.js +57 -57
  146. package/src/tableui.d.ts +53 -53
  147. package/src/tableui.js +309 -309
  148. package/src/tableutils.d.ts +448 -448
  149. package/src/tableutils.js +1055 -1055
  150. package/src/tablewalker.d.ts +362 -362
  151. package/src/tablewalker.js +393 -393
  152. package/src/ui/colorinputview.d.ts +140 -140
  153. package/src/ui/colorinputview.js +271 -271
  154. package/src/ui/formrowview.d.ts +61 -61
  155. package/src/ui/formrowview.js +57 -57
  156. package/src/ui/inserttableview.d.ts +77 -77
  157. package/src/ui/inserttableview.js +169 -169
  158. package/src/utils/common.d.ts +46 -42
  159. package/src/utils/common.js +68 -57
  160. package/src/utils/structure.d.ts +245 -245
  161. package/src/utils/structure.js +426 -426
  162. package/src/utils/table-properties.d.ts +67 -67
  163. package/src/utils/table-properties.js +86 -86
  164. package/src/utils/ui/contextualballoon.d.ts +34 -34
  165. package/src/utils/ui/contextualballoon.js +110 -106
  166. package/src/utils/ui/table-properties.d.ts +195 -195
  167. package/src/utils/ui/table-properties.js +362 -362
  168. package/src/utils/ui/widget.d.ts +20 -16
  169. package/src/utils/ui/widget.js +48 -38
  170. package/build/table.js.map +0 -1
@@ -1,51 +1,51 @@
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/tableproperties/commands/tableborderwidthcommand
7
- */
8
- import type { Element } from 'ckeditor5/src/engine';
9
- import type { Editor } from 'ckeditor5/src/core';
10
- import TablePropertyCommand from './tablepropertycommand';
11
- /**
12
- * The table width border command.
13
- *
14
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
15
- * the `'tableBorderWidth'` editor command.
16
- *
17
- * To change the border width of the selected table, execute the command:
18
- *
19
- * ```ts
20
- * editor.execute( 'tableBorderWidth', {
21
- * value: '5px'
22
- * } );
23
- * ```
24
- *
25
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
26
- *
27
- * ```ts
28
- * editor.execute( 'tableBorderWidth', {
29
- * value: '5'
30
- * } );
31
- * ```
32
- *
33
- * will set the `borderWidth` attribute to `'5px'` in the model.
34
- */
35
- export default class TableBorderWidthCommand extends TablePropertyCommand {
36
- /**
37
- * Creates a new `TableBorderWidthCommand` instance.
38
- *
39
- * @param editor An editor in which this command will be used.
40
- * @param defaultValue The default value of the attribute.
41
- */
42
- constructor(editor: Editor, defaultValue: string);
43
- /**
44
- * @inheritDoc
45
- */
46
- protected _getValue(table: Element): string | undefined;
47
- /**
48
- * @inheritDoc
49
- */
50
- protected _getValueToSet(value: string | number | undefined): unknown;
51
- }
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/tableproperties/commands/tableborderwidthcommand
7
+ */
8
+ import type { Element } from 'ckeditor5/src/engine';
9
+ import type { Editor } from 'ckeditor5/src/core';
10
+ import TablePropertyCommand from './tablepropertycommand';
11
+ /**
12
+ * The table width border command.
13
+ *
14
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
15
+ * the `'tableBorderWidth'` editor command.
16
+ *
17
+ * To change the border width of the selected table, execute the command:
18
+ *
19
+ * ```ts
20
+ * editor.execute( 'tableBorderWidth', {
21
+ * value: '5px'
22
+ * } );
23
+ * ```
24
+ *
25
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
26
+ *
27
+ * ```ts
28
+ * editor.execute( 'tableBorderWidth', {
29
+ * value: '5'
30
+ * } );
31
+ * ```
32
+ *
33
+ * will set the `borderWidth` attribute to `'5px'` in the model.
34
+ */
35
+ export default class TableBorderWidthCommand extends TablePropertyCommand {
36
+ /**
37
+ * Creates a new `TableBorderWidthCommand` instance.
38
+ *
39
+ * @param editor An editor in which this command will be used.
40
+ * @param defaultValue The default value of the attribute.
41
+ */
42
+ constructor(editor: Editor, defaultValue: string);
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ protected _getValue(table: Element): string | undefined;
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ protected _getValueToSet(value: string | number | undefined): unknown;
51
+ }
@@ -1,64 +1,64 @@
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 TablePropertyCommand from './tablepropertycommand';
6
- import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
7
- /**
8
- * The table width border command.
9
- *
10
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
11
- * the `'tableBorderWidth'` editor command.
12
- *
13
- * To change the border width of the selected table, execute the command:
14
- *
15
- * ```ts
16
- * editor.execute( 'tableBorderWidth', {
17
- * value: '5px'
18
- * } );
19
- * ```
20
- *
21
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
22
- *
23
- * ```ts
24
- * editor.execute( 'tableBorderWidth', {
25
- * value: '5'
26
- * } );
27
- * ```
28
- *
29
- * will set the `borderWidth` attribute to `'5px'` in the model.
30
- */
31
- export default class TableBorderWidthCommand extends TablePropertyCommand {
32
- /**
33
- * Creates a new `TableBorderWidthCommand` instance.
34
- *
35
- * @param editor An editor in which this command will be used.
36
- * @param defaultValue The default value of the attribute.
37
- */
38
- constructor(editor, defaultValue) {
39
- super(editor, 'tableBorderWidth', defaultValue);
40
- }
41
- /**
42
- * @inheritDoc
43
- */
44
- _getValue(table) {
45
- if (!table) {
46
- return;
47
- }
48
- const value = getSingleValue(table.getAttribute(this.attributeName));
49
- if (value === this._defaultValue) {
50
- return;
51
- }
52
- return value;
53
- }
54
- /**
55
- * @inheritDoc
56
- */
57
- _getValueToSet(value) {
58
- const newValue = addDefaultUnitToNumericValue(value, 'px');
59
- if (newValue === this._defaultValue) {
60
- return;
61
- }
62
- return newValue;
63
- }
64
- }
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 TablePropertyCommand from './tablepropertycommand';
6
+ import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
7
+ /**
8
+ * The table width border command.
9
+ *
10
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
11
+ * the `'tableBorderWidth'` editor command.
12
+ *
13
+ * To change the border width of the selected table, execute the command:
14
+ *
15
+ * ```ts
16
+ * editor.execute( 'tableBorderWidth', {
17
+ * value: '5px'
18
+ * } );
19
+ * ```
20
+ *
21
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
22
+ *
23
+ * ```ts
24
+ * editor.execute( 'tableBorderWidth', {
25
+ * value: '5'
26
+ * } );
27
+ * ```
28
+ *
29
+ * will set the `borderWidth` attribute to `'5px'` in the model.
30
+ */
31
+ export default class TableBorderWidthCommand extends TablePropertyCommand {
32
+ /**
33
+ * Creates a new `TableBorderWidthCommand` instance.
34
+ *
35
+ * @param editor An editor in which this command will be used.
36
+ * @param defaultValue The default value of the attribute.
37
+ */
38
+ constructor(editor, defaultValue) {
39
+ super(editor, 'tableBorderWidth', defaultValue);
40
+ }
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ _getValue(table) {
45
+ if (!table) {
46
+ return;
47
+ }
48
+ const value = getSingleValue(table.getAttribute(this.attributeName));
49
+ if (value === this._defaultValue) {
50
+ return;
51
+ }
52
+ return value;
53
+ }
54
+ /**
55
+ * @inheritDoc
56
+ */
57
+ _getValueToSet(value) {
58
+ const newValue = addDefaultUnitToNumericValue(value, 'px');
59
+ if (newValue === this._defaultValue) {
60
+ return;
61
+ }
62
+ return newValue;
63
+ }
64
+ }
@@ -1,46 +1,46 @@
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/tableproperties/commands/tableheightcommand
7
- */
8
- import TablePropertyCommand from './tablepropertycommand';
9
- import type { Editor } from 'ckeditor5/src/core';
10
- /**
11
- * The table height command.
12
- *
13
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
14
- * the `'tableHeight'` editor command.
15
- *
16
- * To change the height of the selected table, execute the command:
17
- *
18
- * ```ts
19
- * editor.execute( 'tableHeight', {
20
- * value: '500px'
21
- * } );
22
- * ```
23
- *
24
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
25
- *
26
- * ```ts
27
- * editor.execute( 'tableHeight', {
28
- * value: '50'
29
- * } );
30
- * ```
31
- *
32
- * will set the `height` attribute to `'50px'` in the model.
33
- */
34
- export default class TableHeightCommand extends TablePropertyCommand {
35
- /**
36
- * Creates a new `TableHeightCommand` instance.
37
- *
38
- * @param editor An editor in which this command will be used.
39
- * @param defaultValue The default value of the attribute.
40
- */
41
- constructor(editor: Editor, defaultValue: string);
42
- /**
43
- * @inheritDoc
44
- */
45
- protected _getValueToSet(value: string | number | undefined): unknown;
46
- }
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/tableproperties/commands/tableheightcommand
7
+ */
8
+ import TablePropertyCommand from './tablepropertycommand';
9
+ import type { Editor } from 'ckeditor5/src/core';
10
+ /**
11
+ * The table height command.
12
+ *
13
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
14
+ * the `'tableHeight'` editor command.
15
+ *
16
+ * To change the height of the selected table, execute the command:
17
+ *
18
+ * ```ts
19
+ * editor.execute( 'tableHeight', {
20
+ * value: '500px'
21
+ * } );
22
+ * ```
23
+ *
24
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
25
+ *
26
+ * ```ts
27
+ * editor.execute( 'tableHeight', {
28
+ * value: '50'
29
+ * } );
30
+ * ```
31
+ *
32
+ * will set the `height` attribute to `'50px'` in the model.
33
+ */
34
+ export default class TableHeightCommand extends TablePropertyCommand {
35
+ /**
36
+ * Creates a new `TableHeightCommand` instance.
37
+ *
38
+ * @param editor An editor in which this command will be used.
39
+ * @param defaultValue The default value of the attribute.
40
+ */
41
+ constructor(editor: Editor, defaultValue: string);
42
+ /**
43
+ * @inheritDoc
44
+ */
45
+ protected _getValueToSet(value: string | number | undefined): unknown;
46
+ }
@@ -1,54 +1,54 @@
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/tableproperties/commands/tableheightcommand
7
- */
8
- import TablePropertyCommand from './tablepropertycommand';
9
- import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
10
- /**
11
- * The table height command.
12
- *
13
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
14
- * the `'tableHeight'` editor command.
15
- *
16
- * To change the height of the selected table, execute the command:
17
- *
18
- * ```ts
19
- * editor.execute( 'tableHeight', {
20
- * value: '500px'
21
- * } );
22
- * ```
23
- *
24
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
25
- *
26
- * ```ts
27
- * editor.execute( 'tableHeight', {
28
- * value: '50'
29
- * } );
30
- * ```
31
- *
32
- * will set the `height` attribute to `'50px'` in the model.
33
- */
34
- export default class TableHeightCommand extends TablePropertyCommand {
35
- /**
36
- * Creates a new `TableHeightCommand` instance.
37
- *
38
- * @param editor An editor in which this command will be used.
39
- * @param defaultValue The default value of the attribute.
40
- */
41
- constructor(editor, defaultValue) {
42
- super(editor, 'tableHeight', defaultValue);
43
- }
44
- /**
45
- * @inheritDoc
46
- */
47
- _getValueToSet(value) {
48
- value = addDefaultUnitToNumericValue(value, 'px');
49
- if (value === this._defaultValue) {
50
- return;
51
- }
52
- return value;
53
- }
54
- }
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/tableproperties/commands/tableheightcommand
7
+ */
8
+ import TablePropertyCommand from './tablepropertycommand';
9
+ import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
10
+ /**
11
+ * The table height command.
12
+ *
13
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
14
+ * the `'tableHeight'` editor command.
15
+ *
16
+ * To change the height of the selected table, execute the command:
17
+ *
18
+ * ```ts
19
+ * editor.execute( 'tableHeight', {
20
+ * value: '500px'
21
+ * } );
22
+ * ```
23
+ *
24
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
25
+ *
26
+ * ```ts
27
+ * editor.execute( 'tableHeight', {
28
+ * value: '50'
29
+ * } );
30
+ * ```
31
+ *
32
+ * will set the `height` attribute to `'50px'` in the model.
33
+ */
34
+ export default class TableHeightCommand extends TablePropertyCommand {
35
+ /**
36
+ * Creates a new `TableHeightCommand` instance.
37
+ *
38
+ * @param editor An editor in which this command will be used.
39
+ * @param defaultValue The default value of the attribute.
40
+ */
41
+ constructor(editor, defaultValue) {
42
+ super(editor, 'tableHeight', defaultValue);
43
+ }
44
+ /**
45
+ * @inheritDoc
46
+ */
47
+ _getValueToSet(value) {
48
+ value = addDefaultUnitToNumericValue(value, 'px');
49
+ if (value === this._defaultValue) {
50
+ return;
51
+ }
52
+ return value;
53
+ }
54
+ }
@@ -1,61 +1,61 @@
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/tableproperties/commands/tablepropertycommand
7
- */
8
- import type { Batch, Element } from 'ckeditor5/src/engine';
9
- import { Command, type Editor } from 'ckeditor5/src/core';
10
- export interface TablePropertyCommandExecuteOptions {
11
- batch?: Batch;
12
- columnWidths?: string;
13
- table?: Element;
14
- tableWidth?: string;
15
- value?: string;
16
- }
17
- /**
18
- * The table cell attribute command.
19
- *
20
- * This command is a base command for other table property commands.
21
- */
22
- export default class TablePropertyCommand extends Command {
23
- /**
24
- * The attribute that will be set by the command.
25
- */
26
- readonly attributeName: string;
27
- /**
28
- * The default value for the attribute.
29
- */
30
- protected readonly _defaultValue: string | undefined;
31
- /**
32
- * Creates a new `TablePropertyCommand` instance.
33
- *
34
- * @param editor An editor in which this command will be used.
35
- * @param attributeName Table cell attribute name.
36
- * @param defaultValue The default value of the attribute.
37
- */
38
- constructor(editor: Editor, attributeName: string, defaultValue?: string);
39
- /**
40
- * @inheritDoc
41
- */
42
- refresh(): void;
43
- /**
44
- * Executes the command.
45
- *
46
- * @fires execute
47
- * @param options.value If set, the command will set the attribute on the selected table.
48
- * If not set, the command will remove the attribute from the selected table.
49
- * @param options.batch Pass the model batch instance to the command to aggregate changes,
50
- * for example, to allow a single undo step for multiple executions.
51
- */
52
- execute(options?: TablePropertyCommandExecuteOptions): void;
53
- /**
54
- * Returns the attribute value for a table.
55
- */
56
- protected _getValue(table: Element): unknown;
57
- /**
58
- * Returns the proper model value. It can be used to add a default unit to numeric values.
59
- */
60
- protected _getValueToSet(value: string | number | undefined): unknown;
61
- }
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/tableproperties/commands/tablepropertycommand
7
+ */
8
+ import type { Batch, Element } from 'ckeditor5/src/engine';
9
+ import { Command, type Editor } from 'ckeditor5/src/core';
10
+ export interface TablePropertyCommandExecuteOptions {
11
+ batch?: Batch;
12
+ columnWidths?: string;
13
+ table?: Element;
14
+ tableWidth?: string;
15
+ value?: string;
16
+ }
17
+ /**
18
+ * The table cell attribute command.
19
+ *
20
+ * This command is a base command for other table property commands.
21
+ */
22
+ export default class TablePropertyCommand extends Command {
23
+ /**
24
+ * The attribute that will be set by the command.
25
+ */
26
+ readonly attributeName: string;
27
+ /**
28
+ * The default value for the attribute.
29
+ */
30
+ protected readonly _defaultValue: string | undefined;
31
+ /**
32
+ * Creates a new `TablePropertyCommand` instance.
33
+ *
34
+ * @param editor An editor in which this command will be used.
35
+ * @param attributeName Table cell attribute name.
36
+ * @param defaultValue The default value of the attribute.
37
+ */
38
+ constructor(editor: Editor, attributeName: string, defaultValue?: string);
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ refresh(): void;
43
+ /**
44
+ * Executes the command.
45
+ *
46
+ * @fires execute
47
+ * @param options.value If set, the command will set the attribute on the selected table.
48
+ * If not set, the command will remove the attribute from the selected table.
49
+ * @param options.batch Pass the model batch instance to the command to aggregate changes,
50
+ * for example, to allow a single undo step for multiple executions.
51
+ */
52
+ execute(options?: TablePropertyCommandExecuteOptions): void;
53
+ /**
54
+ * Returns the attribute value for a table.
55
+ */
56
+ protected _getValue(table: Element): unknown;
57
+ /**
58
+ * Returns the proper model value. It can be used to add a default unit to numeric values.
59
+ */
60
+ protected _getValueToSet(value: string | number | undefined): unknown;
61
+ }