Browse Source

Docs: Added more docs to the options.onCommit.

Marek Lewandowski 6 năm trước cách đây
mục cha
commit
0d54bb3a9e
1 tập tin đã thay đổi với 20 bổ sung0 xóa
  1. 20 0
      packages/ckeditor5-widget/src/widgetresize.js

+ 20 - 0
packages/ckeditor5-widget/src/widgetresize.js

@@ -130,6 +130,26 @@ export default class WidgetResize extends Plugin {
  */
 
 /**
+ * A callback to be executed once resizing process is done.
+ *
+ * It receives a `Number` (`newValue`) as a parameter.
+ *
+ * For example, {@link module:image/imageresize~ImageResize} uses it to execute image resize command,
+ * which puts new value into the model.
+ *
+ * ```js
+ * {
+ *	modelElement: data.item,
+ *	viewElement: widget,
+ *	downcastWriter: conversionApi.writer,
+ *
+ *	onCommit( newValue ) {
+ *		editor.execute( 'imageResize', { width: newValue } );
+ *	}
+ * };
+ * ```
+ *
+ *
  * @member {Function} module:widget/widgetresize~ResizerOptions#onCommit
  */