@ckeditor/ckeditor5-table 38.0.1 → 38.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (168) hide show
  1. package/build/table.js +1 -1
  2. package/build/table.js.map +1 -0
  3. package/package.json +2 -38
  4. package/src/augmentation.d.ts +76 -76
  5. package/src/augmentation.js +5 -5
  6. package/src/commands/insertcolumncommand.d.ts +55 -55
  7. package/src/commands/insertcolumncommand.js +67 -67
  8. package/src/commands/insertrowcommand.d.ts +54 -54
  9. package/src/commands/insertrowcommand.js +66 -66
  10. package/src/commands/inserttablecommand.d.ts +44 -44
  11. package/src/commands/inserttablecommand.js +69 -69
  12. package/src/commands/mergecellcommand.d.ts +68 -68
  13. package/src/commands/mergecellcommand.js +198 -198
  14. package/src/commands/mergecellscommand.d.ts +28 -28
  15. package/src/commands/mergecellscommand.js +94 -94
  16. package/src/commands/removecolumncommand.d.ts +29 -29
  17. package/src/commands/removecolumncommand.js +109 -109
  18. package/src/commands/removerowcommand.d.ts +29 -29
  19. package/src/commands/removerowcommand.js +82 -82
  20. package/src/commands/selectcolumncommand.d.ts +33 -33
  21. package/src/commands/selectcolumncommand.js +60 -60
  22. package/src/commands/selectrowcommand.d.ts +33 -33
  23. package/src/commands/selectrowcommand.js +56 -56
  24. package/src/commands/setheadercolumncommand.d.ts +50 -50
  25. package/src/commands/setheadercolumncommand.js +71 -71
  26. package/src/commands/setheaderrowcommand.d.ts +53 -53
  27. package/src/commands/setheaderrowcommand.js +79 -79
  28. package/src/commands/splitcellcommand.d.ts +43 -43
  29. package/src/commands/splitcellcommand.js +54 -54
  30. package/src/converters/downcast.d.ts +63 -63
  31. package/src/converters/downcast.js +146 -146
  32. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  33. package/src/converters/table-caption-post-fixer.js +53 -53
  34. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  35. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  36. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  37. package/src/converters/table-cell-refresh-handler.js +45 -45
  38. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  39. package/src/converters/table-headings-refresh-handler.js +49 -49
  40. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  41. package/src/converters/table-layout-post-fixer.js +367 -367
  42. package/src/converters/tableproperties.d.ts +54 -54
  43. package/src/converters/tableproperties.js +159 -159
  44. package/src/converters/upcasttable.d.ts +49 -49
  45. package/src/converters/upcasttable.js +243 -243
  46. package/src/index.d.ts +60 -60
  47. package/src/index.js +30 -30
  48. package/src/plaintableoutput.d.ts +26 -26
  49. package/src/plaintableoutput.js +123 -123
  50. package/src/table.d.ts +40 -40
  51. package/src/table.js +44 -44
  52. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  53. package/src/tablecaption/tablecaptionediting.js +122 -122
  54. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  55. package/src/tablecaption/tablecaptionui.js +57 -57
  56. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  57. package/src/tablecaption/toggletablecaptioncommand.js +104 -104
  58. package/src/tablecaption/utils.d.ts +42 -42
  59. package/src/tablecaption/utils.js +67 -67
  60. package/src/tablecaption.d.ts +24 -24
  61. package/src/tablecaption.js +28 -28
  62. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  63. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  64. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  65. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  66. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  67. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  68. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  69. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  70. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  71. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  72. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  73. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  74. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  75. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  76. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  77. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  78. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  79. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  80. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  81. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  82. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  83. package/src/tablecellproperties/tablecellpropertiesui.js +328 -328
  84. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -227
  85. package/src/tablecellproperties/ui/tablecellpropertiesview.js +537 -537
  86. package/src/tablecellproperties.d.ts +30 -30
  87. package/src/tablecellproperties.js +34 -34
  88. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  89. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  90. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  91. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  92. package/src/tableclipboard.d.ts +65 -65
  93. package/src/tableclipboard.js +450 -450
  94. package/src/tablecolumnresize/constants.d.ts +20 -20
  95. package/src/tablecolumnresize/constants.js +20 -20
  96. package/src/tablecolumnresize/converters.d.ts +18 -18
  97. package/src/tablecolumnresize/converters.js +45 -45
  98. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  99. package/src/tablecolumnresize/tablecolumnresizeediting.js +571 -571
  100. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  101. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  102. package/src/tablecolumnresize/utils.d.ts +141 -141
  103. package/src/tablecolumnresize/utils.js +330 -330
  104. package/src/tablecolumnresize.d.ts +26 -26
  105. package/src/tablecolumnresize.js +30 -30
  106. package/src/tableconfig.d.ts +331 -331
  107. package/src/tableconfig.js +5 -5
  108. package/src/tableediting.d.ts +98 -98
  109. package/src/tableediting.js +191 -191
  110. package/src/tablekeyboard.d.ts +68 -68
  111. package/src/tablekeyboard.js +279 -279
  112. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  113. package/src/tablemouse/mouseeventsobserver.js +35 -35
  114. package/src/tablemouse.d.ts +48 -48
  115. package/src/tablemouse.js +172 -172
  116. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  117. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  118. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  119. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  120. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  121. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  122. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  123. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  124. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  125. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  126. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  127. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  128. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  129. package/src/tableproperties/commands/tablepropertycommand.js +80 -80
  130. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  131. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  132. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  133. package/src/tableproperties/tablepropertiesediting.js +206 -206
  134. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  135. package/src/tableproperties/tablepropertiesui.js +319 -319
  136. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -203
  137. package/src/tableproperties/ui/tablepropertiesview.js +455 -455
  138. package/src/tableproperties.d.ts +30 -30
  139. package/src/tableproperties.js +34 -34
  140. package/src/tableselection.d.ts +107 -107
  141. package/src/tableselection.js +297 -297
  142. package/src/tabletoolbar.d.ts +32 -32
  143. package/src/tabletoolbar.js +57 -57
  144. package/src/tableui.d.ts +53 -53
  145. package/src/tableui.js +309 -309
  146. package/src/tableutils.d.ts +448 -448
  147. package/src/tableutils.js +1041 -1041
  148. package/src/tablewalker.d.ts +323 -323
  149. package/src/tablewalker.js +333 -333
  150. package/src/ui/colorinputview.d.ts +143 -143
  151. package/src/ui/colorinputview.js +248 -248
  152. package/src/ui/formrowview.d.ts +61 -61
  153. package/src/ui/formrowview.js +57 -57
  154. package/src/ui/inserttableview.d.ts +77 -77
  155. package/src/ui/inserttableview.js +169 -169
  156. package/src/utils/common.d.ts +42 -42
  157. package/src/utils/common.js +57 -57
  158. package/src/utils/structure.d.ts +245 -245
  159. package/src/utils/structure.js +426 -426
  160. package/src/utils/table-properties.d.ts +67 -67
  161. package/src/utils/table-properties.js +86 -86
  162. package/src/utils/ui/contextualballoon.d.ts +34 -34
  163. package/src/utils/ui/contextualballoon.js +106 -106
  164. package/src/utils/ui/table-properties.d.ts +193 -193
  165. package/src/utils/ui/table-properties.js +360 -360
  166. package/src/utils/ui/widget.d.ts +16 -16
  167. package/src/utils/ui/widget.js +38 -38
  168. package/theme/tablecolumnresize.css +3 -0
