Преглед изворни кода

Add `disableResizeHandles` API docs.

panr пре 5 година
родитељ
комит
26fcbdd56b
1 измењених фајлова са 23 додато и 0 уклоњено
  1. 23 0
      packages/ckeditor5-image/src/imageresize.js

+ 23 - 0
packages/ckeditor5-image/src/imageresize.js

@@ -70,6 +70,29 @@ export default class ImageResize extends Plugin {
  * @member {String} module:image/image~ImageConfig#resizeUnit
  */
 
+/**
+ * The option for disabling image resize by handles.
+ *
+ * It's useful when you want to set certain options for image resize and be sure that other users
+ * can only set one of those sizes by the dropdown or standalone buttons defined in
+ * {@link module:image/image~ImageConfig#resizeOptions}.
+ *
+ *		ClassicEditor
+ *			.create( editorElement, {
+ *				image: {
+ *					disableResizeHandles: true
+ *				}
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ *
+ * This option is used by the {@link module:image/imageresize~ImageResize} feature.
+ *
+ * @default 'false'
+ * @member {String} module:image/image~ImageConfig#disableResizeHandles
+ */
+
 /**
  * The image resize options.
  *