| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 |
- /**
- * @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/imageresize/imageresizeui
- */
- import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
- import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
- import ImageResizeEditing from './imageresizeediting';
- import { createDropdown, addListToDropdown } from '@ckeditor/ckeditor5-ui/src/dropdown/utils';
- import DropdownButtonView from '@ckeditor/ckeditor5-ui/src/dropdown/button/dropdownbuttonview';
- import Model from '@ckeditor/ckeditor5-ui/src/model';
- import Collection from '@ckeditor/ckeditor5-utils/src/collection';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import iconSmall from '@ckeditor/ckeditor5-core/theme/icons/object-size-small.svg';
- import iconMedium from '@ckeditor/ckeditor5-core/theme/icons/object-size-medium.svg';
- import iconLarge from '@ckeditor/ckeditor5-core/theme/icons/object-size-large.svg';
- import iconFull from '@ckeditor/ckeditor5-core/theme/icons/object-size-full.svg';
- const RESIZE_ICONS = {
- small: iconSmall,
- medium: iconMedium,
- large: iconLarge,
- original: iconFull
- };
- /**
- * The `ImageResizeUI` 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 ImageResizeUI extends Plugin {
- /**
- * @inheritDoc
- */
- static get requires() {
- return [ ImageResizeEditing ];
- }
- /**
- * @inheritDoc
- */
- static get pluginName() {
- return 'ImageResizeUI';
- }
- /**
- * @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( 'imageResize' );
- if ( !options ) {
- return;
- }
- 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/imageresizeui~ImageResizeOption} resizeOption A model of 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( 'imageResize' );
- 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/imageresizeui~ImageResizeOption plugin configuration}.
- *
- * @error imageresizeui-missing-icon
- * @param {module:image/imageresize/imageresizeui~ImageResizeOption} option Invalid image resize option.
- */
- throw new CKEditorError(
- 'imageresizeui-missing-icon: ' +
- 'The resize option "' + name + '" misses the "icon" property ' +
- 'or the property value doesn\'t match any of available icons.',
- 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( 'imageResize', { width: optionValueWithUnit } );
- } );
- return button;
- } );
- }
- /**
- * A helper function that creates a dropdown component for the plugin containing all resize options defined in
- * the editor configuration.
- *
- * @private
- * @param {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} options An array of configured options.
- */
- _registerImageResizeDropdown( options ) {
- const editor = this.editor;
- const t = editor.t;
- const originalSizeOption = options.find( option => !option.value );
- // Register dropdown.
- editor.ui.componentFactory.add( 'imageResize', locale => {
- const command = editor.commands.get( 'imageResize' );
- const dropdownView = createDropdown( locale, DropdownButtonView );
- const dropdownButton = dropdownView.buttonView;
- dropdownButton.set( {
- tooltip: t( 'Resize image' ),
- commandValue: originalSizeOption.value,
- icon: iconMedium,
- 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 ) );
- dropdownView.listView.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;
- } );
- }
- /**
- * A helper function for creating an option label value string.
- *
- * @private
- * @param {module:image/imageresize/imageresizeui~ImageResizeOption} option A resize option object.
- * @param {Boolean} [forTooltip] An optional flag for creating a tooltip label.
- * @returns {String} A user-defined label, a label combined from the value and 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 resize options and returns list item definitions ready for use in a dropdown.
- *
- * @private
- * @param {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} options The resize options.
- * @param {module:image/imageresize/imageresizecommand~ImageResizeCommand} command A 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: 'imageResize',
- 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;
- };
- }
- /**
- * An image resize option used in the {@link module:image/image~ImageConfig#resizeOptions image resize configuration}.
- *
- * @typedef {Object} module:image/imageresize/imageresizeui~ImageResizeOption
- * @property {String} name A 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 A value of a resize option without the unit
- * ({@link module:image/image~ImageConfig#resizeUnit configured separately}). `null` resets an image to its original size.
- * @property {String} [resizeOptions.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] A label of the option 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 option `value` and the
- * {@link module:image/image~ImageConfig#resizeUnit `config.image.resizeUnit`}.
- */
|