@@ -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 TableCellPropertyCommand from './tablecellpropertycommand';
6
- import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
7
- /**
8
- * The table cell padding command.
9
- *
10
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
11
- * the `'tableCellPadding'` editor command.
12
- *
13
- * To change the padding of selected cells, execute the command:
14
- *
15
- * ```ts
16
- * editor.execute( 'tableCellPadding', {
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( 'tableCellPadding', {
25
- * value: '5'
26
- * } );
27
- * ```
28
- *
29
- * will set the `padding` attribute to `'5px'` in the model.
30
- */
31
- export default class TableCellPaddingCommand extends TableCellPropertyCommand {
32
- /**
33
- * Creates a new `TableCellPaddingCommand` 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, 'tableCellPadding', defaultValue);
40
- }
41
- /**
42
- * @inheritDoc
43
- */
44
- _getAttribute(tableCell) {
45
- if (!tableCell) {
46
- return;
47
- }
48
- const value = getSingleValue(tableCell.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 TableCellPropertyCommand from './tablecellpropertycommand';
6
+ import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
7
+ /**
8
+ * The table cell padding command.
9
+ *
10
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
11
+ * the `'tableCellPadding'` editor command.
12
+ *
13
+ * To change the padding of selected cells, execute the command:
14
+ *
15
+ * ```ts
16
+ * editor.execute( 'tableCellPadding', {
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( 'tableCellPadding', {
25
+ * value: '5'
26
+ * } );
27
+ * ```
28
+ *
29
+ * will set the `padding` attribute to `'5px'` in the model.
30
+ */
31
+ export default class TableCellPaddingCommand extends TableCellPropertyCommand {
32
+ /**
33
+ * Creates a new `TableCellPaddingCommand` 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, 'tableCellPadding', defaultValue);
40
+ }
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ _getAttribute(tableCell) {
45
+ if (!tableCell) {
46
+ return;
47
+ }
48
+ const value = getSingleValue(tableCell.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,62 +1,62 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module table/tablecellproperties/commands/tablecellpropertycommand
7
- */
8
- import { Command, type Editor } from 'ckeditor5/src/core';
9
- import type { Element, Batch } from 'ckeditor5/src/engine';
10
- /**
11
- * The table cell attribute command.
12
- *
13
- * The command is a base command for other table cell property commands.
14
- */
15
- export default class TableCellPropertyCommand extends Command {
16
- /**
17
- * The attribute that will be set by the command.
18
- */
19
- readonly attributeName: string;
20
- /**
21
- * The default value for the attribute.
22
- */
23
- protected readonly _defaultValue: string;
24
- /**
25
- * Creates a new `TableCellPropertyCommand` instance.
26
- *
27
- * @param editor An editor in which this command will be used.
28
- * @param attributeName Table cell attribute name.
29
- * @param defaultValue The default value of the attribute.
30
- */
31
- constructor(editor: Editor, attributeName: string, defaultValue: string);
32
- /**
33
- * @inheritDoc
34
- */
35
- refresh(): void;
36
- /**
37
- * Executes the command.
38
- *
39
- * @fires execute
40
- * @param options.value If set, the command will set the attribute on selected table cells.
41
- * If it is not set, the command will remove the attribute from the selected table cells.
42
- * @param options.batch Pass the model batch instance to the command to aggregate changes,
43
- * for example to allow a single undo step for multiple executions.
44
- */
45
- execute(options?: {
46
- value?: string | number;
47
- batch?: Batch;
48
- }): void;
49
- /**
50
- * Returns the attribute value for a table cell.
51
- */
52
- protected _getAttribute(tableCell: Element | undefined): unknown;
53
- /**
54
- * Returns the proper model value. It can be used to add a default unit to numeric values.
55
- */
56
- protected _getValueToSet(value: string | number | undefined): unknown;
57
- /**
58
- * Returns a single value for all selected table cells. If the value is the same for all cells,
59
- * it will be returned (`undefined` otherwise).
60
- */
61
- private _getSingleValue;
62
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module table/tablecellproperties/commands/tablecellpropertycommand
7
+ */
8
+ import { Command, type Editor } from 'ckeditor5/src/core';
9
+ import type { Element, Batch } from 'ckeditor5/src/engine';
10
+ /**
11
+ * The table cell attribute command.
12
+ *
13
+ * The command is a base command for other table cell property commands.
14
+ */
15
+ export default class TableCellPropertyCommand extends Command {
16
+ /**
17
+ * The attribute that will be set by the command.
18
+ */
19
+ readonly attributeName: string;
20
+ /**
21
+ * The default value for the attribute.
22
+ */
23
+ protected readonly _defaultValue: string;
24
+ /**
25
+ * Creates a new `TableCellPropertyCommand` instance.
26
+ *
27
+ * @param editor An editor in which this command will be used.
28
+ * @param attributeName Table cell attribute name.
29
+ * @param defaultValue The default value of the attribute.
30
+ */
31
+ constructor(editor: Editor, attributeName: string, defaultValue: string);
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ refresh(): void;
36
+ /**
37
+ * Executes the command.
38
+ *
39
+ * @fires execute
40
+ * @param options.value If set, the command will set the attribute on selected table cells.
41
+ * If it is not set, the command will remove the attribute from the selected table cells.
42
+ * @param options.batch Pass the model batch instance to the command to aggregate changes,
43
+ * for example to allow a single undo step for multiple executions.
44
+ */
45
+ execute(options?: {
46
+ value?: string | number;
47
+ batch?: Batch;
48
+ }): void;
49
+ /**
50
+ * Returns the attribute value for a table cell.
51
+ */
52
+ protected _getAttribute(tableCell: Element | undefined): unknown;
53
+ /**
54
+ * Returns the proper model value. It can be used to add a default unit to numeric values.
55
+ */
56
+ protected _getValueToSet(value: string | number | undefined): unknown;
57
+ /**
58
+ * Returns a single value for all selected table cells. If the value is the same for all cells,
59
+ * it will be returned (`undefined` otherwise).
60
+ */
61
+ private _getSingleValue;
62
+ }
@@ -1,92 +1,92 @@
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/tablecellproperties/commands/tablecellpropertycommand
7
- */
8
- import { Command } from 'ckeditor5/src/core';
9
- /**
10
- * The table cell attribute command.
11
- *
12
- * The command is a base command for other table cell property commands.
13
- */
14
- export default class TableCellPropertyCommand extends Command {
15
- /**
16
- * Creates a new `TableCellPropertyCommand` instance.
17
- *
18
- * @param editor An editor in which this command will be used.
19
- * @param attributeName Table cell attribute name.
20
- * @param defaultValue The default value of the attribute.
21
- */
22
- constructor(editor, attributeName, defaultValue) {
23
- super(editor);
24
- this.attributeName = attributeName;
25
- this._defaultValue = defaultValue;
26
- }
27
- /**
28
- * @inheritDoc
29
- */
30
- refresh() {
31
- const editor = this.editor;
32
- const tableUtils = this.editor.plugins.get('TableUtils');
33
- const selectedTableCells = tableUtils.getSelectionAffectedTableCells(editor.model.document.selection);
34
- this.isEnabled = !!selectedTableCells.length;
35
- this.value = this._getSingleValue(selectedTableCells);
36
- }
37
- /**
38
- * Executes the command.
39
- *
40
- * @fires execute
41
- * @param options.value If set, the command will set the attribute on selected table cells.
42
- * If it is not set, the command will remove the attribute from the selected table cells.
43
- * @param options.batch Pass the model batch instance to the command to aggregate changes,
44
- * for example to allow a single undo step for multiple executions.
45
- */
46
- execute(options = {}) {
47
- const { value, batch } = options;
48
- const model = this.editor.model;
49
- const tableUtils = this.editor.plugins.get('TableUtils');
50
- const tableCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
51
- const valueToSet = this._getValueToSet(value);
52
- model.enqueueChange(batch, writer => {
53
- if (valueToSet) {
54
- tableCells.forEach(tableCell => writer.setAttribute(this.attributeName, valueToSet, tableCell));
55
- }
56
- else {
57
- tableCells.forEach(tableCell => writer.removeAttribute(this.attributeName, tableCell));
58
- }
59
- });
60
- }
61
- /**
62
- * Returns the attribute value for a table cell.
63
- */
64
- _getAttribute(tableCell) {
65
- if (!tableCell) {
66
- return;
67
- }
68
- const value = tableCell.getAttribute(this.attributeName);
69
- if (value === this._defaultValue) {
70
- return;
71
- }
72
- return value;
73
- }
74
- /**
75
- * Returns the proper model value. It can be used to add a default unit to numeric values.
76
- */
77
- _getValueToSet(value) {
78
- if (value === this._defaultValue) {
79
- return;
80
- }
81
- return value;
82
- }
83
- /**
84
- * Returns a single value for all selected table cells. If the value is the same for all cells,
85
- * it will be returned (`undefined` otherwise).
86
- */
87
- _getSingleValue(tableCells) {
88
- const firstCellValue = this._getAttribute(tableCells[0]);
89
- const everyCellHasAttribute = tableCells.every(tableCells => this._getAttribute(tableCells) === firstCellValue);
90
- return everyCellHasAttribute ? firstCellValue : undefined;
91
- }
92
- }
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/tablecellproperties/commands/tablecellpropertycommand
7
+ */
8
+ import { Command } from 'ckeditor5/src/core';
9
+ /**
10
+ * The table cell attribute command.
11
+ *
12
+ * The command is a base command for other table cell property commands.
13
+ */
14
+ export default class TableCellPropertyCommand extends Command {
15
+ /**
16
+ * Creates a new `TableCellPropertyCommand` instance.
17
+ *
18
+ * @param editor An editor in which this command will be used.
19
+ * @param attributeName Table cell attribute name.
20
+ * @param defaultValue The default value of the attribute.
21
+ */
22
+ constructor(editor, attributeName, defaultValue) {
23
+ super(editor);
24
+ this.attributeName = attributeName;
25
+ this._defaultValue = defaultValue;
26
+ }
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ refresh() {
31
+ const editor = this.editor;
32
+ const tableUtils = this.editor.plugins.get('TableUtils');
33
+ const selectedTableCells = tableUtils.getSelectionAffectedTableCells(editor.model.document.selection);
34
+ this.isEnabled = !!selectedTableCells.length;
35
+ this.value = this._getSingleValue(selectedTableCells);
36
+ }
37
+ /**
38
+ * Executes the command.
39
+ *
40
+ * @fires execute
41
+ * @param options.value If set, the command will set the attribute on selected table cells.
42
+ * If it is not set, the command will remove the attribute from the selected table cells.
43
+ * @param options.batch Pass the model batch instance to the command to aggregate changes,
44
+ * for example to allow a single undo step for multiple executions.
45
+ */
46
+ execute(options = {}) {
47
+ const { value, batch } = options;
48
+ const model = this.editor.model;
49
+ const tableUtils = this.editor.plugins.get('TableUtils');
50
+ const tableCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
51
+ const valueToSet = this._getValueToSet(value);
52
+ model.enqueueChange(batch, writer => {
53
+ if (valueToSet) {
54
+ tableCells.forEach(tableCell => writer.setAttribute(this.attributeName, valueToSet, tableCell));
55
+ }
56
+ else {
57
+ tableCells.forEach(tableCell => writer.removeAttribute(this.attributeName, tableCell));
58
+ }
59
+ });
60
+ }
61
+ /**
62
+ * Returns the attribute value for a table cell.
63
+ */
64
+ _getAttribute(tableCell) {
65
+ if (!tableCell) {
66
+ return;
67
+ }
68
+ const value = tableCell.getAttribute(this.attributeName);
69
+ if (value === this._defaultValue) {
70
+ return;
71
+ }
72
+ return value;
73
+ }
74
+ /**
75
+ * Returns the proper model value. It can be used to add a default unit to numeric values.
76
+ */
77
+ _getValueToSet(value) {
78
+ if (value === this._defaultValue) {
79
+ return;
80
+ }
81
+ return value;
82
+ }
83
+ /**
84
+ * Returns a single value for all selected table cells. If the value is the same for all cells,
85
+ * it will be returned (`undefined` otherwise).
86
+ */
87
+ _getSingleValue(tableCells) {
88
+ const firstCellValue = this._getAttribute(tableCells[0]);
89
+ const everyCellHasAttribute = tableCells.every(tableCells => this._getAttribute(tableCells) === firstCellValue);
90
+ return everyCellHasAttribute ? firstCellValue : undefined;
91
+ }
92
+ }
@@ -1,40 +1,40 @@
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/tablecellproperties/commands/tablecellverticalalignmentcommand
7
- */
8
- import type { Editor } from 'ckeditor5/src/core';
9
- import TableCellPropertyCommand from './tablecellpropertycommand';
10
- /**
11
- * The table cell vertical alignment command.
12
- *
13
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
14
- * the `'tableCellVerticalAlignment'` editor command.
15
- *
16
- * To change the vertical text alignment of selected cells, execute the command:
17
- *
18
- * ```ts
19
- * editor.execute( 'tableCellVerticalAlignment', {
20
- * value: 'top'
21
- * } );
22
- * ```
23
- *
24
- * The following values, corresponding to the
25
- * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
26
- *
27
- * * `'top'`
28
- * * `'bottom'`
29
- *
30
- * The `'middle'` value is the default one so there is no need to set it.
31
- */
32
- export default class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
33
- /**
34
- * Creates a new `TableCellVerticalAlignmentCommand` instance.
35
- *
36
- * @param editor An editor in which this command will be used.
37
- * @param defaultValue The default value for the "alignment" attribute.
38
- */
39
- constructor(editor: Editor, defaultValue: string);
40
- }
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/tablecellproperties/commands/tablecellverticalalignmentcommand
7
+ */
8
+ import type { Editor } from 'ckeditor5/src/core';
9
+ import TableCellPropertyCommand from './tablecellpropertycommand';
10
+ /**
11
+ * The table cell vertical alignment command.
12
+ *
13
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
14
+ * the `'tableCellVerticalAlignment'` editor command.
15
+ *
16
+ * To change the vertical text alignment of selected cells, execute the command:
17
+ *
18
+ * ```ts
19
+ * editor.execute( 'tableCellVerticalAlignment', {
20
+ * value: 'top'
21
+ * } );
22
+ * ```
23
+ *
24
+ * The following values, corresponding to the
25
+ * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
26
+ *
27
+ * * `'top'`
28
+ * * `'bottom'`
29
+ *
30
+ * The `'middle'` value is the default one so there is no need to set it.
31
+ */
32
+ export default class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
33
+ /**
34
+ * Creates a new `TableCellVerticalAlignmentCommand` instance.
35
+ *
36
+ * @param editor An editor in which this command will be used.
37
+ * @param defaultValue The default value for the "alignment" attribute.
38
+ */
39
+ constructor(editor: Editor, defaultValue: string);
40
+ }
@@ -1,38 +1,38 @@
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 TableCellPropertyCommand from './tablecellpropertycommand';
6
- /**
7
- * The table cell vertical alignment command.
8
- *
9
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
10
- * the `'tableCellVerticalAlignment'` editor command.
11
- *
12
- * To change the vertical text alignment of selected cells, execute the command:
13
- *
14
- * ```ts
15
- * editor.execute( 'tableCellVerticalAlignment', {
16
- * value: 'top'
17
- * } );
18
- * ```
19
- *
20
- * The following values, corresponding to the
21
- * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
22
- *
23
- * * `'top'`
24
- * * `'bottom'`
25
- *
26
- * The `'middle'` value is the default one so there is no need to set it.
27
- */
28
- export default class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
29
- /**
30
- * Creates a new `TableCellVerticalAlignmentCommand` instance.
31
- *
32
- * @param editor An editor in which this command will be used.
33
- * @param defaultValue The default value for the "alignment" attribute.
34
- */
35
- constructor(editor, defaultValue) {
36
- super(editor, 'tableCellVerticalAlignment', defaultValue);
37
- }
38
- }
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 TableCellPropertyCommand from './tablecellpropertycommand';
6
+ /**
7
+ * The table cell vertical alignment command.
8
+ *
9
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
10
+ * the `'tableCellVerticalAlignment'` editor command.
11
+ *
12
+ * To change the vertical text alignment of selected cells, execute the command:
13
+ *
14
+ * ```ts
15
+ * editor.execute( 'tableCellVerticalAlignment', {
16
+ * value: 'top'
17
+ * } );
18
+ * ```
19
+ *
20
+ * The following values, corresponding to the
21
+ * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
22
+ *
23
+ * * `'top'`
24
+ * * `'bottom'`
25
+ *
26
+ * The `'middle'` value is the default one so there is no need to set it.
27
+ */
28
+ export default class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
29
+ /**
30
+ * Creates a new `TableCellVerticalAlignmentCommand` instance.
31
+ *
32
+ * @param editor An editor in which this command will be used.
33
+ * @param defaultValue The default value for the "alignment" attribute.
34
+ */
35
+ constructor(editor, defaultValue) {
36
+ super(editor, 'tableCellVerticalAlignment', defaultValue);
37
+ }
38
+ }