@ckeditor/ckeditor5-find-and-replace 30.0.0

package/src/findnextcommand.js

@@ -0,0 +1,67 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module find-and-replace/findnextcommand
+*/
+
+import { Command } from 'ckeditor5/src/core';
+
+/**
+ * The find next command. Moves the highlight to the next search result.
+ *
+ * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ *
+ * @extends module:core/command~Command
+ */
+export default class FindNextCommand extends Command {
+	/**
+	 * Creates a new `FindNextCommand` instance.
+	 *
+	 * @param {module:core/editor/editor~Editor} editor The editor on which this command will be used.
+	 * @param {module:find-and-replace/findandreplacestate~FindAndReplaceState} state An object to hold plugin state.
+	 */
+	constructor( editor, state ) {
+		super( editor );
+
+		/**
+		 * The find and replace state object used for command operations.
+		 *
+		 * @protected
+		 * @member {module:find-and-replace/findandreplacestate~FindAndReplaceState} #_state
+		 */
+		this._state = state;
+
+		this.isEnabled = false;
+
+		this.listenTo( this._state.results, 'change', () => {
+			this.isEnabled = this._state.results.length > 1;
+		} );
+
+		// Do not block the command if the editor goes into the read-only mode as it does not impact the data. See #9975.
+		this.listenTo( editor, 'change:isReadOnly', () => {
+			this.clearForceDisabled( 'readOnlyMode' );
+		} );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	refresh() {
+		this.isEnabled = this._state.results.length > 1;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	execute() {
+		const results = this._state.results;
+		const currentIndex = results.getIndex( this._state.highlightedResult );
+		const nextIndex = currentIndex + 1 >= results.length ?
+			0 : currentIndex + 1;
+
+		this._state.highlightedResult = this._state.results.get( nextIndex );
+	}
+}

package/src/findpreviouscommand.js

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module find-and-replace/findpreviouscommand
+*/
+
+import FindNextCommand from './findnextcommand';
+
+/**
+ * The find previous command. Moves the highlight to the previous search result.
+ *
+ * It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ *
+ * @extends module:find-and-replace/findnextcommand~FindNextCommand
+ */
+export default class FindPreviousCommand extends FindNextCommand {
+	/**
+	 * @inheritDoc
+	 */
+	execute() {
+		const results = this._state.results;
+		const currentIndex = results.getIndex( this._state.highlightedResult );
+		const previousIndex = currentIndex - 1 < 0 ?
+			this._state.results.length - 1 : currentIndex - 1;
+
+		this._state.highlightedResult = this._state.results.get( previousIndex );
+	}
+}

package/src/index.js

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module find-and-replace
+ */
+
+export { default as FindAndReplace } from './findandreplace';

package/src/replaceallcommand.js

@@ -0,0 +1,61 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module find-and-replace/replaceallcommand
+ */
+
+import { updateFindResultFromRange, findByTextCallback } from './utils';
+import { Collection } from 'ckeditor5/src/utils';
+import ReplaceCommand from './replacecommand';
+
+/**
+ * The replace all command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ *
+ * @extends module:find-and-replace/replacecommand~ReplaceCommand
+ */
+export default class ReplaceAllCommand extends ReplaceCommand {
+	/**
+	 * Replaces all the occurrences of `textToReplace` with a given `newText` string.
+	 *
+	 * ```js
+	 *	replaceAllCommand.execute( 'replaceAll', 'new text replacement', 'text to replace' );
+	 * ```
+	 *
+	 * Alternatively you can call it from editor instance:
+	 *
+	 * ```js
+	 *	editor.execute( 'replaceAll', 'new text', 'old text' );
+	 * ```
+	 *
+	 * @param {String} newText Text that will be inserted to the editor for each match.
+	 * @param {String|module:utils/collection~Collection} textToReplace Text to be replaced or a collection of matches
+	 * as returned by the find command.
+	 *
+	 * @fires module:core/command~Command#event:execute
+	 */
+	execute( newText, textToReplace ) {
+		const { editor } = this;
+		const { model } = editor;
+
+		const results = textToReplace instanceof Collection ?
+			textToReplace : model.document.getRootNames()
+				.reduce( ( ( currentResults, rootName ) => updateFindResultFromRange(
+					model.createRangeIn( model.document.getRoot( rootName ) ),
+					model,
+					findByTextCallback( textToReplace, this._state ),
+					currentResults
+				) ), null );
+
+		if ( results.length ) {
+			model.change( () => {
+				[ ...results ].forEach( searchResult => {
+					// Just reuse logic from the replace command to replace a single match.
+					super.execute( newText, searchResult );
+				} );
+			} );
+		}
+	}
+}

package/src/replacecommand.js

@@ -0,0 +1,69 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module find-and-replace/replacecommand
+*/
+
+import { Command } from 'ckeditor5/src/core';
+
+/**
+ * The replace command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
+ *
+ * @extends module:core/command~Command
+ */
+export default class ReplaceCommand extends Command {
+	/**
+	 * Creates a new `ReplaceCommand` instance.
+	 *
+	 * @param {module:core/editor/editor~Editor} editor Editor on which this command will be used.
+	 * @param {module:find-and-replace/findandreplacestate~FindAndReplaceState} state An object to hold plugin state.
+	 */
+	constructor( editor, state ) {
+		super( editor );
+
+		// The replace command is always enabled.
+		this.isEnabled = true;
+
+		/**
+		 * The find and replace state object used for command operations.
+		 *
+		 * @protected
+		 * @member {module:find-and-replace/findandreplacestate~FindAndReplaceState} #_state
+		 */
+		this._state = state;
+	}
+
+	/**
+	 * Replace a given find result by a string or a callback.
+	 *
+	 * @param {String} replacementText
+	 * @param {Object} result A single result from the find command.
+	 *
+	 * @fires module:core/command~Command#event:execute
+	 */
+	execute( replacementText, result ) {
+		const { model } = this.editor;
+
+		model.change( writer => {
+			const range = result.marker.getRange();
+
+			let textAttributes = {};
+
+			for ( const item of range.getItems() ) {
+				if ( item.is( '$text' ) || item.is( '$textProxy' ) ) {
+					textAttributes = item.getAttributes();
+					break;
+				}
+			}
+
+			model.insertContent( writer.createText( replacementText, textAttributes ), range );
+
+			if ( this._state.results.has( result ) ) {
+				this._state.results.remove( result );
+			}
+		} );
+	}
+}