@ckeditor/ckeditor5-core 33.0.0 → 34.2.0

package/src/multicommand.js

@@ -5,6 +5,8 @@
 
 import Command from './command';
 
+import insertToPriorityArray from '@ckeditor/ckeditor5-utils/src/inserttopriorityarray';
+
 /**
  * @module core/multicommand
  */
@@ -14,16 +16,17 @@ import Command from './command';
  *
  * This command is used to proxy multiple commands. The multi-command is enabled when
  * at least one of its registered child commands is enabled.
- * When executing a multi-command the first command that is enabled will be executed.
+ * When executing a multi-command the first enabled command with highest priority will be executed.
  *
  *		const multiCommand = new MultiCommand( editor );
  *
  *		const commandFoo = new Command( editor );
  *		const commandBar = new Command( editor );
  *
- *		// Register child commands.
+ *		// Register a child command.
  *		multiCommand.registerChildCommand( commandFoo );
- *		multiCommand.registerChildCommand( commandBar );
+ *		// Register a child command with a low priority.
+ *		multiCommand.registerChildCommand( commandBar, { priority: 'low' } );
  *
  *		// Enable one of the commands.
  *		commandBar.isEnabled = true;
@@ -40,12 +43,12 @@ export default class MultiCommand extends Command {
 		super( editor );
 
 		/**
-		 * Registered child commands.
+		 * Registered child commands definitions.
 		 *
-		 * @type {Array.<module:core/command~Command>}
+		 * @type {Array.<Object>}
 		 * @private
 		 */
-		this._childCommands = [];
+		this._childCommandsDefinitions = [];
 	}
 
 	/**
@@ -56,23 +59,25 @@ export default class MultiCommand extends Command {
 	}
 
 	/**
-	 * Executes the first of it registered child commands.
+	 * Executes the first enabled command which has the highest priority of all registered child commands.
 	 *
 	 * @returns {*} The value returned by the {@link module:core/command~Command#execute `command.execute()`}.
 	 */
 	execute( ...args ) {
 		const command = this._getFirstEnabledCommand();
 
-		return command != null && command.execute( args );
+		return !!command && command.execute( args );
 	}
 
 	/**
 	 * Registers a child command.
 	 *
 	 * @param {module:core/command~Command} command
+	 * @param {Object} options An object with configuration options.
+	 * @param {module:utils/priorities~PriorityString} [options.priority='normal'] Priority of a command to register.
 	 */
-	registerChildCommand( command ) {
-		this._childCommands.push( command );
+	registerChildCommand( command, options = { priority: 'normal' } ) {
+		insertToPriorityArray( this._childCommandsDefinitions, { command, priority: options.priority } );
 
 		// Change multi command enabled state when one of registered commands changes state.
 		command.on( 'change:isEnabled', () => this._checkEnabled() );
@@ -90,12 +95,14 @@ export default class MultiCommand extends Command {
 	}
 
 	/**
-	 * Returns a first enabled command or undefined if none of them is enabled.
+	 * Returns a first enabled command with the highest priority or `undefined` if none of them is enabled.
 	 *
 	 * @returns {module:core/command~Command|undefined}
 	 * @private
 	 */
 	_getFirstEnabledCommand() {
-		return this._childCommands.find( command => command.isEnabled );
+		const commandDefinition = this._childCommandsDefinitions.find( ( { command } ) => command.isEnabled );
+
+		return commandDefinition && commandDefinition.command;
 	}
 }

package/src/pendingactions.js

@@ -48,7 +48,7 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  *
  * This plugin is used by features like {@link module:upload/filerepository~FileRepository} to register their ongoing actions
  * and by features like {@link module:autosave/autosave~Autosave} to detect whether there are any ongoing actions.
- * Read more about saving the data in the {@glink builds/guides/integration/saving-data Saving and getting data} guide.
+ * Read more about saving the data in the {@glink installation/advanced/saving-data Saving and getting data} guide.
  *
  * @extends module:core/contextplugin~ContextPlugin
  */

package/src/plugincollection.js

@@ -324,7 +324,7 @@ export default class PluginCollection {
 				 *
 				 * Soft requirements were introduced in version 26.0.0. If you happen to stumble upon this error
 				 * when upgrading to version 26.0.0, read also the
-				 * {@glink builds/guides/migration/migration-to-26 Migration to 26.0.0} guide.
+				 * {@glink updating/migration-to-26 Migration to 26.0.0} guide.
 				 *
 				 * @error plugincollection-soft-required
 				 * @param {String} missingPlugin The name of the required plugin.
@@ -344,16 +344,17 @@ export default class PluginCollection {
 			 * This is usually done in CKEditor 5 builds by setting the {@link module:core/editor/editor~Editor.builtinPlugins}
 			 * property.
 			 *
-			 * **If you see this warning when using one of the {@glink builds/index CKEditor 5 Builds}**, it means
-			 * that you try to enable a plugin which was not included in that build. This may be due to a typo
+			 * **If you see this warning when using one of the {@glink installation/advanced/alternative-setups/predefined-builds
+			 * CKEditor 5 Builds}**,
+			 * it means that you try to enable a plugin which was not included in that build. This may be due to a typo
 			 * in the plugin name or simply because that plugin is not a part of this build. In the latter scenario,
-			 * read more about {@glink builds/guides/development/custom-builds custom builds}.
+			 * read more about {@glink installation/getting-started/quick-start custom builds}.
 			 *
 			 * **If you see this warning when using one of the editor creators directly** (not a build), then it means
 			 * that you tried loading plugins by name. However, unlike CKEditor 4, CKEditor 5 does not implement a "plugin loader".
 			 * This means that CKEditor 5 does not know where to load the plugin modules from. Therefore, you need to
 			 * provide each plugin through a reference (as a constructor function). Check out the examples in
-			 * {@glink builds/guides/integration/advanced-setup#scenario-2-building-from-source "Building from source"}.
+			 * {@glink installation/advanced/alternative-setups/integrating-from-source "Building from source"}.
 			 *
 			 * @error plugincollection-plugin-not-found
 			 * @param {String} plugin The name of the plugin which could not be loaded.
@@ -576,7 +577,7 @@ export default class PluginCollection {
 			 * They are already built into that editor build and now get added for the second time as dependencies
 			 * of the plugin you are installing.
 			 *
-			 * Read more about {@glink builds/guides/integration/installing-plugins installing plugins}.
+			 * Read more about {@glink installation/getting-started/installing-plugins installing plugins}.
 			 *
 			 * @error plugincollection-plugin-name-conflict
 			 * @param {String} pluginName The duplicated plugin name.