Ver código fonte

Change plugin name from `ImageResizeUI` to `ImageResizeButtons`.

panr 5 anos atrás
pai
commit
a87b9318b9

packages/ckeditor5-image/docs/_snippets/features/image-resizeuidropdown.html → packages/ckeditor5-image/docs/_snippets/features/image-resize-buttons-dropdown.html


packages/ckeditor5-image/docs/_snippets/features/image-resizeuidropdown.js → packages/ckeditor5-image/docs/_snippets/features/image-resize-buttons-dropdown.js


packages/ckeditor5-image/docs/_snippets/features/image-resizeui.html → packages/ckeditor5-image/docs/_snippets/features/image-resize-buttons.html


packages/ckeditor5-image/docs/_snippets/features/image-resizeui.js → packages/ckeditor5-image/docs/_snippets/features/image-resize-buttons.js


+ 7 - 7
packages/ckeditor5-image/docs/features/image.md

@@ -236,7 +236,7 @@ In this case, the user is able to resize images via dragging square handles disp
 
 You can configure the editor for resizing images by handles in two different ways:
 
-- By installing the {@link module:image/imageresize~ImageResize} plugin, which contains **all** needed features (`ImageResizeEditing`, `ImageResizeHandles`, `ImageResizeUI`).
+- By installing the {@link module:image/imageresize~ImageResize} plugin, which contains **all** needed features (`ImageResizeEditing`, `ImageResizeHandles`, `ImageResizeButtons`).
 
 ```js
 import Image from '@ckeditor/ckeditor5-image/src/image';
@@ -298,7 +298,7 @@ const imageConfiguration = {
 }
 ```
 
-{@snippet features/image-resizeuidropdown}
+{@snippet features/image-resize-buttons-dropdown}
 
 #### Using standalone buttons
 
@@ -334,7 +334,7 @@ const imageConfiguration = {
 }
 ```
 
-{@snippet features/image-resizeui}
+{@snippet features/image-resize-buttons}
 
 ### Disabling image resize handles
 
@@ -381,17 +381,17 @@ ClassicEditor
 	.catch( ... );
 ```
 
