@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,328 +1,328 @@
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/tablecellpropertiesui
7
- */
8
- import { Plugin } from 'ckeditor5/src/core';
9
- import { ButtonView, clickOutsideHandler, ContextualBalloon, getLocalizedColorOptions, normalizeColorOptions } from 'ckeditor5/src/ui';
10
- import TableCellPropertiesView from './ui/tablecellpropertiesview';
11
- import { colorFieldValidator, getLocalizedColorErrorText, getLocalizedLengthErrorText, defaultColors, lengthFieldValidator, lineWidthFieldValidator } from '../utils/ui/table-properties';
12
- import { debounce } from 'lodash-es';
13
- import { getTableWidgetAncestor } from '../utils/ui/widget';
14
- import { getBalloonCellPositionData, repositionContextualBalloon } from '../utils/ui/contextualballoon';
15
- import tableCellProperties from './../../theme/icons/table-cell-properties.svg';
16
- import { getNormalizedDefaultProperties } from '../utils/table-properties';
17
- const ERROR_TEXT_TIMEOUT = 500;
18
- // Map of view properties and related commands.
19
- const propertyToCommandMap = {
20
- borderStyle: 'tableCellBorderStyle',
21
- borderColor: 'tableCellBorderColor',
22
- borderWidth: 'tableCellBorderWidth',
23
- height: 'tableCellHeight',
24
- width: 'tableCellWidth',
25
- padding: 'tableCellPadding',
26
- backgroundColor: 'tableCellBackgroundColor',
27
- horizontalAlignment: 'tableCellHorizontalAlignment',
28
- verticalAlignment: 'tableCellVerticalAlignment'
29
- };
30
- /**
31
- * The table cell properties UI plugin. It introduces the `'tableCellProperties'` button
32
- * that opens a form allowing to specify the visual styling of a table cell.
33
- *
34
- * It uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
35
- */
36
- export default class TableCellPropertiesUI extends Plugin {
37
- /**
38
- * @inheritDoc
39
- */
40
- static get requires() {
41
- return [ContextualBalloon];
42
- }
43
- /**
44
- * @inheritDoc
45
- */
46
- static get pluginName() {
47
- return 'TableCellPropertiesUI';
48
- }
49
- /**
50
- * @inheritDoc
51
- */
52
- constructor(editor) {
53
- super(editor);
54
- editor.config.define('table.tableCellProperties', {
55
- borderColors: defaultColors,
56
- backgroundColors: defaultColors
57
- });
58
- }
59
- /**
60
- * @inheritDoc
61
- */
62
- init() {
63
- const editor = this.editor;
64
- const t = editor.t;
65
- this._defaultTableCellProperties = getNormalizedDefaultProperties(editor.config.get('table.tableCellProperties.defaultProperties'), {
66
- includeVerticalAlignmentProperty: true,
67
- includeHorizontalAlignmentProperty: true,
68
- includePaddingProperty: true,
69
- isRightToLeftContent: editor.locale.contentLanguageDirection === 'rtl'
70
- });
71
- this._balloon = editor.plugins.get(ContextualBalloon);
72
- this.view = null;
73
- this._isReady = false;
74
- editor.ui.componentFactory.add('tableCellProperties', locale => {
75
- const view = new ButtonView(locale);
76
- view.set({
77
- label: t('Cell properties'),
78
- icon: tableCellProperties,
79
- tooltip: true
80
- });
81
- this.listenTo(view, 'execute', () => this._showView());
82
- const commands = Object.values(propertyToCommandMap)
83
- .map(commandName => editor.commands.get(commandName));
84
- view.bind('isEnabled').toMany(commands, 'isEnabled', (...areEnabled) => (areEnabled.some(isCommandEnabled => isCommandEnabled)));
85
- return view;
86
- });
87
- }
88
- /**
89
- * @inheritDoc
90
- */
91
- destroy() {
92
- super.destroy();
93
- // Destroy created UI components as they are not automatically destroyed.
94
- // See https://github.com/ckeditor/ckeditor5/issues/1341.
95
- if (this.view) {
96
- this.view.destroy();
97
- }
98
- }
99
- /**
100
- * Creates the {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView} instance.
101
- *
102
- * @returns The cell properties form view instance.
103
- */
104
- _createPropertiesView() {
105
- const editor = this.editor;
106
- const config = editor.config.get('table.tableCellProperties');
107
- const borderColorsConfig = normalizeColorOptions(config.borderColors);
108
- const localizedBorderColors = getLocalizedColorOptions(editor.locale, borderColorsConfig);
109
- const backgroundColorsConfig = normalizeColorOptions(config.backgroundColors);
110
- const localizedBackgroundColors = getLocalizedColorOptions(editor.locale, backgroundColorsConfig);
111
- const view = new TableCellPropertiesView(editor.locale, {
112
- borderColors: localizedBorderColors,
113
- backgroundColors: localizedBackgroundColors,
114
- defaultTableCellProperties: this._defaultTableCellProperties
115
- });
116
- const t = editor.t;
117
- // Render the view so its #element is available for the clickOutsideHandler.
118
- view.render();
119
- this.listenTo(view, 'submit', () => {
120
- this._hideView();
121
- });
122
- this.listenTo(view, 'cancel', () => {
123
- // https://github.com/ckeditor/ckeditor5/issues/6180
124
- if (this._undoStepBatch.operations.length) {
125
- editor.execute('undo', this._undoStepBatch);
126
- }
127
- this._hideView();
128
- });
129
- // Close the balloon on Esc key press.
130
- view.keystrokes.set('Esc', (data, cancel) => {
131
- this._hideView();
132
- cancel();
133
- });
134
- // Close on click outside of balloon panel element.
135
- clickOutsideHandler({
136
- emitter: view,
137
- activator: () => this._isViewInBalloon,
138
- contextElements: [this._balloon.view.element],
139
- callback: () => this._hideView()
140
- });
141
- const colorErrorText = getLocalizedColorErrorText(t);
142
- const lengthErrorText = getLocalizedLengthErrorText(t);
143
- // Create the "UI -> editor data" binding.
144
- // These listeners update the editor data (via table commands) when any observable
145
- // property of the view has changed. They also validate the value and display errors in the UI
146
- // when necessary. This makes the view live, which means the changes are
147
- // visible in the editing as soon as the user types or changes fields' values.
148
- view.on('change:borderStyle', this._getPropertyChangeCallback('tableCellBorderStyle'));
149
- view.on('change:borderColor', this._getValidatedPropertyChangeCallback({
150
- viewField: view.borderColorInput,
151
- commandName: 'tableCellBorderColor',
152
- errorText: colorErrorText,
153
- validator: colorFieldValidator
154
- }));
155
- view.on('change:borderWidth', this._getValidatedPropertyChangeCallback({
156
- viewField: view.borderWidthInput,
157
- commandName: 'tableCellBorderWidth',
158
- errorText: lengthErrorText,
159
- validator: lineWidthFieldValidator
160
- }));
161
- view.on('change:padding', this._getValidatedPropertyChangeCallback({
162
- viewField: view.paddingInput,
163
- commandName: 'tableCellPadding',
164
- errorText: lengthErrorText,
165
- validator: lengthFieldValidator
166
- }));
167
- view.on('change:width', this._getValidatedPropertyChangeCallback({
168
- viewField: view.widthInput,
169
- commandName: 'tableCellWidth',
170
- errorText: lengthErrorText,
171
- validator: lengthFieldValidator
172
- }));
173
- view.on('change:height', this._getValidatedPropertyChangeCallback({
174
- viewField: view.heightInput,
175
- commandName: 'tableCellHeight',
176
- errorText: lengthErrorText,
177
- validator: lengthFieldValidator
178
- }));
179
- view.on('change:backgroundColor', this._getValidatedPropertyChangeCallback({
180
- viewField: view.backgroundInput,
181
- commandName: 'tableCellBackgroundColor',
182
- errorText: colorErrorText,
183
- validator: colorFieldValidator
184
- }));
185
- view.on('change:horizontalAlignment', this._getPropertyChangeCallback('tableCellHorizontalAlignment'));
186
- view.on('change:verticalAlignment', this._getPropertyChangeCallback('tableCellVerticalAlignment'));
187
- return view;
188
- }
189
- /**
190
- * In this method the "editor data -> UI" binding is happening.
191
- *
192
- * When executed, this method obtains selected cell property values from various table commands
193
- * and passes them to the {@link #view}.
194
- *
195
- * This way, the UI stays up–to–date with the editor data.
196
- */
197
- _fillViewFormFromCommandValues() {
198
- const commands = this.editor.commands;
199
- const borderStyleCommand = commands.get('tableCellBorderStyle');
200
- Object.entries(propertyToCommandMap)
201
- .map(([property, commandName]) => {
202
- const defaultValue = this._defaultTableCellProperties[property] || '';
203
- return [
204
- property,
205
- commands.get(commandName).value || defaultValue
206
- ];
207
- })
208
- .forEach(([property, value]) => {
209
- // Do not set the `border-color` and `border-width` fields if `border-style:none`.
210
- if ((property === 'borderColor' || property === 'borderWidth') && borderStyleCommand.value === 'none') {
211
- return;
212
- }
213
- this.view.set(property, value);
214
- });
215
- this._isReady = true;
216
- }
217
- /**
218
- * Shows the {@link #view} in the {@link #_balloon}.
219
- *
220
- * **Note**: Each time a view is shown, a new {@link #_undoStepBatch} is created. It contains
221
- * all changes made to the document when the view is visible, allowing a single undo step
222
- * for all of them.
223
- */
224
- _showView() {
225
- const editor = this.editor;
226
- if (!this.view) {
227
- this.view = this._createPropertiesView();
228
- }
229
- this.listenTo(editor.ui, 'update', () => {
230
- this._updateView();
231
- });
232
- // Update the view with the model values.
233
- this._fillViewFormFromCommandValues();
234
- this._balloon.add({
235
- view: this.view,
236
- position: getBalloonCellPositionData(editor)
237
- });
238
- // Create a new batch. Clicking "Cancel" will undo this batch.
239
- this._undoStepBatch = editor.model.createBatch();
240
- // Basic a11y.
241
- this.view.focus();
242
- }
243
- /**
244
- * Removes the {@link #view} from the {@link #_balloon}.
245
- */
246
- _hideView() {
247
- const editor = this.editor;
248
- this.stopListening(editor.ui, 'update');
249
- this._isReady = false;
250
- // Blur any input element before removing it from DOM to prevent issues in some browsers.
251
- // See https://github.com/ckeditor/ckeditor5/issues/1501.
252
- this.view.saveButtonView.focus();
253
- this._balloon.remove(this.view);
254
- // Make sure the focus is not lost in the process by putting it directly
255
- // into the editing view.
256
- this.editor.editing.view.focus();
257
- }
258
- /**
259
- * Repositions the {@link #_balloon} or hides the {@link #view} if a table cell is no longer selected.
260
- */
261
- _updateView() {
262
- const editor = this.editor;
263
- const viewDocument = editor.editing.view.document;
264
- if (!getTableWidgetAncestor(viewDocument.selection)) {
265
- this._hideView();
266
- }
267
- else if (this._isViewVisible) {
268
- repositionContextualBalloon(editor, 'cell');
269
- }
270
- }
271
- /**
272
- * Returns `true` when the {@link #view} is visible in the {@link #_balloon}.
273
- */
274
- get _isViewVisible() {
275
- return !!this.view && this._balloon.visibleView === this.view;
276
- }
277
- /**
278
- * Returns `true` when the {@link #view} is in the {@link #_balloon}.
279
- */
280
- get _isViewInBalloon() {
281
- return !!this.view && this._balloon.hasView(this.view);
282
- }
283
- /**
284
- * Creates a callback that when executed upon the {@link #view view's} property change
285
- * executes a related editor command with the new property value.
286
- *
287
- * @param defaultValue The default value of the command.
288
- */
289
- _getPropertyChangeCallback(commandName) {
290
- return (evt, propertyName, newValue) => {
291
- if (!this._isReady) {
292
- return;
293
- }
294
- this.editor.execute(commandName, {
295
- value: newValue,
296
- batch: this._undoStepBatch
297
- });
298
- };
299
- }
300
- /**
301
- * Creates a callback that when executed upon the {@link #view view's} property change:
302
- * * Executes a related editor command with the new property value if the value is valid,
303
- * * Or sets the error text next to the invalid field, if the value did not pass the validation.
304
- */
305
- _getValidatedPropertyChangeCallback(options) {
306
- const { commandName, viewField, validator, errorText } = options;
307
- const setErrorTextDebounced = debounce(() => {
308
- viewField.errorText = errorText;
309
- }, ERROR_TEXT_TIMEOUT);
310
- return (evt, propertyName, newValue) => {
311
- setErrorTextDebounced.cancel();
312
- // Do not execute the command on initial call (opening the table properties view).
313
- if (!this._isReady) {
314
- return;
315
- }
316
- if (validator(newValue)) {
317
- this.editor.execute(commandName, {
318
- value: newValue,
319
- batch: this._undoStepBatch
320
- });
321
- viewField.errorText = null;
322
- }
323
- else {
324
- setErrorTextDebounced();
325
- }
326
- };
327
- }
328
- }
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/tablecellpropertiesui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ import { ButtonView, clickOutsideHandler, ContextualBalloon, getLocalizedColorOptions, normalizeColorOptions } from 'ckeditor5/src/ui';
10
+ import TableCellPropertiesView from './ui/tablecellpropertiesview';
11
+ import { colorFieldValidator, getLocalizedColorErrorText, getLocalizedLengthErrorText, defaultColors, lengthFieldValidator, lineWidthFieldValidator } from '../utils/ui/table-properties';
12
+ import { debounce } from 'lodash-es';
13
+ import { getTableWidgetAncestor } from '../utils/ui/widget';
14
+ import { getBalloonCellPositionData, repositionContextualBalloon } from '../utils/ui/contextualballoon';
15
+ import tableCellProperties from './../../theme/icons/table-cell-properties.svg';
16
+ import { getNormalizedDefaultProperties } from '../utils/table-properties';
17
+ const ERROR_TEXT_TIMEOUT = 500;
18
+ // Map of view properties and related commands.
19
+ const propertyToCommandMap = {
20
+ borderStyle: 'tableCellBorderStyle',
21
+ borderColor: 'tableCellBorderColor',
22
+ borderWidth: 'tableCellBorderWidth',
23
+ height: 'tableCellHeight',
24
+ width: 'tableCellWidth',
25
+ padding: 'tableCellPadding',
26
+ backgroundColor: 'tableCellBackgroundColor',
27
+ horizontalAlignment: 'tableCellHorizontalAlignment',
28
+ verticalAlignment: 'tableCellVerticalAlignment'
29
+ };
30
+ /**
31
+ * The table cell properties UI plugin. It introduces the `'tableCellProperties'` button
32
+ * that opens a form allowing to specify the visual styling of a table cell.
33
+ *
34
+ * It uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
35
+ */
36
+ export default class TableCellPropertiesUI extends Plugin {
37
+ /**
38
+ * @inheritDoc
39
+ */
40
+ static get requires() {
41
+ return [ContextualBalloon];
42
+ }
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ static get pluginName() {
47
+ return 'TableCellPropertiesUI';
48
+ }
49
+ /**
50
+ * @inheritDoc
51
+ */
52
+ constructor(editor) {
53
+ super(editor);
54
+ editor.config.define('table.tableCellProperties', {
55
+ borderColors: defaultColors,
56
+ backgroundColors: defaultColors
57
+ });
58
+ }
59
+ /**
60
+ * @inheritDoc
61
+ */
62
+ init() {
63
+ const editor = this.editor;
64
+ const t = editor.t;
65
+ this._defaultTableCellProperties = getNormalizedDefaultProperties(editor.config.get('table.tableCellProperties.defaultProperties'), {
66
+ includeVerticalAlignmentProperty: true,
67
+ includeHorizontalAlignmentProperty: true,
68
+ includePaddingProperty: true,
69
+ isRightToLeftContent: editor.locale.contentLanguageDirection === 'rtl'
70
+ });
71
+ this._balloon = editor.plugins.get(ContextualBalloon);
72
+ this.view = null;
73
+ this._isReady = false;
74
+ editor.ui.componentFactory.add('tableCellProperties', locale => {
75
+ const view = new ButtonView(locale);
76
+ view.set({
77
+ label: t('Cell properties'),
78
+ icon: tableCellProperties,
79
+ tooltip: true
80
+ });
81
+ this.listenTo(view, 'execute', () => this._showView());
82
+ const commands = Object.values(propertyToCommandMap)
83
+ .map(commandName => editor.commands.get(commandName));
84
+ view.bind('isEnabled').toMany(commands, 'isEnabled', (...areEnabled) => (areEnabled.some(isCommandEnabled => isCommandEnabled)));
85
+ return view;
86
+ });
87
+ }
88
+ /**
89
+ * @inheritDoc
90
+ */
91
+ destroy() {
92
+ super.destroy();
93
+ // Destroy created UI components as they are not automatically destroyed.
94
+ // See https://github.com/ckeditor/ckeditor5/issues/1341.
95
+ if (this.view) {
96
+ this.view.destroy();
97
+ }
98
+ }
99
+ /**
100
+ * Creates the {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView} instance.
101
+ *
102
+ * @returns The cell properties form view instance.
103
+ */
104
+ _createPropertiesView() {
105
+ const editor = this.editor;
106
+ const config = editor.config.get('table.tableCellProperties');
107
+ const borderColorsConfig = normalizeColorOptions(config.borderColors);
108
+ const localizedBorderColors = getLocalizedColorOptions(editor.locale, borderColorsConfig);
109
+ const backgroundColorsConfig = normalizeColorOptions(config.backgroundColors);
110
+ const localizedBackgroundColors = getLocalizedColorOptions(editor.locale, backgroundColorsConfig);
111
+ const view = new TableCellPropertiesView(editor.locale, {
112
+ borderColors: localizedBorderColors,
113
+ backgroundColors: localizedBackgroundColors,
114
+ defaultTableCellProperties: this._defaultTableCellProperties
115
+ });
116
+ const t = editor.t;
117
+ // Render the view so its #element is available for the clickOutsideHandler.
118
+ view.render();
119
+ this.listenTo(view, 'submit', () => {
120
+ this._hideView();
121
+ });
122
+ this.listenTo(view, 'cancel', () => {
123
+ // https://github.com/ckeditor/ckeditor5/issues/6180
124
+ if (this._undoStepBatch.operations.length) {
125
+ editor.execute('undo', this._undoStepBatch);
126
+ }
127
+ this._hideView();
128
+ });
129
+ // Close the balloon on Esc key press.
130
+ view.keystrokes.set('Esc', (data, cancel) => {
131
+ this._hideView();
132
+ cancel();
133
+ });
134
+ // Close on click outside of balloon panel element.
135
+ clickOutsideHandler({
136
+ emitter: view,
137
+ activator: () => this._isViewInBalloon,
138
+ contextElements: [this._balloon.view.element],
139
+ callback: () => this._hideView()
140
+ });
141
+ const colorErrorText = getLocalizedColorErrorText(t);
142
+ const lengthErrorText = getLocalizedLengthErrorText(t);
143
+ // Create the "UI -> editor data" binding.
144
+ // These listeners update the editor data (via table commands) when any observable
145
+ // property of the view has changed. They also validate the value and display errors in the UI
146
+ // when necessary. This makes the view live, which means the changes are
147
+ // visible in the editing as soon as the user types or changes fields' values.
148
+ view.on('change:borderStyle', this._getPropertyChangeCallback('tableCellBorderStyle'));
149
+ view.on('change:borderColor', this._getValidatedPropertyChangeCallback({
150
+ viewField: view.borderColorInput,
151
+ commandName: 'tableCellBorderColor',
152
+ errorText: colorErrorText,
153
+ validator: colorFieldValidator
154
+ }));
155
+ view.on('change:borderWidth', this._getValidatedPropertyChangeCallback({
156
+ viewField: view.borderWidthInput,
157
+ commandName: 'tableCellBorderWidth',
158
+ errorText: lengthErrorText,
159
+ validator: lineWidthFieldValidator
160
+ }));
161
+ view.on('change:padding', this._getValidatedPropertyChangeCallback({
162
+ viewField: view.paddingInput,
163
+ commandName: 'tableCellPadding',
164
+ errorText: lengthErrorText,
165
+ validator: lengthFieldValidator
166
+ }));
167
+ view.on('change:width', this._getValidatedPropertyChangeCallback({
168
+ viewField: view.widthInput,
169
+ commandName: 'tableCellWidth',
170
+ errorText: lengthErrorText,
171
+ validator: lengthFieldValidator
172
+ }));
173
+ view.on('change:height', this._getValidatedPropertyChangeCallback({
174
+ viewField: view.heightInput,
175
+ commandName: 'tableCellHeight',
176
+ errorText: lengthErrorText,
177
+ validator: lengthFieldValidator
178
+ }));
179
+ view.on('change:backgroundColor', this._getValidatedPropertyChangeCallback({
180
+ viewField: view.backgroundInput,
181
+ commandName: 'tableCellBackgroundColor',
182
+ errorText: colorErrorText,
183
+ validator: colorFieldValidator
184
+ }));
185
+ view.on('change:horizontalAlignment', this._getPropertyChangeCallback('tableCellHorizontalAlignment'));
186
+ view.on('change:verticalAlignment', this._getPropertyChangeCallback('tableCellVerticalAlignment'));
187
+ return view;
188
+ }
189
+ /**
190
+ * In this method the "editor data -> UI" binding is happening.
191
+ *
192
+ * When executed, this method obtains selected cell property values from various table commands
193
+ * and passes them to the {@link #view}.
194
+ *
195
+ * This way, the UI stays up–to–date with the editor data.
196
+ */
197
+ _fillViewFormFromCommandValues() {
198
+ const commands = this.editor.commands;
199
+ const borderStyleCommand = commands.get('tableCellBorderStyle');
200
+ Object.entries(propertyToCommandMap)
201
+ .map(([property, commandName]) => {
202
+ const defaultValue = this._defaultTableCellProperties[property] || '';
203
+ return [
204
+ property,
205
+ commands.get(commandName).value || defaultValue
206
+ ];
207
+ })
208
+ .forEach(([property, value]) => {
209
+ // Do not set the `border-color` and `border-width` fields if `border-style:none`.
210
+ if ((property === 'borderColor' || property === 'borderWidth') && borderStyleCommand.value === 'none') {
211
+ return;
212
+ }
213
+ this.view.set(property, value);
214
+ });
215
+ this._isReady = true;
216
+ }
217
+ /**
218
+ * Shows the {@link #view} in the {@link #_balloon}.
219
+ *
220
+ * **Note**: Each time a view is shown, a new {@link #_undoStepBatch} is created. It contains
221
+ * all changes made to the document when the view is visible, allowing a single undo step
222
+ * for all of them.
223
+ */
224
+ _showView() {
225
+ const editor = this.editor;
226
+ if (!this.view) {
227
+ this.view = this._createPropertiesView();
228
+ }
229
+ this.listenTo(editor.ui, 'update', () => {
230
+ this._updateView();
231
+ });
232
+ // Update the view with the model values.
233
+ this._fillViewFormFromCommandValues();
234
+ this._balloon.add({
235
+ view: this.view,
236
+ position: getBalloonCellPositionData(editor)
237
+ });
238
+ // Create a new batch. Clicking "Cancel" will undo this batch.
239
+ this._undoStepBatch = editor.model.createBatch();
240
+ // Basic a11y.
241
+ this.view.focus();
242
+ }
243
+ /**
244
+ * Removes the {@link #view} from the {@link #_balloon}.
245
+ */
246
+ _hideView() {
247
+ const editor = this.editor;
248
+ this.stopListening(editor.ui, 'update');
249
+ this._isReady = false;
250
+ // Blur any input element before removing it from DOM to prevent issues in some browsers.
251
+ // See https://github.com/ckeditor/ckeditor5/issues/1501.
252
+ this.view.saveButtonView.focus();
253
+ this._balloon.remove(this.view);
254
+ // Make sure the focus is not lost in the process by putting it directly
255
+ // into the editing view.
256
+ this.editor.editing.view.focus();
257
+ }
258
+ /**
259
+ * Repositions the {@link #_balloon} or hides the {@link #view} if a table cell is no longer selected.
260
+ */
261
+ _updateView() {
262
+ const editor = this.editor;
263
+ const viewDocument = editor.editing.view.document;
264
+ if (!getTableWidgetAncestor(viewDocument.selection)) {
265
+ this._hideView();
266
+ }
267
+ else if (this._isViewVisible) {
268
+ repositionContextualBalloon(editor, 'cell');
269
+ }
270
+ }
271
+ /**
272
+ * Returns `true` when the {@link #view} is visible in the {@link #_balloon}.
273
+ */
274
+ get _isViewVisible() {
275
+ return !!this.view && this._balloon.visibleView === this.view;
276
+ }
277
+ /**
278
+ * Returns `true` when the {@link #view} is in the {@link #_balloon}.
279
+ */
280
+ get _isViewInBalloon() {
281
+ return !!this.view && this._balloon.hasView(this.view);
282
+ }
283
+ /**
284
+ * Creates a callback that when executed upon the {@link #view view's} property change
285
+ * executes a related editor command with the new property value.
286
+ *
287
+ * @param defaultValue The default value of the command.
288
+ */
289
+ _getPropertyChangeCallback(commandName) {
290
+ return (evt, propertyName, newValue) => {
291
+ if (!this._isReady) {
292
+ return;
293
+ }
294
+ this.editor.execute(commandName, {
295
+ value: newValue,
296
+ batch: this._undoStepBatch
297
+ });
298
+ };
299
+ }
300
+ /**
301
+ * Creates a callback that when executed upon the {@link #view view's} property change:
302
+ * * Executes a related editor command with the new property value if the value is valid,
303
+ * * Or sets the error text next to the invalid field, if the value did not pass the validation.
304
+ */
305
+ _getValidatedPropertyChangeCallback(options) {
306
+ const { commandName, viewField, validator, errorText } = options;
307
+ const setErrorTextDebounced = debounce(() => {
308
+ viewField.errorText = errorText;
309
+ }, ERROR_TEXT_TIMEOUT);
310
+ return (evt, propertyName, newValue) => {
311
+ setErrorTextDebounced.cancel();
312
+ // Do not execute the command on initial call (opening the table properties view).
313
+ if (!this._isReady) {
314
+ return;
315
+ }
316
+ if (validator(newValue)) {
317
+ this.editor.execute(commandName, {
318
+ value: newValue,
319
+ batch: this._undoStepBatch
320
+ });
321
+ viewField.errorText = null;
322
+ }
323
+ else {
324
+ setErrorTextDebounced();
325
+ }
326
+ };
327
+ }
328
+ }