@ckeditor/ckeditor5-table 40.0.0 → 40.2.0

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