Selaa lähdekoodia

Update CKFinder documentation.

Maciej Gołaszewski 7 vuotta sitten
vanhempi
commit
8dce946816

+ 2 - 2
packages/ckeditor5-ckfinder/src/ckfinder.js

@@ -75,8 +75,8 @@ export default class CKFinder extends Plugin {
  * The type of the CKFinder opener method.
  *
  * Supported types are:
- * * '"modal"' - opens a CKFinder modal
- * * '"popup"' - opens a CKFinder popup window
+ * * `"modal"` - opens a CKFinder modal
+ * * `"popup"` - opens a CKFinder popup window
  *
  * Defaults to "'modal'".
  *

+ 7 - 6
packages/ckeditor5-ckfinder/src/ckfindercommand.js

@@ -43,16 +43,17 @@ export default class CKFinderCommand extends Command {
 			throw new CKEditorError( 'ckfinder-unknown-openerMethod: The openerMethod config option must by "popup" or "modal".' );
 		}
 
-		const config = this.editor.config.get( 'ckfinder.config' ) || {};
+		const options = this.editor.config.get( 'ckfinder.options' ) || {};
 
-		config.chooseFiles = true;
+		options.chooseFiles = true;
 
-		config.onInit = finder => {
+		// The onInit method allows to extend CKFinder's behavior. It is used to attach event listeners to file choosing related events.
+		options.onInit = finder => {
 			finder.on( 'files:choose', evt => {
 				for ( const file of evt.data.files.toArray() ) {
-					// Use CKFinder file isImage() to insert only image-type files.
 					const url = file.get( 'url' );
 
+					// Use CKFinder file isImage() to insert only image-type files.
 					if ( file.isImage() ) {
 						insertImage( editor.model, url ? url : finder.request( 'file:getProxyUrl', { file } ) );
 					} else {
@@ -74,12 +75,12 @@ export default class CKFinderCommand extends Command {
 					} );
 				}
 
-				// show warning - no resizedUrl returned...
+				// Show warning - no resizedUrl returned...
 				insertImage( editor.model, resizedUrl );
 			} );
 		};
 
-		window.CKFinder[ openerMethod ]( config );
+		window.CKFinder[ openerMethod ]( options );
 	}
 }
 

+ 5 - 5
packages/ckeditor5-ckfinder/src/ckfinderui.js

@@ -36,22 +36,22 @@ export default class CKFinderUI extends Plugin {
 		componentFactory.add( 'ckfinder', locale => {
 			const command = editor.commands.get( 'ckfinder' );
 
-			const view = new ButtonView( locale );
+			const button = new ButtonView( locale );
 
-			view.set( {
+			button.set( {
 				label: t( 'CKFinder' ),
 				icon: ckfinderIcon,
 				tooltip: true
 			} );
 
-			view.bind( 'isEnabled' ).to( command );
+			button.bind( 'isEnabled' ).to( command );
 
-			view.on( 'execute', () => {
+			button.on( 'execute', () => {
 				editor.execute( 'ckfinder' );
 				editor.editing.view.focus();
 			} );
 
-			return view;
+			return button;
 		} );
 	}
 }