@ckeditor/ckeditor5-table 38.1.1 → 38.2.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (169) hide show
  1. package/build/table.js +1 -1
  2. package/package.json +3 -2
  3. package/src/augmentation.d.ts +76 -76
  4. package/src/augmentation.js +5 -5
  5. package/src/commands/insertcolumncommand.d.ts +55 -55
  6. package/src/commands/insertcolumncommand.js +67 -67
  7. package/src/commands/insertrowcommand.d.ts +54 -54
  8. package/src/commands/insertrowcommand.js +66 -66
  9. package/src/commands/inserttablecommand.d.ts +44 -44
  10. package/src/commands/inserttablecommand.js +69 -69
  11. package/src/commands/mergecellcommand.d.ts +68 -68
  12. package/src/commands/mergecellcommand.js +198 -198
  13. package/src/commands/mergecellscommand.d.ts +28 -28
  14. package/src/commands/mergecellscommand.js +94 -94
  15. package/src/commands/removecolumncommand.d.ts +29 -29
  16. package/src/commands/removecolumncommand.js +109 -109
  17. package/src/commands/removerowcommand.d.ts +29 -29
  18. package/src/commands/removerowcommand.js +82 -82
  19. package/src/commands/selectcolumncommand.d.ts +33 -33
  20. package/src/commands/selectcolumncommand.js +60 -60
  21. package/src/commands/selectrowcommand.d.ts +33 -33
  22. package/src/commands/selectrowcommand.js +56 -56
  23. package/src/commands/setheadercolumncommand.d.ts +50 -50
  24. package/src/commands/setheadercolumncommand.js +71 -71
  25. package/src/commands/setheaderrowcommand.d.ts +53 -53
  26. package/src/commands/setheaderrowcommand.js +79 -79
  27. package/src/commands/splitcellcommand.d.ts +43 -43
  28. package/src/commands/splitcellcommand.js +54 -54
  29. package/src/converters/downcast.d.ts +63 -63
  30. package/src/converters/downcast.js +146 -146
  31. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  32. package/src/converters/table-caption-post-fixer.js +53 -53
  33. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  34. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  35. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  36. package/src/converters/table-cell-refresh-handler.js +45 -45
  37. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  38. package/src/converters/table-headings-refresh-handler.js +49 -49
  39. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  40. package/src/converters/table-layout-post-fixer.js +367 -367
  41. package/src/converters/tableproperties.d.ts +54 -54
  42. package/src/converters/tableproperties.js +159 -159
  43. package/src/converters/upcasttable.d.ts +49 -49
  44. package/src/converters/upcasttable.js +243 -243
  45. package/src/index.d.ts +60 -60
  46. package/src/index.js +30 -30
  47. package/src/plaintableoutput.d.ts +26 -26
  48. package/src/plaintableoutput.js +123 -123
  49. package/src/table.d.ts +40 -40
  50. package/src/table.js +44 -44
  51. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  52. package/src/tablecaption/tablecaptionediting.js +122 -122
  53. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  54. package/src/tablecaption/tablecaptionui.js +57 -57
  55. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  56. package/src/tablecaption/toggletablecaptioncommand.js +104 -104
  57. package/src/tablecaption/utils.d.ts +42 -42
  58. package/src/tablecaption/utils.js +67 -67
  59. package/src/tablecaption.d.ts +24 -24
  60. package/src/tablecaption.js +28 -28
  61. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  62. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  63. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  64. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  65. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  66. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  67. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  68. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  69. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  70. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  71. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  72. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  73. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  74. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  75. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  76. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  77. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  78. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  79. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  80. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  81. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  82. package/src/tablecellproperties/tablecellpropertiesui.js +330 -328
  83. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +228 -227
  84. package/src/tablecellproperties/ui/tablecellpropertiesview.js +539 -537
  85. package/src/tablecellproperties.d.ts +30 -30
  86. package/src/tablecellproperties.js +34 -34
  87. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  88. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  89. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  90. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  91. package/src/tableclipboard.d.ts +65 -65
  92. package/src/tableclipboard.js +450 -450
  93. package/src/tablecolumnresize/constants.d.ts +20 -20
  94. package/src/tablecolumnresize/constants.js +20 -20
  95. package/src/tablecolumnresize/converters.d.ts +18 -18
  96. package/src/tablecolumnresize/converters.js +45 -45
  97. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  98. package/src/tablecolumnresize/tablecolumnresizeediting.js +571 -571
  99. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  100. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  101. package/src/tablecolumnresize/utils.d.ts +141 -141
  102. package/src/tablecolumnresize/utils.js +330 -330
  103. package/src/tablecolumnresize.d.ts +26 -26
  104. package/src/tablecolumnresize.js +30 -30
  105. package/src/tableconfig.d.ts +343 -331
  106. package/src/tableconfig.js +5 -5
  107. package/src/tableediting.d.ts +98 -98
  108. package/src/tableediting.js +191 -191
  109. package/src/tablekeyboard.d.ts +68 -68
  110. package/src/tablekeyboard.js +279 -279
  111. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  112. package/src/tablemouse/mouseeventsobserver.js +35 -35
  113. package/src/tablemouse.d.ts +48 -48
  114. package/src/tablemouse.js +172 -172
  115. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  116. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  117. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  118. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  119. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  120. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  121. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  122. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  123. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  124. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  125. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  126. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  127. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  128. package/src/tableproperties/commands/tablepropertycommand.js +80 -80
  129. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  130. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  131. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  132. package/src/tableproperties/tablepropertiesediting.js +206 -206
  133. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  134. package/src/tableproperties/tablepropertiesui.js +321 -319
  135. package/src/tableproperties/ui/tablepropertiesview.d.ts +207 -203
  136. package/src/tableproperties/ui/tablepropertiesview.js +457 -455
  137. package/src/tableproperties.d.ts +30 -30
  138. package/src/tableproperties.js +34 -34
  139. package/src/tableselection.d.ts +107 -107
  140. package/src/tableselection.js +297 -297
  141. package/src/tabletoolbar.d.ts +32 -32
  142. package/src/tabletoolbar.js +57 -57
  143. package/src/tableui.d.ts +53 -53
  144. package/src/tableui.js +309 -309
  145. package/src/tableutils.d.ts +448 -448
  146. package/src/tableutils.js +1041 -1041
  147. package/src/tablewalker.d.ts +323 -323
  148. package/src/tablewalker.js +333 -333
  149. package/src/ui/colorinputview.d.ts +140 -143
  150. package/src/ui/colorinputview.js +265 -248
  151. package/src/ui/formrowview.d.ts +61 -61
  152. package/src/ui/formrowview.js +57 -57
  153. package/src/ui/inserttableview.d.ts +77 -77
  154. package/src/ui/inserttableview.js +169 -169
  155. package/src/utils/common.d.ts +42 -42
  156. package/src/utils/common.js +57 -57
  157. package/src/utils/structure.d.ts +245 -245
  158. package/src/utils/structure.js +426 -426
  159. package/src/utils/table-properties.d.ts +67 -67
  160. package/src/utils/table-properties.js +86 -86
  161. package/src/utils/ui/contextualballoon.d.ts +34 -34
  162. package/src/utils/ui/contextualballoon.js +106 -106
  163. package/src/utils/ui/table-properties.d.ts +195 -193
  164. package/src/utils/ui/table-properties.js +362 -360
  165. package/src/utils/ui/widget.d.ts +16 -16
  166. package/src/utils/ui/widget.js +38 -38
  167. package/theme/tablecaption.css +7 -7
  168. package/theme/tablecolumnresize.css +2 -2
  169. package/build/table.js.map +0 -1
