-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
imagecustomresizeformview.ts
317 lines (257 loc) · 7.24 KB
/
imagecustomresizeformview.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
/**
* @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 image/imageresize/ui/imagecustomresizeformview
*/
import {
ButtonView,
FocusCycler,
LabeledFieldView,
View,
ViewCollection,
createLabeledInputNumber,
submitHandler,
type FocusableView,
type InputNumberView
} from 'ckeditor5/src/ui.js';
import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
import { icons } from 'ckeditor5/src/core.js';
import '../../../theme/imagecustomresizeform.css';
// See: #8833.
// eslint-disable-next-line ckeditor5-rules/ckeditor-imports
import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
/**
* The ImageCustomResizeFormView class.
*/
export default class ImageCustomResizeFormView extends View {
/**
* Tracks information about the DOM focus in the form.
*/
public readonly focusTracker: FocusTracker;
/**
* An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
*/
public readonly keystrokes: KeystrokeHandler;
/**
* Resize unit shortcut.
*/
public readonly unit: string;
/**
* An input with a label.
*/
public labeledInput: LabeledFieldView<InputNumberView>;
/**
* A button used to submit the form.
*/
public saveButtonView: ButtonView;
/**
* A button used to cancel the form.
*/
public cancelButtonView: ButtonView;
/**
* A collection of views which can be focused in the form.
*/
protected readonly _focusables: ViewCollection<FocusableView>;
/**
* Helps cycling over {@link #_focusables} in the form.
*/
protected readonly _focusCycler: FocusCycler;
/**
* An array of form validators used by {@link #isValid}.
*/
private readonly _validators: Array<ImageCustomResizeFormValidatorCallback>;
/**
* @inheritDoc
*/
constructor( locale: Locale, unit: string, validators: Array<ImageCustomResizeFormValidatorCallback> ) {
super( locale );
const t = this.locale!.t;
this.focusTracker = new FocusTracker();
this.keystrokes = new KeystrokeHandler();
this.unit = unit;
this.labeledInput = this._createLabeledInputView();
this.saveButtonView = this._createButton( t( 'Save' ), icons.check, 'ck-button-save' );
this.saveButtonView.type = 'submit';
this.cancelButtonView = this._createButton( t( 'Cancel' ), icons.cancel, 'ck-button-cancel', 'cancel' );
this._focusables = new ViewCollection();
this._validators = validators;
this._focusCycler = new FocusCycler( {
focusables: this._focusables,
focusTracker: this.focusTracker,
keystrokeHandler: this.keystrokes,
actions: {
// Navigate form fields backwards using the Shift + Tab keystroke.
focusPrevious: 'shift + tab',
// Navigate form fields forwards using the Tab key.
focusNext: 'tab'
}
} );
this.setTemplate( {
tag: 'form',
attributes: {
class: [
'ck',
'ck-image-custom-resize-form',
'ck-responsive-form'
],
// https://github.com/ckeditor/ckeditor5-image/issues/40
tabindex: '-1'
},
children: [
this.labeledInput,
this.saveButtonView,
this.cancelButtonView
]
} );
}
/**
* @inheritDoc
*/
public override render(): void {
super.render();
this.keystrokes.listenTo( this.element! );
submitHandler( { view: this } );
[ this.labeledInput, this.saveButtonView, this.cancelButtonView ]
.forEach( v => {
// Register the view as focusable.
this._focusables.add( v );
// Register the view in the focus tracker.
this.focusTracker.add( v.element! );
} );
}
/**
* @inheritDoc
*/
public override destroy(): void {
super.destroy();
this.focusTracker.destroy();
this.keystrokes.destroy();
}
/**
* Creates the button view.
*
* @param label The button label
* @param icon The button's icon.
* @param className The additional button CSS class name.
* @param eventName The event name that the ButtonView#execute event will be delegated to.
* @returns The button view instance.
*/
private _createButton( label: string, icon: string, className: string, eventName?: string ): ButtonView {
const button = new ButtonView( this.locale );
button.set( {
label,
icon,
tooltip: true
} );
button.extendTemplate( {
attributes: {
class: className
}
} );
if ( eventName ) {
button.delegate( 'execute' ).to( this, eventName );
}
return button;
}
/**
* Creates an input with a label.
*
* @returns Labeled field view instance.
*/
private _createLabeledInputView(): LabeledFieldView<InputNumberView> {
const t = this.locale!.t;
const labeledInput = new LabeledFieldView<InputNumberView>( this.locale, createLabeledInputNumber );
labeledInput.label = t( 'Resize image (in %0)', this.unit );
labeledInput.fieldView.set( {
step: 0.1
} );
return labeledInput;
}
/**
* Validates the form and returns `false` when some fields are invalid.
*/
public isValid(): boolean {
this.resetFormStatus();
for ( const validator of this._validators ) {
const errorText = validator( this );
// One error per field is enough.
if ( errorText ) {
// Apply updated error.
this.labeledInput.errorText = errorText;
return false;
}
}
return true;
}
/**
* Cleans up the supplementary error and information text of the {@link #labeledInput}
* bringing them back to the state when the form has been displayed for the first time.
*
* See {@link #isValid}.
*/
public resetFormStatus(): void {
this.labeledInput.errorText = null;
}
/**
* The native DOM `value` of the input element of {@link #labeledInput}.
*/
public get rawSize(): string | null {
const { element } = this.labeledInput.fieldView;
if ( !element ) {
return null;
}
return element.value;
}
/**
* Get numeric value of size. Returns `null` if value of size input element in {@link #labeledInput}.is not a number.
*/
public get parsedSize(): number | null {
const { rawSize } = this;
if ( rawSize === null ) {
return null;
}
const parsed = Number.parseFloat( rawSize );
if ( Number.isNaN( parsed ) ) {
return null;
}
return parsed;
}
/**
* Returns serialized image input size with unit.
* Returns `null` if value of size input element in {@link #labeledInput}.is not a number.
*/
public get sizeWithUnits(): string | null {
const { parsedSize, unit } = this;
if ( parsedSize === null ) {
return null;
}
return `${ parsedSize }${ unit }`;
}
}
/**
* Callback used by {@link ~ImageCustomResizeFormView} to check if passed form value is valid.
*
* * If `undefined` is returned, it is assumed that the form value is correct and there is no error.
* * If string is returned, it is assumed that the form value is incorrect and the returned string is displayed in the error label
*/
export type ImageCustomResizeFormValidatorCallback = ( form: ImageCustomResizeFormView ) => string | undefined;
/**
* Fired when the form view is submitted.
*
* @eventName ~ImageCustomResizeFormView#submit
*/
export type ImageCustomResizeFormViewSubmitEvent = {
name: 'submit';
args: [];
};
/**
* Fired when the form view is canceled.
*
* @eventName ~ImageCustomResizeFormView#cancel
*/
export type ImageCustomResizeFormViewCancelEvent = {
name: 'cancel';
args: [];
};