/
imageresizebuttons.js
277 lines (240 loc) · 9.01 KB
/
imageresizebuttons.js
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
/**
* @license Copyright (c) 2003-2023, 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/imageresizebuttons
*/
import { Plugin, icons } from 'ckeditor5/src/core';
import { ButtonView, DropdownButtonView, Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
import { CKEditorError, Collection } from 'ckeditor5/src/utils';
import ImageResizeEditing from './imageresizeediting';
const RESIZE_ICONS = {
small: icons.objectSizeSmall,
medium: icons.objectSizeMedium,
large: icons.objectSizeLarge,
original: icons.objectSizeFull
};
/**
* The image resize buttons plugin.
*
* It adds a possibility to resize images using the toolbar dropdown or individual buttons, depending on the plugin configuration.
*
* @extends module:core/plugin~Plugin
*/
export default class ImageResizeButtons extends Plugin {
/**
* @inheritDoc
*/
static get requires() {
return [ ImageResizeEditing ];
}
/**
* @inheritDoc
*/
static get pluginName() {
return 'ImageResizeButtons';
}
/**
* @inheritDoc
*/
constructor( editor ) {
super( editor );
/**
* The resize unit.
*
* @readonly
* @private
* @type {module:image/image~ImageConfig#resizeUnit}
* @default '%'
*/
this._resizeUnit = editor.config.get( 'image.resizeUnit' );
}
/**
* @inheritDoc
*/
init() {
const editor = this.editor;
const options = editor.config.get( 'image.resizeOptions' );
const command = editor.commands.get( 'resizeImage' );
this.bind( 'isEnabled' ).to( command );
for ( const option of options ) {
this._registerImageResizeButton( option );
}
this._registerImageResizeDropdown( options );
}
/**
* A helper function that creates a standalone button component for the plugin.
*
* @private
* @param {module:image/imageresize/imageresizebuttons~ImageResizeOption} resizeOption A model of the resize option.
*/
_registerImageResizeButton( option ) {
const editor = this.editor;
const { name, value, icon } = option;
const optionValueWithUnit = value ? value + this._resizeUnit : null;
editor.ui.componentFactory.add( name, locale => {
const button = new ButtonView( locale );
const command = editor.commands.get( 'resizeImage' );
const labelText = this._getOptionLabelValue( option, true );
if ( !RESIZE_ICONS[ icon ] ) {
/**
* When configuring {@link module:image/image~ImageConfig#resizeOptions `config.image.resizeOptions`} for standalone
* buttons, a valid `icon` token must be set for each option.
*
* See all valid options described in the
* {@link module:image/imageresize/imageresizebuttons~ImageResizeOption plugin configuration}.
*
* @error imageresizebuttons-missing-icon
* @param {module:image/imageresize/imageresizebuttons~ImageResizeOption} option Invalid image resize option.
*/
throw new CKEditorError(
'imageresizebuttons-missing-icon',
editor,
option
);
}
button.set( {
// Use the `label` property for a verbose description (because of ARIA).
label: labelText,
icon: RESIZE_ICONS[ icon ],
tooltip: labelText,
isToggleable: true
} );
// Bind button to the command.
button.bind( 'isEnabled' ).to( this );
button.bind( 'isOn' ).to( command, 'value', getIsOnButtonCallback( optionValueWithUnit ) );
this.listenTo( button, 'execute', () => {
editor.execute( 'resizeImage', { width: optionValueWithUnit } );
} );
return button;
} );
}
/**
* A helper function that creates a dropdown component for the plugin containing all the resize options defined in
* the editor configuration.
*
* @private
* @param {Array.<module:image/imageresize/imageresizebuttons~ImageResizeOption>} options An array of configured options.
*/
_registerImageResizeDropdown( options ) {
const editor = this.editor;
const t = editor.t;
const originalSizeOption = options.find( option => !option.value );
const componentCreator = locale => {
const command = editor.commands.get( 'resizeImage' );
const dropdownView = createDropdown( locale, DropdownButtonView );
const dropdownButton = dropdownView.buttonView;
dropdownButton.set( {
tooltip: t( 'Resize image' ),
commandValue: originalSizeOption.value,
icon: RESIZE_ICONS.medium,
isToggleable: true,
label: this._getOptionLabelValue( originalSizeOption ),
withText: true,
class: 'ck-resize-image-button'
} );
dropdownButton.bind( 'label' ).to( command, 'value', commandValue => {
if ( commandValue && commandValue.width ) {
return commandValue.width;
} else {
return this._getOptionLabelValue( originalSizeOption );
}
} );
dropdownView.bind( 'isOn' ).to( command );
dropdownView.bind( 'isEnabled' ).to( this );
addListToDropdown( dropdownView, () => this._getResizeDropdownListItemDefinitions( options, command ), {
ariaLabel: t( 'Image resize list' )
} );
// Execute command when an item from the dropdown is selected.
this.listenTo( dropdownView, 'execute', evt => {
editor.execute( evt.source.commandName, { width: evt.source.commandValue } );
editor.editing.view.focus();
} );
return dropdownView;
};
// Register `resizeImage` dropdown and add `imageResize` dropdown as an alias for backward compatibility.
editor.ui.componentFactory.add( 'resizeImage', componentCreator );
editor.ui.componentFactory.add( 'imageResize', componentCreator );
}
/**
* A helper function for creating an option label value string.
*
* @private
* @param {module:image/imageresize/imageresizebuttons~ImageResizeOption} option A resize option object.
* @param {Boolean} [forTooltip] An optional flag for creating a tooltip label.
* @returns {String} A user-defined label combined from the numeric value and the resize unit or the default label
* for reset options (`Original`).
*/
_getOptionLabelValue( option, forTooltip ) {
const t = this.editor.t;
if ( option.label ) {
return option.label;
} else if ( forTooltip ) {
if ( option.value ) {
return t( 'Resize image to %0', option.value + this._resizeUnit );
} else {
return t( 'Resize image to the original size' );
}
} else {
if ( option.value ) {
return option.value + this._resizeUnit;
} else {
return t( 'Original' );
}
}
}
/**
* A helper function that parses the resize options and returns list item definitions ready for use in the dropdown.
*
* @private
* @param {Array.<module:image/imageresize/imageresizebuttons~ImageResizeOption>} options The resize options.
* @param {module:image/imageresize/resizeimagecommand~ResizeImageCommand} command The resize image command.
* @returns {Iterable.<module:ui/dropdown/utils~ListDropdownItemDefinition>} Dropdown item definitions.
*/
_getResizeDropdownListItemDefinitions( options, command ) {
const itemDefinitions = new Collection();
options.map( option => {
const optionValueWithUnit = option.value ? option.value + this._resizeUnit : null;
const definition = {
type: 'button',
model: new Model( {
commandName: 'resizeImage',
commandValue: optionValueWithUnit,
label: this._getOptionLabelValue( option ),
withText: true,
icon: null
} )
};
definition.model.bind( 'isOn' ).to( command, 'value', getIsOnButtonCallback( optionValueWithUnit ) );
itemDefinitions.add( definition );
} );
return itemDefinitions;
}
}
// A helper function for setting the `isOn` state of buttons in value bindings.
function getIsOnButtonCallback( value ) {
return commandValue => {
if ( value === null && commandValue === value ) {
return true;
}
return commandValue && commandValue.width === value;
};
}
/**
* The image resize option used in the {@link module:image/image~ImageConfig#resizeOptions image resize configuration}.
*
* @typedef {Object} module:image/imageresize/imageresizebuttons~ImageResizeOption
* @property {String} name The name of the UI component that changes the image size.
* * If you configure the feature using individual resize buttons, you can refer to this name in the
* {@link module:image/image~ImageConfig#toolbar image toolbar configuration}.
* * If you configure the feature using the resize dropdown, this name will be used for a list item in the dropdown.
* @property {String} value The value of the resize option without the unit
* ({@link module:image/image~ImageConfig#resizeUnit configured separately}). `null` resets an image to its original size.
* @property {String} [icon] An icon used by an individual resize button (see the `name` property to learn more).
* Available icons are: `'small'`, `'medium'`, `'large'`, `'original'`.
* @property {String} [label] An option label displayed in the dropdown or, if the feature is configured using
* individual buttons, a {@link module:ui/button/buttonview~ButtonView#tooltip} and an ARIA attribute of a button.
* If not specified, the label is generated automatically based on the `value` option and the
* {@link module:image/image~ImageConfig#resizeUnit `config.image.resizeUnit`}.
*/