@@ -1,455 +1,457 @@
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/ui/tablepropertiesview
7
- */
8
- import { addListToDropdown, ButtonView, createLabeledDropdown, createLabeledInputText, FocusCycler, FormHeaderView, LabeledFieldView, LabelView, submitHandler, ToolbarView, View, ViewCollection } from 'ckeditor5/src/ui';
9
- import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils';
10
- import { icons } from 'ckeditor5/src/core';
11
- import { fillToolbar, getBorderStyleDefinitions, getBorderStyleLabels, getLabeledColorInputCreator } from '../../utils/ui/table-properties';
12
- import FormRowView from '../../ui/formrowview';
13
- import '../../../theme/form.css';
14
- import '../../../theme/tableform.css';
15
- import '../../../theme/tableproperties.css';
16
- const ALIGNMENT_ICONS = {
17
- left: icons.objectLeft,
18
- center: icons.objectCenter,
19
- right: icons.objectRight
20
- };
21
- /**
22
- * The class representing a table properties form, allowing users to customize
23
- * certain style aspects of a table, for instance, border, background color, alignment, etc..
24
- */
25
- export default class TablePropertiesView extends View {
26
- /**
27
- * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
28
- * @param options Additional configuration of the view.
29
- */
30
- constructor(locale, options) {
31
- super(locale);
32
- this.set({
33
- borderStyle: '',
34
- borderWidth: '',
35
- borderColor: '',
36
- backgroundColor: '',
37
- width: '',
38
- height: '',
39
- alignment: ''
40
- });
41
- this.options = options;
42
- const { borderStyleDropdown, borderWidthInput, borderColorInput, borderRowLabel } = this._createBorderFields();
43
- const { backgroundRowLabel, backgroundInput } = this._createBackgroundFields();
44
- const { widthInput, operatorLabel, heightInput, dimensionsLabel } = this._createDimensionFields();
45
- const { alignmentToolbar, alignmentLabel } = this._createAlignmentFields();
46
- this.focusTracker = new FocusTracker();
47
- this.keystrokes = new KeystrokeHandler();
48
- this.children = this.createCollection();
49
- this.borderStyleDropdown = borderStyleDropdown;
50
- this.borderWidthInput = borderWidthInput;
51
- this.borderColorInput = borderColorInput;
52
- this.backgroundInput = backgroundInput;
53
- this.widthInput = widthInput;
54
- this.heightInput = heightInput;
55
- this.alignmentToolbar = alignmentToolbar;
56
- // Defer creating to make sure other fields are present and the Save button can
57
- // bind its #isEnabled to their error messages so there's no way to save unless all
58
- // fields are valid.
59
- const { saveButtonView, cancelButtonView } = this._createActionButtons();
60
- this.saveButtonView = saveButtonView;
61
- this.cancelButtonView = cancelButtonView;
62
- this._focusables = new ViewCollection();
63
- this._focusCycler = new FocusCycler({
64
- focusables: this._focusables,
65
- focusTracker: this.focusTracker,
66
- keystrokeHandler: this.keystrokes,
67
- actions: {
68
- // Navigate form fields backwards using the Shift + Tab keystroke.
69
- focusPrevious: 'shift + tab',
70
- // Navigate form fields forwards using the Tab key.
71
- focusNext: 'tab'
72
- }
73
- });
74
- // Form header.
75
- this.children.add(new FormHeaderView(locale, {
76
- label: this.t('Table properties')
77
- }));
78
- // Border row.
79
- this.children.add(new FormRowView(locale, {
80
- labelView: borderRowLabel,
81
- children: [
82
- borderRowLabel,
83
- borderStyleDropdown,
84
- borderColorInput,
85
- borderWidthInput
86
- ],
87
- class: 'ck-table-form__border-row'
88
- }));
89
- // Background row.
90
- this.children.add(new FormRowView(locale, {
91
- labelView: backgroundRowLabel,
92
- children: [
93
- backgroundRowLabel,
94
- backgroundInput
95
- ],
96
- class: 'ck-table-form__background-row'
97
- }));
98
- this.children.add(new FormRowView(locale, {
99
- children: [
100
- // Dimensions row.
101
- new FormRowView(locale, {
102
- labelView: dimensionsLabel,
103
- children: [
104
- dimensionsLabel,
105
- widthInput,
106
- operatorLabel,
107
- heightInput
108
- ],
109
- class: 'ck-table-form__dimensions-row'
110
- }),
111
- // Alignment row.
112
- new FormRowView(locale, {
113
- labelView: alignmentLabel,
114
- children: [
115
- alignmentLabel,
116
- alignmentToolbar
117
- ],
118
- class: 'ck-table-properties-form__alignment-row'
119
- })
120
- ]
121
- }));
122
- // Action row.
123
- this.children.add(new FormRowView(locale, {
124
- children: [
125
- this.saveButtonView,
126
- this.cancelButtonView
127
- ],
128
- class: 'ck-table-form__action-row'
129
- }));
130
- this.setTemplate({
131
- tag: 'form',
132
- attributes: {
133
- class: [
134
- 'ck',
135
- 'ck-form',
136
- 'ck-table-form',
137
- 'ck-table-properties-form'
138
- ],
139
- // https://github.com/ckeditor/ckeditor5-link/issues/90
140
- tabindex: '-1'
141
- },
142
- children: this.children
143
- });
144
- }
145
- /**
146
- * @inheritDoc
147
- */
148
- render() {
149
- super.render();
150
- // Enable the "submit" event for this view. It can be triggered by the #saveButtonView
151
- // which is of the "submit" DOM "type".
152
- submitHandler({
153
- view: this
154
- });
155
- [
156
- this.borderStyleDropdown,
157
- this.borderColorInput,
158
- this.borderColorInput.fieldView.dropdownView.buttonView,
159
- this.borderWidthInput,
160
- this.backgroundInput,
161
- this.backgroundInput.fieldView.dropdownView.buttonView,
162
- this.widthInput,
163
- this.heightInput,
164
- this.alignmentToolbar,
165
- this.saveButtonView,
166
- this.cancelButtonView
167
- ].forEach(view => {
168
- // Register the view as focusable.
169
- this._focusables.add(view);
170
- // Register the view in the focus tracker.
171
- this.focusTracker.add(view.element);
172
- });
173
- // Mainly for closing using "Esc" and navigation using "Tab".
174
- this.keystrokes.listenTo(this.element);
175
- }
176
- /**
177
- * @inheritDoc
178
- */
179
- destroy() {
180
- super.destroy();
181
- this.focusTracker.destroy();
182
- this.keystrokes.destroy();
183
- }
184
- /**
185
- * Focuses the fist focusable field in the form.
186
- */
187
- focus() {
188
- this._focusCycler.focusFirst();
189
- }
190
- /**
191
- * Creates the following form fields:
192
- *
193
- * * {@link #borderStyleDropdown},
194
- * * {@link #borderWidthInput},
195
- * * {@link #borderColorInput}.
196
- */
197
- _createBorderFields() {
198
- const defaultTableProperties = this.options.defaultTableProperties;
199
- const defaultBorder = {
200
- style: defaultTableProperties.borderStyle,
201
- width: defaultTableProperties.borderWidth,
202
- color: defaultTableProperties.borderColor
203
- };
204
- const colorInputCreator = getLabeledColorInputCreator({
205
- colorConfig: this.options.borderColors,
206
- columns: 5,
207
- defaultColorValue: defaultBorder.color
208
- });
209
- const locale = this.locale;
210
- const t = this.t;
211
- const accessibleLabel = t('Style');
212
- // -- Group label ---------------------------------------------
213
- const borderRowLabel = new LabelView(locale);
214
- borderRowLabel.text = t('Border');
215
- // -- Style ---------------------------------------------------
216
- const styleLabels = getBorderStyleLabels(t);
217
- const borderStyleDropdown = new LabeledFieldView(locale, createLabeledDropdown);
218
- borderStyleDropdown.set({
219
- label: accessibleLabel,
220
- class: 'ck-table-form__border-style'
221
- });
222
- borderStyleDropdown.fieldView.buttonView.set({
223
- ariaLabel: accessibleLabel,
224
- ariaLabelledBy: undefined,
225
- isOn: false,
226
- withText: true,
227
- tooltip: accessibleLabel
228
- });
229
- borderStyleDropdown.fieldView.buttonView.bind('label').to(this, 'borderStyle', value => {
230
- return styleLabels[value ? value : 'none'];
231
- });
232
- borderStyleDropdown.fieldView.on('execute', evt => {
233
- this.borderStyle = evt.source._borderStyleValue;
234
- });
235
- borderStyleDropdown.bind('isEmpty').to(this, 'borderStyle', value => !value);
236
- addListToDropdown(borderStyleDropdown.fieldView, getBorderStyleDefinitions(this, defaultBorder.style), {
237
- role: 'menu',
238
- ariaLabel: accessibleLabel
239
- });
240
- // -- Width ---------------------------------------------------
241
- const borderWidthInput = new LabeledFieldView(locale, createLabeledInputText);
242
- borderWidthInput.set({
243
- label: t('Width'),
244
- class: 'ck-table-form__border-width'
245
- });
246
- borderWidthInput.fieldView.bind('value').to(this, 'borderWidth');
247
- borderWidthInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
248
- borderWidthInput.fieldView.on('input', () => {
249
- this.borderWidth = borderWidthInput.fieldView.element.value;
250
- });
251
- // -- Color ---------------------------------------------------
252
- const borderColorInput = new LabeledFieldView(locale, colorInputCreator);
253
- borderColorInput.set({
254
- label: t('Color'),
255
- class: 'ck-table-form__border-color'
256
- });
257
- borderColorInput.fieldView.bind('value').to(this, 'borderColor');
258
- borderColorInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
259
- borderColorInput.fieldView.on('input', () => {
260
- this.borderColor = borderColorInput.fieldView.value;
261
- });
262
- // Reset the border color and width fields depending on the `border-style` value.
263
- this.on('change:borderStyle', (evt, name, newValue, oldValue) => {
264
- // When removing the border (`border-style:none`), clear the remaining `border-*` properties.
265
- // See: https://github.com/ckeditor/ckeditor5/issues/6227.
266
- if (!isBorderStyleSet(newValue)) {
267
- this.borderColor = '';
268
- this.borderWidth = '';
269
- }
270
- // When setting the `border-style` from `none`, set the default `border-color` and `border-width` properties.
271
- if (!isBorderStyleSet(oldValue)) {
272
- this.borderColor = defaultBorder.color;
273
- this.borderWidth = defaultBorder.width;
274
- }
275
- });
276
- return {
277
- borderRowLabel,
278
- borderStyleDropdown,
279
- borderColorInput,
280
- borderWidthInput
281
- };
282
- }
283
- /**
284
- * Creates the following form fields:
285
- *
286
- * * {@link #backgroundInput}.
287
- */
288
- _createBackgroundFields() {
289
- const locale = this.locale;
290
- const t = this.t;
291
- // -- Group label ---------------------------------------------
292
- const backgroundRowLabel = new LabelView(locale);
293
- backgroundRowLabel.text = t('Background');
294
- // -- Background color input -----------------------------------
295
- const backgroundInputCreator = getLabeledColorInputCreator({
296
- colorConfig: this.options.backgroundColors,
297
- columns: 5,
298
- defaultColorValue: this.options.defaultTableProperties.backgroundColor
299
- });
300
- const backgroundInput = new LabeledFieldView(locale, backgroundInputCreator);
301
- backgroundInput.set({
302
- label: t('Color'),
303
- class: 'ck-table-properties-form__background'
304
- });
305
- backgroundInput.fieldView.bind('value').to(this, 'backgroundColor');
306
- backgroundInput.fieldView.on('input', () => {
307
- this.backgroundColor = backgroundInput.fieldView.value;
308
- });
309
- return {
310
- backgroundRowLabel,
311
- backgroundInput
312
- };
313
- }
314
- /**
315
- * Creates the following form fields:
316
- *
317
- * * {@link #widthInput},
318
- * * {@link #heightInput}.
319
- */
320
- _createDimensionFields() {
321
- const locale = this.locale;
322
- const t = this.t;
323
- // -- Label ---------------------------------------------------
324
- const dimensionsLabel = new LabelView(locale);
325
- dimensionsLabel.text = t('Dimensions');
326
- // -- Width ---------------------------------------------------
327
- const widthInput = new LabeledFieldView(locale, createLabeledInputText);
328
- widthInput.set({
329
- label: t('Width'),
330
- class: 'ck-table-form__dimensions-row__width'
331
- });
332
- widthInput.fieldView.bind('value').to(this, 'width');
333
- widthInput.fieldView.on('input', () => {
334
- this.width = widthInput.fieldView.element.value;
335
- });
336
- // -- Operator ---------------------------------------------------
337
- const operatorLabel = new View(locale);
338
- operatorLabel.setTemplate({
339
- tag: 'span',
340
- attributes: {
341
- class: [
342
- 'ck-table-form__dimension-operator'
343
- ]
344
- },
345
- children: [
346
- { text: '×' }
347
- ]
348
- });
349
- // -- Height ---------------------------------------------------
350
- const heightInput = new LabeledFieldView(locale, createLabeledInputText);
351
- heightInput.set({
352
- label: t('Height'),
353
- class: 'ck-table-form__dimensions-row__height'
354
- });
355
- heightInput.fieldView.bind('value').to(this, 'height');
356
- heightInput.fieldView.on('input', () => {
357
- this.height = heightInput.fieldView.element.value;
358
- });
359
- return {
360
- dimensionsLabel,
361
- widthInput,
362
- operatorLabel,
363
- heightInput
364
- };
365
- }
366
- /**
367
- * Creates the following form fields:
368
- *
369
- * * {@link #alignmentToolbar}.
370
- */
371
- _createAlignmentFields() {
372
- const locale = this.locale;
373
- const t = this.t;
374
- // -- Label ---------------------------------------------------
375
- const alignmentLabel = new LabelView(locale);
376
- alignmentLabel.text = t('Alignment');
377
- // -- Toolbar ---------------------------------------------------
378
- const alignmentToolbar = new ToolbarView(locale);
379
- alignmentToolbar.set({
380
- isCompact: true,
381
- ariaLabel: t('Table alignment toolbar')
382
- });
383
- fillToolbar({
384
- view: this,
385
- icons: ALIGNMENT_ICONS,
386
- toolbar: alignmentToolbar,
387
- labels: this._alignmentLabels,
388
- propertyName: 'alignment',
389
- defaultValue: this.options.defaultTableProperties.alignment
390
- });
391
- return {
392
- alignmentLabel,
393
- alignmentToolbar
394
- };
395
- }
396
- /**
397
- * Creates the following form controls:
398
- *
399
- * * {@link #saveButtonView},
400
- * * {@link #cancelButtonView}.
401
- */
402
- _createActionButtons() {
403
- const locale = this.locale;
404
- const t = this.t;
405
- const saveButtonView = new ButtonView(locale);
406
- const cancelButtonView = new ButtonView(locale);
407
- const fieldsThatShouldValidateToSave = [
408
- this.borderWidthInput,
409
- this.borderColorInput,
410
- this.backgroundInput,
411
- this.widthInput,
412
- this.heightInput
413
- ];
414
- saveButtonView.set({
415
- label: t('Save'),
416
- icon: icons.check,
417
- class: 'ck-button-save',
418
- type: 'submit',
419
- withText: true
420
- });
421
- saveButtonView.bind('isEnabled').toMany(fieldsThatShouldValidateToSave, 'errorText', (...errorTexts) => {
422
- return errorTexts.every(errorText => !errorText);
423
- });
424
- cancelButtonView.set({
425
- label: t('Cancel'),
426
- icon: icons.cancel,
427
- class: 'ck-button-cancel',
428
- withText: true
429
- });
430
- cancelButtonView.delegate('execute').to(this, 'cancel');
431
- return {
432
- saveButtonView, cancelButtonView
433
- };
434
- }
435
- /**
436
- * Provides localized labels for {@link #alignmentToolbar} buttons.
437
- */
438
- get _alignmentLabels() {
439
- const locale = this.locale;
440
- const t = this.t;
441
- const left = t('Align table to the left');
442
- const center = t('Center table');
443
- const right = t('Align table to the right');
444
- // Returns object with a proper order of labels.
445
- if (locale.uiLanguageDirection === 'rtl') {
446
- return { right, center, left };
447
- }
448
- else {
449
- return { left, center, right };
450
- }
451
- }
452
- }
453
- function isBorderStyleSet(value) {
454
- return value !== 'none';
455
- }
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/ui/tablepropertiesview
7
+ */
8
+ import { addListToDropdown, ButtonView, createLabeledDropdown, createLabeledInputText, FocusCycler, FormHeaderView, LabeledFieldView, LabelView, submitHandler, ToolbarView, View, ViewCollection } from 'ckeditor5/src/ui.js';
9
+ import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils.js';
10
+ import { icons } from 'ckeditor5/src/core.js';
11
+ import { fillToolbar, getBorderStyleDefinitions, getBorderStyleLabels, getLabeledColorInputCreator } from '../../utils/ui/table-properties.js';
12
+ import FormRowView from '../../ui/formrowview.js';
13
+ import '../../../theme/form.css';
14
+ import '../../../theme/tableform.css';
15
+ import '../../../theme/tableproperties.css';
16
+ const ALIGNMENT_ICONS = {
17
+ left: icons.objectLeft,
18
+ center: icons.objectCenter,
19
+ right: icons.objectRight
20
+ };
21
+ /**
22
+ * The class representing a table properties form, allowing users to customize
23
+ * certain style aspects of a table, for instance, border, background color, alignment, etc..
24
+ */
25
+ export default class TablePropertiesView extends View {
26
+ /**
27
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
28
+ * @param options Additional configuration of the view.
29
+ */
30
+ constructor(locale, options) {
31
+ super(locale);
32
+ this.set({
33
+ borderStyle: '',
34
+ borderWidth: '',
35
+ borderColor: '',
36
+ backgroundColor: '',
37
+ width: '',
38
+ height: '',
39
+ alignment: ''
40
+ });
41
+ this.options = options;
42
+ const { borderStyleDropdown, borderWidthInput, borderColorInput, borderRowLabel } = this._createBorderFields();
43
+ const { backgroundRowLabel, backgroundInput } = this._createBackgroundFields();
44
+ const { widthInput, operatorLabel, heightInput, dimensionsLabel } = this._createDimensionFields();
45
+ const { alignmentToolbar, alignmentLabel } = this._createAlignmentFields();
46
+ this.focusTracker = new FocusTracker();
47
+ this.keystrokes = new KeystrokeHandler();
48
+ this.children = this.createCollection();
49
+ this.borderStyleDropdown = borderStyleDropdown;
50
+ this.borderWidthInput = borderWidthInput;
51
+ this.borderColorInput = borderColorInput;
52
+ this.backgroundInput = backgroundInput;
53
+ this.widthInput = widthInput;
54
+ this.heightInput = heightInput;
55
+ this.alignmentToolbar = alignmentToolbar;
56
+ // Defer creating to make sure other fields are present and the Save button can
57
+ // bind its #isEnabled to their error messages so there's no way to save unless all
58
+ // fields are valid.
59
+ const { saveButtonView, cancelButtonView } = this._createActionButtons();
60
+ this.saveButtonView = saveButtonView;
61
+ this.cancelButtonView = cancelButtonView;
62
+ this._focusables = new ViewCollection();
63
+ this._focusCycler = new FocusCycler({
64
+ focusables: this._focusables,
65
+ focusTracker: this.focusTracker,
66
+ keystrokeHandler: this.keystrokes,
67
+ actions: {
68
+ // Navigate form fields backwards using the Shift + Tab keystroke.
69
+ focusPrevious: 'shift + tab',
70
+ // Navigate form fields forwards using the Tab key.
71
+ focusNext: 'tab'
72
+ }
73
+ });
74
+ // Form header.
75
+ this.children.add(new FormHeaderView(locale, {
76
+ label: this.t('Table properties')
77
+ }));
78
+ // Border row.
79
+ this.children.add(new FormRowView(locale, {
80
+ labelView: borderRowLabel,
81
+ children: [
82
+ borderRowLabel,
83
+ borderStyleDropdown,
84
+ borderColorInput,
85
+ borderWidthInput
86
+ ],
87
+ class: 'ck-table-form__border-row'
88
+ }));
89
+ // Background row.
90
+ this.children.add(new FormRowView(locale, {
91
+ labelView: backgroundRowLabel,
92
+ children: [
93
+ backgroundRowLabel,
94
+ backgroundInput
95
+ ],
96
+ class: 'ck-table-form__background-row'
97
+ }));
98
+ this.children.add(new FormRowView(locale, {
99
+ children: [
100
+ // Dimensions row.
101
+ new FormRowView(locale, {
102
+ labelView: dimensionsLabel,
103
+ children: [
104
+ dimensionsLabel,
105
+ widthInput,
106
+ operatorLabel,
107
+ heightInput
108
+ ],
109
+ class: 'ck-table-form__dimensions-row'
110
+ }),
111
+ // Alignment row.
112
+ new FormRowView(locale, {
113
+ labelView: alignmentLabel,
114
+ children: [
115
+ alignmentLabel,
116
+ alignmentToolbar
117
+ ],
118
+ class: 'ck-table-properties-form__alignment-row'
119
+ })
120
+ ]
121
+ }));
122
+ // Action row.
123
+ this.children.add(new FormRowView(locale, {
124
+ children: [
125
+ this.saveButtonView,
126
+ this.cancelButtonView
127
+ ],
128
+ class: 'ck-table-form__action-row'
129
+ }));
130
+ this.setTemplate({
131
+ tag: 'form',
132
+ attributes: {
133
+ class: [
134
+ 'ck',
135
+ 'ck-form',
136
+ 'ck-table-form',
137
+ 'ck-table-properties-form'
138
+ ],
139
+ // https://github.com/ckeditor/ckeditor5-link/issues/90
140
+ tabindex: '-1'
141
+ },
142
+ children: this.children
143
+ });
144
+ }
145
+ /**
146
+ * @inheritDoc
147
+ */
148
+ render() {
149
+ super.render();
150
+ // Enable the "submit" event for this view. It can be triggered by the #saveButtonView
151
+ // which is of the "submit" DOM "type".
152
+ submitHandler({
153
+ view: this
154
+ });
155
+ [
156
+ this.borderStyleDropdown,
157
+ this.borderColorInput,
158
+ this.borderColorInput.fieldView.dropdownView.buttonView,
159
+ this.borderWidthInput,
160
+ this.backgroundInput,
161
+ this.backgroundInput.fieldView.dropdownView.buttonView,
162
+ this.widthInput,
163
+ this.heightInput,
164
+ this.alignmentToolbar,
165
+ this.saveButtonView,
166
+ this.cancelButtonView
167
+ ].forEach(view => {
168
+ // Register the view as focusable.
169
+ this._focusables.add(view);
170
+ // Register the view in the focus tracker.
171
+ this.focusTracker.add(view.element);
172
+ });
173
+ // Mainly for closing using "Esc" and navigation using "Tab".
174
+ this.keystrokes.listenTo(this.element);
175
+ }
176
+ /**
177
+ * @inheritDoc
178
+ */
179
+ destroy() {
180
+ super.destroy();
181
+ this.focusTracker.destroy();
182
+ this.keystrokes.destroy();
183
+ }
184
+ /**
185
+ * Focuses the fist focusable field in the form.
186
+ */
187
+ focus() {
188
+ this._focusCycler.focusFirst();
189
+ }
190
+ /**
191
+ * Creates the following form fields:
192
+ *
193
+ * * {@link #borderStyleDropdown},
194
+ * * {@link #borderWidthInput},
195
+ * * {@link #borderColorInput}.
196
+ */
197
+ _createBorderFields() {
198
+ const defaultTableProperties = this.options.defaultTableProperties;
199
+ const defaultBorder = {
200
+ style: defaultTableProperties.borderStyle,
201
+ width: defaultTableProperties.borderWidth,
202
+ color: defaultTableProperties.borderColor
203
+ };
204
+ const colorInputCreator = getLabeledColorInputCreator({
205
+ colorConfig: this.options.borderColors,
206
+ columns: 5,
207
+ defaultColorValue: defaultBorder.color,
208
+ colorPickerConfig: this.options.colorPickerConfig
209
+ });
210
+ const locale = this.locale;
211
+ const t = this.t;
212
+ const accessibleLabel = t('Style');
213
+ // -- Group label ---------------------------------------------
214
+ const borderRowLabel = new LabelView(locale);
215
+ borderRowLabel.text = t('Border');
216
+ // -- Style ---------------------------------------------------
217
+ const styleLabels = getBorderStyleLabels(t);
218
+ const borderStyleDropdown = new LabeledFieldView(locale, createLabeledDropdown);
219
+ borderStyleDropdown.set({
220
+ label: accessibleLabel,
221
+ class: 'ck-table-form__border-style'
222
+ });
223
+ borderStyleDropdown.fieldView.buttonView.set({
224
+ ariaLabel: accessibleLabel,
225
+ ariaLabelledBy: undefined,
226
+ isOn: false,
227
+ withText: true,
228
+ tooltip: accessibleLabel
229
+ });
230
+ borderStyleDropdown.fieldView.buttonView.bind('label').to(this, 'borderStyle', value => {
231
+ return styleLabels[value ? value : 'none'];
232
+ });
233
+ borderStyleDropdown.fieldView.on('execute', evt => {
234
+ this.borderStyle = evt.source._borderStyleValue;
235
+ });
236
+ borderStyleDropdown.bind('isEmpty').to(this, 'borderStyle', value => !value);
237
+ addListToDropdown(borderStyleDropdown.fieldView, getBorderStyleDefinitions(this, defaultBorder.style), {
238
+ role: 'menu',
239
+ ariaLabel: accessibleLabel
240
+ });
241
+ // -- Width ---------------------------------------------------
242
+ const borderWidthInput = new LabeledFieldView(locale, createLabeledInputText);
243
+ borderWidthInput.set({
244
+ label: t('Width'),
245
+ class: 'ck-table-form__border-width'
246
+ });
247
+ borderWidthInput.fieldView.bind('value').to(this, 'borderWidth');
248
+ borderWidthInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
249
+ borderWidthInput.fieldView.on('input', () => {
250
+ this.borderWidth = borderWidthInput.fieldView.element.value;
251
+ });
252
+ // -- Color ---------------------------------------------------
253
+ const borderColorInput = new LabeledFieldView(locale, colorInputCreator);
254
+ borderColorInput.set({
255
+ label: t('Color'),
256
+ class: 'ck-table-form__border-color'
257
+ });
258
+ borderColorInput.fieldView.bind('value').to(this, 'borderColor');
259
+ borderColorInput.bind('isEnabled').to(this, 'borderStyle', isBorderStyleSet);
260
+ borderColorInput.fieldView.on('input', () => {
261
+ this.borderColor = borderColorInput.fieldView.value;
262
+ });
263
+ // Reset the border color and width fields depending on the `border-style` value.
264
+ this.on('change:borderStyle', (evt, name, newValue, oldValue) => {
265
+ // When removing the border (`border-style:none`), clear the remaining `border-*` properties.
266
+ // See: https://github.com/ckeditor/ckeditor5/issues/6227.
267
+ if (!isBorderStyleSet(newValue)) {
268
+ this.borderColor = '';
269
+ this.borderWidth = '';
270
+ }
271
+ // When setting the `border-style` from `none`, set the default `border-color` and `border-width` properties.
272
+ if (!isBorderStyleSet(oldValue)) {
273
+ this.borderColor = defaultBorder.color;
274
+ this.borderWidth = defaultBorder.width;
275
+ }
276
+ });
277
+ return {
278
+ borderRowLabel,
279
+ borderStyleDropdown,
280
+ borderColorInput,
281
+ borderWidthInput
282
+ };
283
+ }
284
+ /**
285
+ * Creates the following form fields:
286
+ *
287
+ * * {@link #backgroundInput}.
288
+ */
289
+ _createBackgroundFields() {
290
+ const locale = this.locale;
291
+ const t = this.t;
292
+ // -- Group label ---------------------------------------------
293
+ const backgroundRowLabel = new LabelView(locale);
294
+ backgroundRowLabel.text = t('Background');
295
+ // -- Background color input -----------------------------------
296
+ const backgroundInputCreator = getLabeledColorInputCreator({
297
+ colorConfig: this.options.backgroundColors,
298
+ columns: 5,
299
+ defaultColorValue: this.options.defaultTableProperties.backgroundColor,
300
+ colorPickerConfig: this.options.colorPickerConfig
301
+ });
302
+ const backgroundInput = new LabeledFieldView(locale, backgroundInputCreator);
303
+ backgroundInput.set({
304
+ label: t('Color'),
305
+ class: 'ck-table-properties-form__background'
306
+ });
307
+ backgroundInput.fieldView.bind('value').to(this, 'backgroundColor');
308
+ backgroundInput.fieldView.on('input', () => {
309
+ this.backgroundColor = backgroundInput.fieldView.value;
310
+ });
311
+ return {
312
+ backgroundRowLabel,
313
+ backgroundInput
314
+ };
315
+ }
316
+ /**
317
+ * Creates the following form fields:
318
+ *
319
+ * * {@link #widthInput},
320
+ * * {@link #heightInput}.
321
+ */
322
+ _createDimensionFields() {
323
+ const locale = this.locale;
324
+ const t = this.t;
325
+ // -- Label ---------------------------------------------------
326
+ const dimensionsLabel = new LabelView(locale);
327
+ dimensionsLabel.text = t('Dimensions');
328
+ // -- Width ---------------------------------------------------
329
+ const widthInput = new LabeledFieldView(locale, createLabeledInputText);
330
+ widthInput.set({
331
+ label: t('Width'),
332
+ class: 'ck-table-form__dimensions-row__width'
333
+ });
334
+ widthInput.fieldView.bind('value').to(this, 'width');
335
+ widthInput.fieldView.on('input', () => {
336
+ this.width = widthInput.fieldView.element.value;
337
+ });
338
+ // -- Operator ---------------------------------------------------
339
+ const operatorLabel = new View(locale);
340
+ operatorLabel.setTemplate({
341
+ tag: 'span',
342
+ attributes: {
343
+ class: [
344
+ 'ck-table-form__dimension-operator'
345
+ ]
346
+ },
347
+ children: [
348
+ { text: '×' }
349
+ ]
350
+ });
351
+ // -- Height ---------------------------------------------------
352
+ const heightInput = new LabeledFieldView(locale, createLabeledInputText);
353
+ heightInput.set({
354
+ label: t('Height'),
355
+ class: 'ck-table-form__dimensions-row__height'
356
+ });
357
+ heightInput.fieldView.bind('value').to(this, 'height');
358
+ heightInput.fieldView.on('input', () => {
359
+ this.height = heightInput.fieldView.element.value;
360
+ });
361
+ return {
362
+ dimensionsLabel,
363
+ widthInput,
364
+ operatorLabel,
365
+ heightInput
366
+ };
367
+ }
368
+ /**
369
+ * Creates the following form fields:
370
+ *
371
+ * * {@link #alignmentToolbar}.
372
+ */
373
+ _createAlignmentFields() {
374
+ const locale = this.locale;
375
+ const t = this.t;
376
+ // -- Label ---------------------------------------------------
377
+ const alignmentLabel = new LabelView(locale);
378
+ alignmentLabel.text = t('Alignment');
379
+ // -- Toolbar ---------------------------------------------------
380
+ const alignmentToolbar = new ToolbarView(locale);
381
+ alignmentToolbar.set({
382
+ isCompact: true,
383
+ ariaLabel: t('Table alignment toolbar')
384
+ });
385
+ fillToolbar({
386
+ view: this,
387
+ icons: ALIGNMENT_ICONS,
388
+ toolbar: alignmentToolbar,
389
+ labels: this._alignmentLabels,
390
+ propertyName: 'alignment',
391
+ defaultValue: this.options.defaultTableProperties.alignment
392
+ });
393
+ return {
394
+ alignmentLabel,
395
+ alignmentToolbar
396
+ };
397
+ }
398
+ /**
399
+ * Creates the following form controls:
400
+ *
401
+ * * {@link #saveButtonView},
402
+ * * {@link #cancelButtonView}.
403
+ */
404
+ _createActionButtons() {
405
+ const locale = this.locale;
406
+ const t = this.t;
407
+ const saveButtonView = new ButtonView(locale);
408
+ const cancelButtonView = new ButtonView(locale);
409
+ const fieldsThatShouldValidateToSave = [
410
+ this.borderWidthInput,
411
+ this.borderColorInput,
412
+ this.backgroundInput,
413
+ this.widthInput,
414
+ this.heightInput
415
+ ];
416
+ saveButtonView.set({
417
+ label: t('Save'),
418
+ icon: icons.check,
419
+ class: 'ck-button-save',
420
+ type: 'submit',
421
+ withText: true
422
+ });
423
+ saveButtonView.bind('isEnabled').toMany(fieldsThatShouldValidateToSave, 'errorText', (...errorTexts) => {
424
+ return errorTexts.every(errorText => !errorText);
425
+ });
426
+ cancelButtonView.set({
427
+ label: t('Cancel'),
428
+ icon: icons.cancel,
429
+ class: 'ck-button-cancel',
430
+ withText: true
431
+ });
432
+ cancelButtonView.delegate('execute').to(this, 'cancel');
433
+ return {
434
+ saveButtonView, cancelButtonView
435
+ };
436
+ }
437
+ /**
438
+ * Provides localized labels for {@link #alignmentToolbar} buttons.
439
+ */
440
+ get _alignmentLabels() {
441
+ const locale = this.locale;
442
+ const t = this.t;
443
+ const left = t('Align table to the left');
444
+ const center = t('Center table');
445
+ const right = t('Align table to the right');
446
+ // Returns object with a proper order of labels.
447
+ if (locale.uiLanguageDirection === 'rtl') {
448
+ return { right, center, left };
449
+ }
450
+ else {
451
+ return { left, center, right };
452
+ }
453
+ }
454
+ }
455
+ function isBorderStyleSet(value) {
456
+ return value !== 'none';
457
+ }