@ckeditor/ckeditor5-table 36.0.0 → 37.0.0-alpha.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 (166) hide show
  1. package/build/table.js +1 -1
  2. package/package.json +34 -29
  3. package/src/commands/insertcolumncommand.d.ts +61 -0
  4. package/src/commands/insertcolumncommand.js +45 -60
  5. package/src/commands/insertrowcommand.d.ts +60 -0
  6. package/src/commands/insertrowcommand.js +44 -59
  7. package/src/commands/inserttablecommand.d.ts +50 -0
  8. package/src/commands/inserttablecommand.js +51 -68
  9. package/src/commands/mergecellcommand.d.ts +76 -0
  10. package/src/commands/mergecellcommand.js +169 -244
  11. package/src/commands/mergecellscommand.d.ts +33 -0
  12. package/src/commands/mergecellscommand.js +72 -101
  13. package/src/commands/removecolumncommand.d.ts +34 -0
  14. package/src/commands/removecolumncommand.js +88 -102
  15. package/src/commands/removerowcommand.d.ts +34 -0
  16. package/src/commands/removerowcommand.js +63 -80
  17. package/src/commands/selectcolumncommand.d.ts +38 -0
  18. package/src/commands/selectcolumncommand.js +41 -54
  19. package/src/commands/selectrowcommand.d.ts +38 -0
  20. package/src/commands/selectrowcommand.js +38 -48
  21. package/src/commands/setheadercolumncommand.d.ts +55 -0
  22. package/src/commands/setheadercolumncommand.js +48 -73
  23. package/src/commands/setheaderrowcommand.d.ts +58 -0
  24. package/src/commands/setheaderrowcommand.js +56 -85
  25. package/src/commands/splitcellcommand.d.ts +49 -0
  26. package/src/commands/splitcellcommand.js +35 -49
  27. package/src/converters/downcast.d.ts +63 -0
  28. package/src/converters/downcast.js +98 -130
  29. package/src/converters/table-caption-post-fixer.d.ts +20 -0
  30. package/src/converters/table-caption-post-fixer.js +36 -52
  31. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -0
  32. package/src/converters/table-cell-paragraph-post-fixer.js +88 -119
  33. package/src/converters/table-cell-refresh-handler.d.ts +18 -0
  34. package/src/converters/table-cell-refresh-handler.js +29 -48
  35. package/src/converters/table-headings-refresh-handler.d.ts +17 -0
  36. package/src/converters/table-headings-refresh-handler.js +35 -54
  37. package/src/converters/table-layout-post-fixer.d.ts +226 -0
  38. package/src/converters/table-layout-post-fixer.js +276 -313
  39. package/src/converters/tableproperties.d.ts +54 -0
  40. package/src/converters/tableproperties.js +136 -168
  41. package/src/converters/upcasttable.d.ts +49 -0
  42. package/src/converters/upcasttable.js +196 -251
  43. package/src/index.d.ts +29 -0
  44. package/src/index.js +0 -2
  45. package/src/plaintableoutput.d.ts +30 -0
  46. package/src/plaintableoutput.js +107 -135
  47. package/src/table.d.ts +38 -0
  48. package/src/table.js +12 -88
  49. package/src/tablecaption/tablecaptionediting.d.ts +68 -0
  50. package/src/tablecaption/tablecaptionediting.js +104 -135
  51. package/src/tablecaption/tablecaptionui.d.ts +26 -0
  52. package/src/tablecaption/tablecaptionui.js +42 -58
  53. package/src/tablecaption/toggletablecaptioncommand.d.ts +73 -0
  54. package/src/tablecaption/toggletablecaptioncommand.js +77 -92
  55. package/src/tablecaption/utils.d.ts +42 -0
  56. package/src/tablecaption/utils.js +35 -61
  57. package/src/tablecaption.d.ts +27 -0
  58. package/src/tablecaption.js +12 -19
  59. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +37 -0
  60. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +14 -20
  61. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +42 -0
  62. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +27 -37
  63. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +42 -0
  64. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +27 -37
  65. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +56 -0
  66. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +42 -53
  67. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +51 -0
  68. package/src/tablecellproperties/commands/tablecellheightcommand.js +29 -36
  69. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +37 -0
  70. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +14 -20
  71. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +56 -0
  72. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +42 -53
  73. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -0
  74. package/src/tablecellproperties/commands/tablecellpropertycommand.js +77 -122
  75. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +45 -0
  76. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +14 -20
  77. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +47 -0
  78. package/src/tablecellproperties/tablecellpropertiesediting.js +194 -236
  79. package/src/tablecellproperties/tablecellpropertiesui.d.ts +117 -0
  80. package/src/tablecellproperties/tablecellpropertiesui.js +303 -456
  81. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -0
  82. package/src/tablecellproperties/ui/tablecellpropertiesview.js +509 -844
  83. package/src/tablecellproperties.d.ts +33 -0
  84. package/src/tablecellproperties.js +12 -98
  85. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +51 -0
  86. package/src/tablecellwidth/commands/tablecellwidthcommand.js +29 -35
  87. package/src/tablecellwidth/tablecellwidthediting.d.ts +34 -0
  88. package/src/tablecellwidth/tablecellwidthediting.js +26 -38
  89. package/src/tableclipboard.d.ts +68 -0
  90. package/src/tableclipboard.js +429 -568
  91. package/src/tablecolumnresize/constants.d.ts +20 -0
  92. package/src/tablecolumnresize/constants.js +0 -10
  93. package/src/tablecolumnresize/converters.d.ts +18 -0
  94. package/src/tablecolumnresize/converters.js +35 -119
  95. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +142 -0
  96. package/src/tablecolumnresize/tablecolumnresizeediting.js +545 -711
  97. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -0
  98. package/src/tablecolumnresize/tablewidthscommand.js +61 -0
  99. package/src/tablecolumnresize/utils.d.ts +141 -0
  100. package/src/tablecolumnresize/utils.js +256 -233
  101. package/src/tablecolumnresize.d.ts +29 -0
  102. package/src/tablecolumnresize.js +12 -19
  103. package/src/tableconfig.d.ts +341 -0
  104. package/src/tableconfig.js +5 -0
  105. package/src/tableediting.d.ts +102 -0
  106. package/src/tableediting.js +157 -176
  107. package/src/tablekeyboard.d.ts +68 -0
  108. package/src/tablekeyboard.js +261 -344
  109. package/src/tablemouse/mouseeventsobserver.d.ts +62 -0
  110. package/src/tablemouse/mouseeventsobserver.js +12 -49
  111. package/src/tablemouse.d.ts +51 -0
  112. package/src/tablemouse.js +154 -202
  113. package/src/tableproperties/commands/tablealignmentcommand.d.ts +37 -0
  114. package/src/tableproperties/commands/tablealignmentcommand.js +14 -20
  115. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +37 -0
  116. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +14 -20
  117. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +42 -0
  118. package/src/tableproperties/commands/tablebordercolorcommand.js +27 -37
  119. package/src/tableproperties/commands/tableborderstylecommand.d.ts +42 -0
  120. package/src/tableproperties/commands/tableborderstylecommand.js +27 -37
  121. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +56 -0
  122. package/src/tableproperties/commands/tableborderwidthcommand.js +42 -53
  123. package/src/tableproperties/commands/tableheightcommand.d.ts +51 -0
  124. package/src/tableproperties/commands/tableheightcommand.js +29 -33
  125. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -0
  126. package/src/tableproperties/commands/tablepropertycommand.js +68 -112
  127. package/src/tableproperties/commands/tablewidthcommand.d.ts +51 -0
  128. package/src/tableproperties/commands/tablewidthcommand.js +29 -33
  129. package/src/tableproperties/tablepropertiesediting.d.ts +45 -0
  130. package/src/tableproperties/tablepropertiesediting.js +164 -210
  131. package/src/tableproperties/tablepropertiesui.d.ts +119 -0
  132. package/src/tableproperties/tablepropertiesui.js +294 -439
  133. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -0
  134. package/src/tableproperties/ui/tablepropertiesview.js +427 -718
  135. package/src/tableproperties.d.ts +33 -0
  136. package/src/tableproperties.js +12 -95
  137. package/src/tableselection.d.ts +111 -0
  138. package/src/tableselection.js +279 -376
  139. package/src/tabletoolbar.d.ts +37 -0
  140. package/src/tabletoolbar.js +39 -92
  141. package/src/tableui.d.ts +58 -0
  142. package/src/tableui.js +281 -338
  143. package/src/tableutils.d.ts +453 -0
  144. package/src/tableutils.js +1015 -1229
  145. package/src/tablewalker.d.ts +323 -0
  146. package/src/tablewalker.js +308 -548
  147. package/src/ui/colorinputview.d.ts +143 -0
  148. package/src/ui/colorinputview.js +229 -366
  149. package/src/ui/formrowview.d.ts +61 -0
  150. package/src/ui/formrowview.js +38 -84
  151. package/src/ui/inserttableview.d.ts +77 -0
  152. package/src/ui/inserttableview.js +152 -242
  153. package/src/utils/common.d.ts +42 -0
  154. package/src/utils/common.js +33 -57
  155. package/src/utils/structure.d.ts +245 -0
  156. package/src/utils/structure.js +261 -379
  157. package/src/utils/table-properties.d.ts +67 -0
  158. package/src/utils/table-properties.js +60 -81
  159. package/src/utils/ui/contextualballoon.d.ts +34 -0
  160. package/src/utils/ui/contextualballoon.js +70 -89
  161. package/src/utils/ui/table-properties.d.ts +193 -0
  162. package/src/utils/ui/table-properties.js +259 -319
  163. package/src/utils/ui/widget.d.ts +16 -0
  164. package/src/utils/ui/widget.js +24 -46
  165. package/src/tablecolumnresize/tablecolumnwidthscommand.js +0 -55
  166. package/src/tablecolumnresize/tablewidthresizecommand.js +0 -65
