-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
imagestyleui.js
122 lines (103 loc) · 3.12 KB
/
imagestyleui.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
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module image/imagestyle/imagestyleui
*/
import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
import { normalizeImageStyles } from './utils';
import '../../theme/imagestyle.css';
/**
* The image style UI plugin.
*
* @extends module:core/plugin~Plugin
*/
export default class ImageStyleUI extends Plugin {
/**
* @inheritDoc
*/
static get pluginName() {
return 'ImageStyleUI';
}
/**
* Returns the default localized style titles provided by the plugin.
*
* The following localized titles corresponding with
* {@link module:image/imagestyle/utils~defaultStyles} are available:
*
* * `'Full size image'`,
* * `'Side image'`,
* * `'Left aligned image'`,
* * `'Centered image'`,
* * `'Right aligned image'`
*
* @returns {Object.<String,String>}
*/
get localizedDefaultStylesTitles() {
const t = this.editor.t;
return {
'Full size image': t( 'Full size image' ),
'Side image': t( 'Side image' ),
'Left aligned image': t( 'Left aligned image' ),
'Centered image': t( 'Centered image' ),
'Right aligned image': t( 'Right aligned image' )
};
}
/**
* @inheritDoc
*/
init() {
const editor = this.editor;
const configuredStyles = editor.config.get( 'image.styles' );
const translatedStyles = translateStyles( normalizeImageStyles( configuredStyles ), this.localizedDefaultStylesTitles );
for ( const style of translatedStyles ) {
this._createButton( style );
}
}
/**
* Creates a button for each style and stores it in the editor {@link module:ui/componentfactory~ComponentFactory ComponentFactory}.
*
* @private
* @param {module:image/imagestyle/imagestyleediting~ImageStyleFormat} style
*/
_createButton( style ) {
const editor = this.editor;
const componentName = `imageStyle:${ style.name }`;
editor.ui.componentFactory.add( componentName, locale => {
const command = editor.commands.get( 'imageStyle' );
const view = new ButtonView( locale );
view.set( {
label: style.title,
icon: style.icon,
tooltip: true,
isToggleable: true
} );
view.bind( 'isEnabled' ).to( command, 'isEnabled' );
view.bind( 'isOn' ).to( command, 'value', value => value === style.name );
this.listenTo( view, 'execute', () => {
editor.execute( 'imageStyle', { value: style.name } );
editor.editing.view.focus();
} );
return view;
} );
}
}
/**
* Returns the translated `title` from the passed styles array.
*
* @param {Array.<module:image/imagestyle/imagestyleediting~ImageStyleFormat>} styles
* @param titles
* @returns {Array.<module:image/imagestyle/imagestyleediting~ImageStyleFormat>}
*/
function translateStyles( styles, titles ) {
for ( const style of styles ) {
// Localize the titles of the styles, if a title corresponds with
// a localized default provided by the plugin.
if ( titles[ style.title ] ) {
style.title = titles[ style.title ];
}
}
return styles;
}