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