@@ -2,464 +2,319 @@
2
2
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
4
  */
5
-
6
5
  /**
7
6
  * @module table/tableproperties/tablepropertiesui
8
7
  */
9
-
10
8
  import { Plugin } from 'ckeditor5/src/core';
11
9
  import { ButtonView, ContextualBalloon, clickOutsideHandler, getLocalizedColorOptions, normalizeColorOptions } from 'ckeditor5/src/ui';
12
-
13
10
  import { debounce } from 'lodash-es';
14
-
15
11
  import TablePropertiesView from './ui/tablepropertiesview';
16
12
  import tableProperties from './../../theme/icons/table-properties.svg';
17
- import {
18
- colorFieldValidator,
19
- getLocalizedColorErrorText,
20
- getLocalizedLengthErrorText,
21
- lengthFieldValidator,
22
- lineWidthFieldValidator,
23
- defaultColors
24
- } from '../utils/ui/table-properties';
13
+ import { colorFieldValidator, getLocalizedColorErrorText, getLocalizedLengthErrorText, lengthFieldValidator, lineWidthFieldValidator, defaultColors } from '../utils/ui/table-properties';
25
14
  import { getTableWidgetAncestor } from '../utils/ui/widget';
26
15
  import { getBalloonTablePositionData, repositionContextualBalloon } from '../utils/ui/contextualballoon';