-- Or you can simply do not install {@link module:image/imageresize/imageresizehandles~ImageResizeHandles `ImageResizeHandles`} plugin at all. This means that your plugins setup will look like this: `plugins: [ 'ImageResizeEditing', 'ImageResizeUI', ... ]` which only enables resizing image feature by the choosen UI ([dropdown](#resize-image-using-the-plugin-dropdown) or [standalone buttons](#resize-image-using-the-standalone-buttons)) in the image toolbar.
+- Or you can simply do not install {@link module:image/imageresize/imageresizehandles~ImageResizeHandles `ImageResizeHandles`} plugin at all. This means that your plugins setup will look like this: `plugins: [ 'ImageResizeEditing', 'ImageResizeButtons', ... ]` which only enables resizing image feature by the choosen UI ([dropdown](#resize-image-using-the-plugin-dropdown) or [standalone buttons](#resize-image-using-the-standalone-buttons)) in the image toolbar.
 
 ```js
 import Image from '@ckeditor/ckeditor5-image/src/image';
 import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
 import ImageResizeEditing from '@ckeditor/ckeditor5-image/src/imageresize/imageresizeedititing';
-import ImageResizeUI from '@ckeditor/ckeditor5-image/src/imageresize/imageresizeui';
+import ImageResizeButtons from '@ckeditor/ckeditor5-image/src/imageresize/imageresizebuttons';
 
 ClassicEditor
 	.create( document.querySelector( '#editor' ), {
-		plugins: [ Image, ImageResizeEditing, ImageResizeUI, ImageToolbar, ... ],
+		plugins: [ Image, ImageResizeEditing, ImageResizeButtons, ImageToolbar, ... ],
 		image: {
 			resizeOptions: [
 			{
@@ -494,7 +494,7 @@ ClassicEditor
 
 ## Linking images
 
-The {@link module:link/linkimage, ... adds support for linking images. Some use cases where this is needed are:
+The {@link module:link/linkimage~LinkImage} plugin adds support for linking images. Some use cases where this is needed are:
 
 * Linking to a high-resolution version of an image.
 * Using images as thumbnails linking to an article or product page.

+ 5 - 5
packages/ckeditor5-image/src/imageresize.js

@@ -8,7 +8,7 @@
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
-import ImageResizeUI from './imageresize/imageresizeui';
+import ImageResizeButtons from './imageresize/imageresizebuttons';
 import ImageResizeEditing from './imageresize/imageresizeediting';
 import ImageResizeHandles from './imageresize/imageresizehandles';
 
@@ -26,7 +26,7 @@ export default class ImageResize extends Plugin {
 	 * @inheritDoc
 	 */
 	static get requires() {
-		return [ ImageResizeEditing, ImageResizeHandles, ImageResizeUI ];
+		return [ ImageResizeEditing, ImageResizeHandles, ImageResizeButtons ];
 	}
 
 	/**
@@ -163,10 +163,10 @@ export default class ImageResize extends Plugin {
  *
  * **Resizing images using individual buttons**
  *
- * If you want to have separate buttons for {@link module:image/imageresize/imageresizeui~ImageResizeOption each option},
+ * If you want to have separate buttons for {@link module:image/imageresize/imageresizebuttons~ImageResizeOption each option},
  * pass their names to the {@link module:image/image~ImageConfig#toolbar `config.image.toolbar`} instead. Please keep in mind
  * that this time **you must define the additional
- * {@link module:image/imageresize/imageresizeui~ImageResizeOption `icon` property}**:
+ * {@link module:image/imageresize/imageresizebuttons~ImageResizeOption `icon` property}**:
  *
  *		ClassicEditor
  *			.create( editorElement, {
@@ -232,5 +232,5 @@ export default class ImageResize extends Plugin {
  *			.then( ... )
  *			.catch( ... );
  *
- * @member {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} module:image/image~ImageConfig#resizeOptions
+ * @member {Array.<module:image/imageresize/imageresizebuttons~ImageResizeOption>} module:image/image~ImageConfig#resizeOptions
  */

+ 13 - 13
packages/ckeditor5-image/src/imageresize/imageresizeui.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @module image/imageresize/imageresizeui
+ * @module image/imageresize/imageresizebuttons
  */
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
@@ -31,13 +31,13 @@ const RESIZE_ICONS = {
 };
 
 /**
- * The `ImageResizeUI` plugin.
+ * The `ImageResizeButtons` 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 {
+export default class ImageResizeButtons extends Plugin {
 	/**
 	 * @inheritDoc
 	 */
@@ -49,7 +49,7 @@ export default class ImageResizeUI extends Plugin {
 	 * @inheritDoc
 	 */
 	static get pluginName() {
-		return 'ImageResizeUI';
+		return 'ImageResizeButtons';
 	}
 
 	/**
@@ -94,7 +94,7 @@ export default class ImageResizeUI extends Plugin {
 	 * 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.
+	 * @param {module:image/imageresize/imageresizebuttons~ImageResizeOption} resizeOption A model of resize option.
 	 */
 	_registerImageResizeButton( option ) {
 		const editor = this.editor;
@@ -112,13 +112,13 @@ export default class ImageResizeUI extends Plugin {
 				 * 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}.
+				 * {@link module:image/imageresize/imageresizebuttons~ImageResizeOption plugin configuration}.
 				 *
-				 * @error imageresizeui-missing-icon
-				 * @param {module:image/imageresize/imageresizeui~ImageResizeOption} option Invalid image resize option.
+				 * @error imageresizebuttons-missing-icon
+				 * @param {module:image/imageresize/imageresizebuttons~ImageResizeOption} option Invalid image resize option.
 				*/
 				throw new CKEditorError(
-					'imageresizeui-missing-icon: ' +
+					'imageresizebuttons-missing-icon: ' +
 					'The resize option "' + name + '" misses the "icon" property ' +
 					'or the property value doesn\'t match any of available icons.',
 					editor,
@@ -151,7 +151,7 @@ export default class ImageResizeUI extends Plugin {
 	 * the editor configuration.
 	 *
 	 * @private
-	 * @param {Array.<module:image/imageresize/imageresizeui~ImageResizeOption>} options An array of configured options.
+	 * @param {Array.<module:image/imageresize/imageresizebuttons~ImageResizeOption>} options An array of configured options.
 	 */
 	_registerImageResizeDropdown( options ) {
 		const editor = this.editor;
@@ -202,7 +202,7 @@ export default class ImageResizeUI extends Plugin {
 	 * A helper function for creating an option label value string.
 	 *
 	 * @private
-	 * @param {module:image/imageresize/imageresizeui~ImageResizeOption} option A resize option object.
+	 * @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, a label combined from the value and resize unit or the default label
 	 * for reset options (`Original`).
@@ -231,7 +231,7 @@ export default class ImageResizeUI extends Plugin {
 	 * 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 {Array.<module:image/imageresize/imageresizebuttons~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.
 	 */
@@ -274,7 +274,7 @@ function getIsOnButtonCallback( value ) {
 /**
  * An image resize option used in the {@link module:image/image~ImageConfig#resizeOptions image resize configuration}.
  *
- * @typedef {Object} module:image/imageresize/imageresizeui~ImageResizeOption
+ * @typedef {Object} module:image/imageresize/imageresizebuttons~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}.

+ 1 - 1
packages/ckeditor5-image/src/imageresize/imageresizeediting.js

@@ -14,7 +14,7 @@ import ImageResizeCommand from './imageresizecommand';
  * The image resize editing feature.
  *
  * It adds a possibility to resize each image using handles or manually by
- * {@link module:image/imageresize/imageresizeui~ImageResizeUI} buttons.
+ * {@link module:image/imageresize/imageresizebuttons~ImageResizeButtons} buttons.
  *
  * @extends module:core/plugin~Plugin
  */

+ 1 - 1
packages/ckeditor5-image/src/imageresize/imageresizehandles.js

@@ -14,7 +14,7 @@ import WidgetResize from '@ckeditor/ckeditor5-widget/src/widgetresize';
  * The image resize by handles feature.
  *
  * It adds a possibility to resize each image using handles or manually by
- * {@link module:image/imageresize/imageresizeui~ImageResizeUI} buttons.
+ * {@link module:image/imageresize/imageresizebuttons~ImageResizeButtons} buttons.
  *
  * @extends module:core/plugin~Plugin
  */

+ 3 - 3
packages/ckeditor5-image/tests/imageresize/imageresize.js

@@ -9,13 +9,13 @@ import ClassicTestEditor from '@ckeditor/ckeditor5-core/tests/_utils/classictest
 import Image from '../../src/image';
 import ImageStyle from '../../src/imagestyle';
 import ImageResize from '../../src/imageresize';
-import ImageResizeUI from '../../src/imageresize/imageresizeui';
+import ImageResizeButtons from '../../src/imageresize/imageresizebuttons';
 import ImageResizeEditing from '../../src/imageresize/imageresizeediting';
 import ImageResizeHandles from '../../src/imageresize/imageresizehandles';
 
 describe( 'ImageResize', () => {
-	it( 'should require "ImageResizeEditing" and "ImageResizeUI"', () => {
-		expect( ImageResize.requires ).to.deep.equal( [ ImageResizeEditing, ImageResizeHandles, ImageResizeUI ] );
+	it( 'should require "ImageResizeEditing" and "ImageResizeButtons"', () => {
+		expect( ImageResize.requires ).to.deep.equal( [ ImageResizeEditing, ImageResizeHandles, ImageResizeButtons ] );
 	} );
 
 	it( 'should be named', () => {

+ 10 - 10
packages/ckeditor5-image/tests/imageresize/imageresizeui.js

@@ -11,7 +11,7 @@ import Image from '../../src/image';
 import DropdownView from '@ckeditor/ckeditor5-ui/src/dropdown/dropdownview';
 import ButtonView from '@ckeditor/ckeditor5-ui/src/button/buttonview';
 import View from '@ckeditor/ckeditor5-ui/src/view';
-import ImageResizeUI from '../../src/imageresize/imageresizeui';
+import ImageResizeButtons from '../../src/imageresize/imageresizebuttons';
 import ImageStyle from '../../src/imagestyle';
 import Undo from '@ckeditor/ckeditor5-undo/src/undo';
 import Table from '@ckeditor/ckeditor5-table/src/table';
@@ -24,7 +24,7 @@ import iconMedium from '@ckeditor/ckeditor5-core/theme/icons/object-size-medium.
 import iconLarge from '@ckeditor/ckeditor5-core/theme/icons/object-size-large.svg';
 import iconFull from '@ckeditor/ckeditor5-core/theme/icons/object-size-full.svg';
 
-describe( 'ImageResizeUI', () => {
+describe( 'ImageResizeButtons', () => {
 	let plugin, command, editor, editorElement;
 
 	const resizeOptions = [ {
@@ -52,14 +52,14 @@ describe( 'ImageResizeUI', () => {
 
 		editor = await ClassicTestEditor
 			.create( editorElement, {
-				plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeUI ],
+				plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeButtons ],
 				image: {
 					resizeOptions
 				}
 			} );
 
 		command = editor.commands.get( 'imageResize' );
-		plugin = editor.plugins.get( 'ImageResizeUI' );
+		plugin = editor.plugins.get( 'ImageResizeButtons' );
 	} );
 
 	afterEach( async () => {
@@ -74,7 +74,7 @@ describe( 'ImageResizeUI', () => {
 
 	describe( 'plugin', () => {
 		it( 'should be named', () => {
-			expect( ImageResizeUI.pluginName ).to.equal( 'ImageResizeUI' );
+			expect( ImageResizeButtons.pluginName ).to.equal( 'ImageResizeButtons' );
 		} );
 	} );
 
@@ -100,7 +100,7 @@ describe( 'ImageResizeUI', () => {
 		it( 'should not register a dropdown or buttons if no resize options passed', async () => {
 			const editor = await ClassicTestEditor
 				.create( editorElement, {
-					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeUI ],
+					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeButtons ],
 					image: {
 						resizeUnit: 'px'
 					}
@@ -167,7 +167,7 @@ describe( 'ImageResizeUI', () => {
 		beforeEach( async () => {
 			editor = await ClassicTestEditor
 				.create( editorElement, {
-					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeUI ],
+					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeButtons ],
 					image: {
 						resizeUnit: '%',
 						resizeOptions: [ {
@@ -194,7 +194,7 @@ describe( 'ImageResizeUI', () => {
 					}
 				} );
 
-			plugin = editor.plugins.get( 'ImageResizeUI' );
+			plugin = editor.plugins.get( 'ImageResizeButtons' );
 		} );
 
 		afterEach( async () => {
@@ -226,7 +226,7 @@ describe( 'ImageResizeUI', () => {
 		it( 'should be created with invisible "Resize image: 30%" label when is provided', async () => {
 			const editor = await ClassicTestEditor
 				.create( editorElement, {
-					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeUI ],
+					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeButtons ],
 					image: {
 						resizeUnit: '%',
 						resizeOptions: [ {
@@ -299,7 +299,7 @@ describe( 'ImageResizeUI', () => {
 		it( 'should throw the CKEditorError if no `icon` is provided', async () => {
 			const editor = await ClassicTestEditor
 				.create( editorElement, {
-					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeUI ],
+					plugins: [ Image, ImageStyle, Paragraph, Undo, Table, ImageResizeButtons ],
 					image: {
 						resizeUnit: '%',
 						resizeOptions: [ {

packages/ckeditor5-image/tests/manual/imageresizeui.html → packages/ckeditor5-image/tests/manual/imageresizebuttons.html


+ 2 - 2
packages/ckeditor5-image/tests/manual/imageresizeui.js

@@ -13,7 +13,7 @@ import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';
 
 import ImageResize from '../../src/imageresize';
 import ImageResizeEditing from '../../src/imageresize/imageresizeediting';
-import ImageResizeUI from '../../src/imageresize/imageresizeui';
+import ImageResizeButtons from '../../src/imageresize/imageresizebuttons';
 
 import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud-services-config';
 
@@ -68,7 +68,7 @@ const config1 = {
 		IndentBlock,
 		EasyImage,
 		ImageResizeEditing,
-		ImageResizeUI
+		ImageResizeButtons
 	],
 	image: imageConfig1
 };

+ 1 - 1
packages/ckeditor5-image/tests/manual/imageresizeui.md

@@ -10,7 +10,7 @@ Tests for manual image resizing using the UI in the image toolbar.
 	- The plugin icon should appear only next to the dropdown button.
 	- Each option should have a label text corresponding to an option value defined in the configuration.
 	- The selected option should be "on" when the dropdown is open.
-	- The editor is using the combination of `ImageResizeEditing` and `ImageResizeUI`.
+	- The editor is using the combination of `ImageResizeEditing` and `ImageResizeButtons`.
 
 ## Buttons