27
16
  import { getNormalizedDefaultProperties } from '../utils/table-properties';
28
-
17
+ import '../tableconfig';
29
18
  const ERROR_TEXT_TIMEOUT = 500;
30
-
31
19
  // Map of view properties and related commands.
32
20
  const propertyToCommandMap = {
33
- borderStyle: 'tableBorderStyle',
34
- borderColor: 'tableBorderColor',
35
- borderWidth: 'tableBorderWidth',
36
- backgroundColor: 'tableBackgroundColor',
37
- width: 'tableWidth',
38
- height: 'tableHeight',
39
- alignment: 'tableAlignment'
21
+ borderStyle: 'tableBorderStyle',
22
+ borderColor: 'tableBorderColor',
23
+ borderWidth: 'tableBorderWidth',
24
+ backgroundColor: 'tableBackgroundColor',
25
+ width: 'tableWidth',
26
+ height: 'tableHeight',
27
+ alignment: 'tableAlignment'
40
28
  };
41
-
42
29
  /**
43
30
  * The table properties UI plugin. It introduces the `'tableProperties'` button
44
31
  * that opens a form allowing to specify visual styling of an entire table.
45
32
  *
46
- * It uses the
47
- * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
48
- *
49
- * @extends module:core/plugin~Plugin
33
+ * It uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
50
34
  */
51
35
  export default class TablePropertiesUI extends Plugin {
52
- /**
53
- * @inheritDoc
54
- */
55
- static get requires() {
56
- return [ ContextualBalloon ];
57
- }
58
-
59
- /**
60
- * @inheritDoc
61
- */
62
- static get pluginName() {
63
- return 'TablePropertiesUI';
64
- }
65
-
66
- /**
67
- * @inheritDoc
68
- */
69
- constructor( editor ) {
70
- super( editor );
71
-
72
- editor.config.define( 'table.tableProperties', {
73
- borderColors: defaultColors,
74
- backgroundColors: defaultColors
75
- } );
76
- }
77
-
78
- /**
79
- * @inheritDoc
80
- */
81
- init() {
82
- const editor = this.editor;
83
- const t = editor.t;
84
-
85
- /**
86
- * The default table properties.
87
- *
88
- * @protected
89
- * @member {module:table/tableproperties~TablePropertiesOptions}
90
- */
91
- this._defaultTableProperties = getNormalizedDefaultProperties( editor.config.get( 'table.tableProperties.defaultProperties' ), {
92
- includeAlignmentProperty: true
93
- } );
94
-
95
- /**
96
- * The contextual balloon plugin instance.
97
- *
98
- * @private
99
- * @member {module:ui/panel/balloon/contextualballoon~ContextualBalloon}
100
- */
101
- this._balloon = editor.plugins.get( ContextualBalloon );
102
-
103
- /**
104
- * The properties form view displayed inside the balloon.
105
- *
106
- * @member {module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView}
107
- */
108
- this.view = null;
109
-
110
- /**
111
- * The batch used to undo all changes made by the form (which are live, as the user types)
112
- * when "Cancel" was pressed. Each time the view is shown, a new batch is created.
113
- *
114
- * @protected
115
- * @member {module:engine/model/batch~Batch}
116
- */
117
- this._undoStepBatch = null;
118
-
119
- /**
120
- * Flag used to indicate whether view is ready to execute update commands
121
- * (it finished loading initial data).
122
- *
123
- * @private
124
- * @member {Boolean}
125
- */
126
- this._isReady = false;
127
-
128
- editor.ui.componentFactory.add( 'tableProperties', locale => {
129
- const view = new ButtonView( locale );
130
-
131
- view.set( {
132
- label: t( 'Table properties' ),
133
- icon: tableProperties,
134
- tooltip: true
135
- } );
136
-
137
- this.listenTo( view, 'execute', () => this._showView() );
138
-
139
- const commands = Object.values( propertyToCommandMap )
140
- .map( commandName => editor.commands.get( commandName ) );
141
-
142
- view.bind( 'isEnabled' ).toMany( commands, 'isEnabled', ( ...areEnabled ) => (
143
- areEnabled.some( isCommandEnabled => isCommandEnabled )
144
- ) );
145
-
146
- return view;
147
- } );
148
- }
149
-
150
- /**
151
- * @inheritDoc
152
- */
153
- destroy() {
154
- super.destroy();
155
-
156
- // Destroy created UI components as they are not automatically destroyed.
157
- // See https://github.com/ckeditor/ckeditor5/issues/1341.
158
- if ( this.view ) {
159
- this.view.destroy();
160
- }
161
- }
162
-
163
- /**
164
- * Creates the {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView} instance.
165
- *
166
- * @private
167
- * @returns {module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView} The table
168
- * properties form view instance.
169
- */
170
- _createPropertiesView() {
171
- const editor = this.editor;
172
- const config = editor.config.get( 'table.tableProperties' );
173
- const borderColorsConfig = normalizeColorOptions( config.borderColors );
174
- const localizedBorderColors = getLocalizedColorOptions( editor.locale, borderColorsConfig );
175
- const backgroundColorsConfig = normalizeColorOptions( config.backgroundColors );
176
- const localizedBackgroundColors = getLocalizedColorOptions( editor.locale, backgroundColorsConfig );
177
-
178
- const view = new TablePropertiesView( editor.locale, {
179
- borderColors: localizedBorderColors,
180
- backgroundColors: localizedBackgroundColors,
181
- defaultTableProperties: this._defaultTableProperties
182
- } );
183
- const t = editor.t;
184
-
185
- // Render the view so its #element is available for the clickOutsideHandler.
186
- view.render();
187
-
188
- this.listenTo( view, 'submit', () => {
189
- this._hideView();
190
- } );
191
-
192
- this.listenTo( view, 'cancel', () => {
193
- // https://github.com/ckeditor/ckeditor5/issues/6180
194
- if ( this._undoStepBatch.operations.length ) {
195
- editor.execute( 'undo', this._undoStepBatch );
196
- }
197
-
198
- this._hideView();
199
- } );
200
-
201
- // Close the balloon on Esc key press.
202
- view.keystrokes.set( 'Esc', ( data, cancel ) => {
203
- this._hideView();
204
- cancel();
205
- } );
206
-
207
- // Close on click outside of balloon panel element.
208
- clickOutsideHandler( {
209
- emitter: view,
210
- activator: () => this._isViewInBalloon,
211
- contextElements: [ this._balloon.view.element ],
212
- callback: () => this._hideView()
213
- } );
214
-
215
- const colorErrorText = getLocalizedColorErrorText( t );
216
- const lengthErrorText = getLocalizedLengthErrorText( t );
217
-
218
- // Create the "UI -> editor data" binding.
219
- // These listeners update the editor data (via table commands) when any observable
220
- // property of the view has changed. They also validate the value and display errors in the UI
221
- // when necessary. This makes the view live, which means the changes are
222
- // visible in the editing as soon as the user types or changes fields' values.
223
- view.on(
224
- 'change:borderStyle',
225
- this._getPropertyChangeCallback( 'tableBorderStyle', this._defaultTableProperties.borderStyle )
226
- );
227
-
228
- view.on( 'change:borderColor', this._getValidatedPropertyChangeCallback( {
229
- viewField: view.borderColorInput,
230
- commandName: 'tableBorderColor',
231
- errorText: colorErrorText,
232
- validator: colorFieldValidator,
233
- defaultValue: this._defaultTableProperties.borderColor
234
- } ) );
235
-
236
- view.on( 'change:borderWidth', this._getValidatedPropertyChangeCallback( {
237
- viewField: view.borderWidthInput,
238
- commandName: 'tableBorderWidth',
239
- errorText: lengthErrorText,
240
- validator: lineWidthFieldValidator,
241
- defaultValue: this._defaultTableProperties.borderWidth
242
- } ) );
243
-
244
- view.on( 'change:backgroundColor', this._getValidatedPropertyChangeCallback( {
245
- viewField: view.backgroundInput,
246
- commandName: 'tableBackgroundColor',
247
- errorText: colorErrorText,
248
- validator: colorFieldValidator,
249
- defaultValue: this._defaultTableProperties.backgroundColor
250
- } ) );
251
-
252
- view.on( 'change:width', this._getValidatedPropertyChangeCallback( {
253
- viewField: view.widthInput,
254
- commandName: 'tableWidth',
255
- errorText: lengthErrorText,
256
- validator: lengthFieldValidator,
257
- defaultValue: this._defaultTableProperties.width
258
- } ) );
259
-
260
- view.on( 'change:height', this._getValidatedPropertyChangeCallback( {
261
- viewField: view.heightInput,
262
- commandName: 'tableHeight',
263
- errorText: lengthErrorText,
264
- validator: lengthFieldValidator,
265
- defaultValue: this._defaultTableProperties.height
266
- } ) );
267
-
268
- view.on(
269
- 'change:alignment',
270
- this._getPropertyChangeCallback( 'tableAlignment', this._defaultTableProperties.alignment )
271
- );
272
-
273
- return view;
274
- }
275
-
276
- /**
277
- * In this method the "editor data -> UI" binding is happening.
278
- *
279
- * When executed, this method obtains selected table property values from various table commands
280
- * and passes them to the {@link #view}.
281
- *
282
- * This way, the UI stays up–to–date with the editor data.
283
- *
284
- * @private
285
- */
286
- _fillViewFormFromCommandValues() {
287
- const commands = this.editor.commands;
288
- const borderStyleCommand = commands.get( 'tableBorderStyle' );
289
-
290
- Object.entries( propertyToCommandMap )
291
- .map( ( [ property, commandName ] ) => {
292
- const defaultValue = this._defaultTableProperties[ property ] || '';
293
-
294
- return [ property, commands.get( commandName ).value || defaultValue ];
295
- } )
296
- .forEach( ( [ property, value ] ) => {
297
- // Do not set the `border-color` and `border-width` fields if `border-style:none`.
298
- if ( ( property === 'borderColor' || property === 'borderWidth' ) && borderStyleCommand.value === 'none' ) {
299
- return;
300
- }
301
-
302
- this.view.set( property, value );
303
- } );
304
-
305
- this._isReady = true;
306
- }
307
-
308
- /**
309
- * Shows the {@link #view} in the {@link #_balloon}.
310
- *
311
- * **Note**: Each time a view is shown, the new {@link #_undoStepBatch} is created that contains
312
- * all changes made to the document when the view is visible, allowing a single undo step
313
- * for all of them.
314
- *
315
- * @protected
316
- */
317
- _showView() {
318
- const editor = this.editor;
319
-
320
- if ( !this.view ) {
321
- this.view = this._createPropertiesView();
322
- }
323
-
324
- this.listenTo( editor.ui, 'update', () => {
325
- this._updateView();
326
- } );
327
-
328
- // Update the view with the model values.
329
- this._fillViewFormFromCommandValues();
330
-
331
- this._balloon.add( {
332
- view: this.view,
333
- position: getBalloonTablePositionData( editor )
334
- } );
335
-
336
- // Create a new batch. Clicking "Cancel" will undo this batch.
337
- this._undoStepBatch = editor.model.createBatch();
338
-
339
- // Basic a11y.
340
- this.view.focus();
341
- }
342
-
343
- /**
344
- * Removes the {@link #view} from the {@link #_balloon}.
345
- *
346
- * @protected
347
- */
348
- _hideView() {
349
- const editor = this.editor;
350
-
351
- this.stopListening( editor.ui, 'update' );
352
-
353
- this._isReady = false;
354
-
355
- // Blur any input element before removing it from DOM to prevent issues in some browsers.
356
- // See https://github.com/ckeditor/ckeditor5/issues/1501.
357
- this.view.saveButtonView.focus();
358
-
359
- this._balloon.remove( this.view );
360
-
361
- // Make sure the focus is not lost in the process by putting it directly
362
- // into the editing view.
363
- this.editor.editing.view.focus();
364
- }
365
-
366
- /**
367
- * Repositions the {@link #_balloon} or hides the {@link #view} if a table is no longer selected.
368
- *
369
- * @protected
370
- */
371
- _updateView() {
372
- const editor = this.editor;
373
- const viewDocument = editor.editing.view.document;
374
-
375
- if ( !getTableWidgetAncestor( viewDocument.selection ) ) {
376
- this._hideView();
377
- } else if ( this._isViewVisible ) {
378
- repositionContextualBalloon( editor, 'table' );
379
- }
380
- }
381
-
382
- /**
383
- * Returns `true` when the {@link #view} is the visible in the {@link #_balloon}.
384
- *
385
- * @private
386
- * @type {Boolean}
387
- */
388
- get _isViewVisible() {
389
- return !!this.view && this._balloon.visibleView === this.view;
390
- }
391
-
392
- /**
393
- * Returns `true` when the {@link #view} is in the {@link #_balloon}.
394
- *
395
- * @private
396
- * @type {Boolean}
397
- */
398
- get _isViewInBalloon() {
399
- return !!this.view && this._balloon.hasView( this.view );
400
- }
401
-
402
- /**
403
- * Creates a callback that when executed upon {@link #view view's} property change
404
- * executes a related editor command with the new property value.
405
- *
406
- * If new value will be set to the default value, the command will not be executed.
407
- *
408
- * @private
409
- * @param {String} commandName The command that will be executed.
410
- * @returns {Function}
411
- */
412
- _getPropertyChangeCallback( commandName ) {
413
- return ( evt, propertyName, newValue ) => {
414
- // Do not execute the command on initial call (opening the table properties view).
415
- if ( !this._isReady ) {
416
- return;
417
- }
418
-
419
- this.editor.execute( commandName, {
420
- value: newValue,
421
- batch: this._undoStepBatch
422
- } );
423
- };
424
- }
425
-
426
- /**
427
- * Creates a callback that when executed upon {@link #view view's} property change:
428
- * * executes a related editor command with the new property value if the value is valid,
429
- * * or sets the error text next to the invalid field, if the value did not pass the validation.
430
- *
431
- * @private
432
- * @param {Object} options
433
- * @param {String} options.commandName
434
- * @param {module:ui/view~View} options.viewField
435
- * @param {Function} options.validator
436
- * @param {String} options.errorText
437
- * @returns {Function}
438
- */
439
- _getValidatedPropertyChangeCallback( options ) {
440
- const { commandName, viewField, validator, errorText } = options;
441
- const setErrorTextDebounced = debounce( () => {
442
- viewField.errorText = errorText;
443
- }, ERROR_TEXT_TIMEOUT );
444
-
445
- return ( evt, propertyName, newValue ) => {
446
- setErrorTextDebounced.cancel();
447
-
448
- // Do not execute the command on initial call (opening the table properties view).
449
- if ( !this._isReady ) {
450
- return;
451
- }
452
-
453
- if ( validator( newValue ) ) {
454
- this.editor.execute( commandName, {
455
- value: newValue,
456
- batch: this._undoStepBatch
457
- } );
458
-
459
- viewField.errorText = null;
460
- } else {
461
- setErrorTextDebounced();
462
- }
463
- };
464
- }
36
+ /**
37
+ * @inheritDoc
38
+ */
39
+ static get requires() {
40
+ return [ContextualBalloon];
41
+ }
42
+ /**
43
+ * @inheritDoc
44
+ */
45
+ static get pluginName() {
46
+ return 'TablePropertiesUI';
47
+ }
48
+ /**
49
+ * @inheritDoc
50
+ */
51
+ constructor(editor) {
52
+ super(editor);
53
+ /**
54
+ * The properties form view displayed inside the balloon.
55
+ */
56
+ this.view = null;
57
+ editor.config.define('table.tableProperties', {
58
+ borderColors: defaultColors,
59
+ backgroundColors: defaultColors
60
+ });
61
+ }
62
+ /**
63
+ * @inheritDoc
64
+ */
65
+ init() {
66
+ const editor = this.editor;
67
+ const t = editor.t;
68
+ this._defaultTableProperties = getNormalizedDefaultProperties(editor.config.get('table.tableProperties.defaultProperties'), {
69
+ includeAlignmentProperty: true
70
+ });
71
+ this._balloon = editor.plugins.get(ContextualBalloon);
72
+ editor.ui.componentFactory.add('tableProperties', locale => {
73
+ const view = new ButtonView(locale);
74
+ view.set({
75
+ label: t('Table properties'),
76
+ icon: tableProperties,
77
+ tooltip: true
78
+ });
79
+ this.listenTo(view, 'execute', () => this._showView());
80
+ const commands = Object.values(propertyToCommandMap)
81
+ .map(commandName => editor.commands.get(commandName));
82
+ view.bind('isEnabled').toMany(commands, 'isEnabled', (...areEnabled) => (areEnabled.some(isCommandEnabled => isCommandEnabled)));
83
+ return view;
84
+ });
85
+ }
86
+ /**
87
+ * @inheritDoc
88
+ */
89
+ destroy() {
90
+ super.destroy();
91
+ // Destroy created UI components as they are not automatically destroyed.
92
+ // See https://github.com/ckeditor/ckeditor5/issues/1341.
93
+ if (this.view) {
94
+ this.view.destroy();
95
+ }
96
+ }
97
+ /**
98
+ * Creates the {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView} instance.
99
+ *
100
+ * @returns The table properties form view instance.
101
+ */
102
+ _createPropertiesView() {
103
+ const editor = this.editor;
104
+ const config = editor.config.get('table.tableProperties');
105
+ const borderColorsConfig = normalizeColorOptions(config.borderColors);
106
+ const localizedBorderColors = getLocalizedColorOptions(editor.locale, borderColorsConfig);
107
+ const backgroundColorsConfig = normalizeColorOptions(config.backgroundColors);
108
+ const localizedBackgroundColors = getLocalizedColorOptions(editor.locale, backgroundColorsConfig);
109
+ const view = new TablePropertiesView(editor.locale, {
110
+ borderColors: localizedBorderColors,
111
+ backgroundColors: localizedBackgroundColors,
112
+ defaultTableProperties: this._defaultTableProperties
113
+ });
114
+ const t = editor.t;
115
+ // Render the view so its #element is available for the clickOutsideHandler.
116
+ view.render();
117
+ this.listenTo(view, 'submit', () => {
118
+ this._hideView();
119
+ });
120
+ this.listenTo(view, 'cancel', () => {
121
+ // https://github.com/ckeditor/ckeditor5/issues/6180
122
+ if (this._undoStepBatch.operations.length) {
123
+ editor.execute('undo', this._undoStepBatch);
124
+ }
125
+ this._hideView();
126
+ });
127
+ // Close the balloon on Esc key press.
128
+ view.keystrokes.set('Esc', (data, cancel) => {
129
+ this._hideView();
130
+ cancel();
131
+ });
132
+ // Close on click outside of balloon panel element.
133
+ clickOutsideHandler({
134
+ emitter: view,
135
+ activator: () => this._isViewInBalloon,
136
+ contextElements: [this._balloon.view.element],
137
+ callback: () => this._hideView()
138
+ });
139
+ const colorErrorText = getLocalizedColorErrorText(t);
140
+ const lengthErrorText = getLocalizedLengthErrorText(t);
141
+ // Create the "UI -> editor data" binding.
142
+ // These listeners update the editor data (via table commands) when any observable
143
+ // property of the view has changed. They also validate the value and display errors in the UI
144
+ // when necessary. This makes the view live, which means the changes are
145
+ // visible in the editing as soon as the user types or changes fields' values.
146
+ view.on('change:borderStyle', this._getPropertyChangeCallback('tableBorderStyle'));
147
+ view.on('change:borderColor', this._getValidatedPropertyChangeCallback({
148
+ viewField: view.borderColorInput,
149
+ commandName: 'tableBorderColor',
150
+ errorText: colorErrorText,
151
+ validator: colorFieldValidator
152
+ }));
153
+ view.on('change:borderWidth', this._getValidatedPropertyChangeCallback({
154
+ viewField: view.borderWidthInput,
155
+ commandName: 'tableBorderWidth',
156
+ errorText: lengthErrorText,
157
+ validator: lineWidthFieldValidator
158
+ }));
159
+ view.on('change:backgroundColor', this._getValidatedPropertyChangeCallback({
160
+ viewField: view.backgroundInput,
161
+ commandName: 'tableBackgroundColor',
162
+ errorText: colorErrorText,
163
+ validator: colorFieldValidator
164
+ }));
165
+ view.on('change:width', this._getValidatedPropertyChangeCallback({
166
+ viewField: view.widthInput,
167
+ commandName: 'tableWidth',
168
+ errorText: lengthErrorText,
169
+ validator: lengthFieldValidator
170
+ }));
171
+ view.on('change:height', this._getValidatedPropertyChangeCallback({
172
+ viewField: view.heightInput,
173
+ commandName: 'tableHeight',
174
+ errorText: lengthErrorText,
175
+ validator: lengthFieldValidator
176
+ }));
177
+ view.on('change:alignment', this._getPropertyChangeCallback('tableAlignment'));
178
+ return view;
179
+ }
180
+ /**
181
+ * In this method the "editor data -> UI" binding is happening.
182
+ *
183
+ * When executed, this method obtains selected table property values from various table commands
184
+ * and passes them to the {@link #view}.
185
+ *
186
+ * This way, the UI stays up–to–date with the editor data.
187
+ */
188
+ _fillViewFormFromCommandValues() {
189
+ const commands = this.editor.commands;
190
+ const borderStyleCommand = commands.get('tableBorderStyle');
191
+ Object.entries(propertyToCommandMap)
192
+ .map(([property, commandName]) => {
193
+ const propertyKey = property;
194
+ const defaultValue = this._defaultTableProperties[propertyKey] || '';
195
+ return [propertyKey, (commands.get(commandName).value || defaultValue)];
196
+ })
197
+ .forEach(([property, value]) => {
198
+ // Do not set the `border-color` and `border-width` fields if `border-style:none`.
199
+ if ((property === 'borderColor' || property === 'borderWidth') && borderStyleCommand.value === 'none') {
200
+ return;
201
+ }
202
+ this.view.set(property, value);
203
+ });
204
+ this._isReady = true;
205
+ }
206
+ /**
207
+ * Shows the {@link #view} in the {@link #_balloon}.
208
+ *
209
+ * **Note**: Each time a view is shown, the new {@link #_undoStepBatch} is created that contains
210
+ * all changes made to the document when the view is visible, allowing a single undo step
211
+ * for all of them.
212
+ */
213
+ _showView() {
214
+ const editor = this.editor;
215
+ if (!this.view) {
216
+ this.view = this._createPropertiesView();
217
+ }
218
+ this.listenTo(editor.ui, 'update', () => {
219
+ this._updateView();
220
+ });
221
+ // Update the view with the model values.
222
+ this._fillViewFormFromCommandValues();
223
+ this._balloon.add({
224
+ view: this.view,
225
+ position: getBalloonTablePositionData(editor)
226
+ });
227
+ // Create a new batch. Clicking "Cancel" will undo this batch.
228
+ this._undoStepBatch = editor.model.createBatch();
229
+ // Basic a11y.
230
+ this.view.focus();
231
+ }
232
+ /**
233
+ * Removes the {@link #view} from the {@link #_balloon}.
234
+ */
235
+ _hideView() {
236
+ const editor = this.editor;
237
+ this.stopListening(editor.ui, 'update');
238
+ this._isReady = false;
239
+ // Blur any input element before removing it from DOM to prevent issues in some browsers.
240
+ // See https://github.com/ckeditor/ckeditor5/issues/1501.
241
+ this.view.saveButtonView.focus();
242
+ this._balloon.remove(this.view);
243
+ // Make sure the focus is not lost in the process by putting it directly
244
+ // into the editing view.
245
+ this.editor.editing.view.focus();
246
+ }
247
+ /**
248
+ * Repositions the {@link #_balloon} or hides the {@link #view} if a table is no longer selected.
249
+ */
250
+ _updateView() {
251
+ const editor = this.editor;
252
+ const viewDocument = editor.editing.view.document;
253
+ if (!getTableWidgetAncestor(viewDocument.selection)) {
254
+ this._hideView();
255
+ }
256
+ else if (this._isViewVisible) {
257
+ repositionContextualBalloon(editor, 'table');
258
+ }
259
+ }
260
+ /**
261
+ * Returns `true` when the {@link #view} is the visible in the {@link #_balloon}.
262
+ */
263
+ get _isViewVisible() {
264
+ return !!this.view && this._balloon.visibleView === this.view;
265
+ }
266
+ /**
267
+ * Returns `true` when the {@link #view} is in the {@link #_balloon}.
268
+ */
269
+ get _isViewInBalloon() {
270
+ return !!this.view && this._balloon.hasView(this.view);
271
+ }
272
+ /**
273
+ * Creates a callback that when executed upon {@link #view view's} property change
274
+ * executes a related editor command with the new property value.
275
+ *
276
+ * If new value will be set to the default value, the command will not be executed.
277
+ *
278
+ * @param commandName The command that will be executed.
279
+ */
280
+ _getPropertyChangeCallback(commandName) {
281
+ return (evt, propertyName, newValue) => {
282
+ // Do not execute the command on initial call (opening the table properties view).
283
+ if (!this._isReady) {
284
+ return;
285
+ }
286
+ this.editor.execute(commandName, {
287
+ value: newValue,
288
+ batch: this._undoStepBatch
289
+ });
290
+ };
291
+ }
292
+ /**
293
+ * Creates a callback that when executed upon {@link #view view's} property change:
294
+ * * executes a related editor command with the new property value if the value is valid,
295
+ * * or sets the error text next to the invalid field, if the value did not pass the validation.
296
+ */
297
+ _getValidatedPropertyChangeCallback(options) {
298
+ const { commandName, viewField, validator, errorText } = options;
299
+ const setErrorTextDebounced = debounce(() => {
300
+ viewField.errorText = errorText;
301
+ }, ERROR_TEXT_TIMEOUT);
302
+ return (evt, propertyName, newValue) => {
303
+ setErrorTextDebounced.cancel();
304
+ // Do not execute the command on initial call (opening the table properties view).
305
+ if (!this._isReady) {
306
+ return;
307
+ }
308
+ if (validator(newValue)) {
309
+ this.editor.execute(commandName, {
310
+ value: newValue,
311
+ batch: this._undoStepBatch
312
+ });
313
+ viewField.errorText = null;
314
+ }
315
+ else {
316
+ setErrorTextDebounced();
317
+ }
318
+ };
319
+ }
465
320
  }