@ckeditor/ckeditor5-find-and-replace 47.6.1-alpha.1 → 48.0.0-alpha.0

package/lang/translations/zh.po

@@ -1,68 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: zh_TW\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "The tooltip of a find and replace button in the toolbar. Also, the title of the find and replace form."
-msgid "Find and replace"
-msgstr "尋找和取代"
-
-msgctxt "The label for the searched text in the find and replace dropdown."
-msgid "Find in text…"
-msgstr "在文本中尋找"
-
-msgctxt "The label for the find action button in the find and replace dropdown."
-msgid "Find"
-msgstr "尋找"
-
-msgctxt "The label for the previous result button in the find and replace dropdown."
-msgid "Previous result"
-msgstr "前一個結果"
-
-msgctxt "The label for the previous result button in the find and replace dropdown."
-msgid "Next result"
-msgstr "後一個結果"
-
-msgctxt "The label for the (single) replace action button in the find and replace dropdown."
-msgid "Replace"
-msgstr "取代"
-
-msgctxt "The label for the replace all action button in the find and replace dropdown."
-msgid "Replace all"
-msgstr "全部取代"
-
-msgctxt "The label for the match case checkbox in the find and replace dropdown."
-msgid "Match case"
-msgstr "大小寫需相符"
-
-msgctxt "The label for the whole words only checkbox in the find and replace dropdown."
-msgid "Whole words only"
-msgstr "僅全字拼寫"
-
-msgctxt "The label for the text replacement in the find and replace dropdown."
-msgid "Replace with…"
-msgstr "以…替代"
-
-msgctxt "An error text displayed when user attempted to find an empty text."
-msgid "Text to find must not be empty."
-msgstr "不能查找空字串"
-
-msgctxt "A message displayed next to the replace field when disabled but user tries to use it."
-msgid "Tip: Find some text first in order to replace it."
-msgstr "提示：先查找字串再取代"
-
-msgctxt "The label and the tooltip of the options dropdown button in the find and replace form."
-msgid "Advanced options"
-msgstr "進階選項"
-
-msgctxt "Keystroke description for assistive technologies: keystroke for opening the find and replace UI."
-msgid "Find in the document"
-msgstr "在文件中尋找"

package/src/augmentation.js

@@ -1,5 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-export {};

package/src/findandreplace.js

@@ -1,90 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module find-and-replace/findandreplace
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { FindAndReplaceUI } from './findandreplaceui.js';
-import { FindAndReplaceEditing } from './findandreplaceediting.js';
-/**
- * The find and replace plugin.
- *
- * For a detailed overview, check the {@glink features/find-and-replace Find and replace feature documentation}.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * The {@link module:find-and-replace/findandreplaceediting~FindAndReplaceEditing find and replace editing feature},
- * * The {@link module:find-and-replace/findandreplaceui~FindAndReplaceUI find and replace UI feature}
- */
-export class FindAndReplace extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [FindAndReplaceEditing, FindAndReplaceUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FindAndReplace';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const ui = this.editor.plugins.get('FindAndReplaceUI');
-        const findAndReplaceEditing = this.editor.plugins.get('FindAndReplaceEditing');
-        const state = findAndReplaceEditing.state;
-        ui.on('findNext', (event, data) => {
-            // Data is contained only for the "find" button.
-            if (data) {
-                state.searchText = data.searchText;
-                findAndReplaceEditing.find(data.searchText, data);
-            }
-            else {
-                // Find next arrow button press.
-                this.editor.execute('findNext');
-            }
-        });
-        ui.on('findPrevious', (event, data) => {
-            if (data && state.searchText !== data.searchText) {
-                findAndReplaceEditing.find(data.searchText);
-            }
-            else {
-                // Subsequent calls.
-                this.editor.execute('findPrevious');
-            }
-        });
-        ui.on('replace', (event, data) => {
-            if (state.searchText !== data.searchText) {
-                findAndReplaceEditing.find(data.searchText);
-            }
-            const highlightedResult = state.highlightedResult;
-            if (highlightedResult) {
-                this.editor.execute('replace', data.replaceText, highlightedResult);
-            }
-        });
-        ui.on('replaceAll', (event, data) => {
-            // The state hadn't been yet built for this search text.
-            if (state.searchText !== data.searchText) {
-                findAndReplaceEditing.find(data.searchText);
-            }
-            this.editor.execute('replaceAll', data.replaceText, state.results);
-        });
-        // Reset the state when the user invalidated last search results, for instance,
-        // by starting typing another search query or changing options.
-        ui.on('searchReseted', () => {
-            state.clear(this.editor.model);
-            findAndReplaceEditing.stop();
-        });
-    }
-}

package/src/findandreplaceconfig.js

@@ -1,5 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-export {};

package/src/findandreplaceediting.js

@@ -1,247 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module find-and-replace/findandreplaceediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { scrollViewportToShowTarget } from 'ckeditor5/src/utils.js';
-import { FindCommand } from './findcommand.js';
-import { ReplaceCommand } from './replacecommand.js';
-import { ReplaceAllCommand } from './replaceallcommand.js';
-import { FindNextCommand } from './findnextcommand.js';
-import { FindPreviousCommand } from './findpreviouscommand.js';
-import { FindAndReplaceState } from './findandreplacestate.js';
-import { FindAndReplaceUtils } from './findandreplaceutils.js';
-import { debounce } from 'es-toolkit/compat';
-import '../theme/findandreplace.css';
-const HIGHLIGHT_CLASS = 'ck-find-result_selected';
-/**
- * Implements the editing part for find and replace plugin. For example conversion, commands etc.
- */
-export class FindAndReplaceEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [FindAndReplaceUtils];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FindAndReplaceEditing';
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get licenseFeatureCode() {
-        return 'FAR';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * An object storing the find and replace state within a given editor instance.
-     */
-    state;
-    /**
-     * @inheritDoc
-     */
-    init() {
-        this.state = new FindAndReplaceState(this.editor.model);
-        this.set('_isSearchActive', false);
-        this._defineConverters();
-        this._defineCommands();
-        this.listenTo(this.state, 'change:highlightedResult', (eventInfo, name, newValue, oldValue) => {
-            const { model } = this.editor;
-            model.change(writer => {
-                if (oldValue) {
-                    const oldMatchId = oldValue.marker.name.split(':')[1];
-                    const oldMarker = model.markers.get(`findResultHighlighted:${oldMatchId}`);
-                    if (oldMarker) {
-                        writer.removeMarker(oldMarker);
-                    }
-                }
-                if (newValue) {
-                    const newMatchId = newValue.marker.name.split(':')[1];
-                    writer.addMarker(`findResultHighlighted:${newMatchId}`, {
-                        usingOperation: false,
-                        affectsData: false,
-                        range: newValue.marker.getRange()
-                    });
-                }
-            });
-        });
-        /* istanbul ignore next -- @preserve */
-        const scrollToHighlightedResult = (eventInfo, name, newValue) => {
-            if (newValue) {
-                const domConverter = this.editor.editing.view.domConverter;
-                const viewRange = this.editor.editing.mapper.toViewRange(newValue.marker.getRange());
-                scrollViewportToShowTarget({
-                    target: domConverter.viewRangeToDom(viewRange),
-                    viewportOffset: 40
-                });
-            }
-        };
-        const debouncedScrollListener = debounce(scrollToHighlightedResult.bind(this), 32);
-        // Debounce scroll as highlight might be changed very frequently, e.g. when there's a replace all command.
-        this.listenTo(this.state, 'change:highlightedResult', debouncedScrollListener, { priority: 'low' });
-        // It's possible that the editor will get destroyed before debounced call kicks in.
-        // This would result with accessing a view three that is no longer in DOM.
-        this.listenTo(this.editor, 'destroy', debouncedScrollListener.cancel);
-        this.on('change:_isSearchActive', (evt, name, isSearchActive) => {
-            if (isSearchActive) {
-                this.listenTo(this.editor.model.document, 'change:data', this._onDocumentChange);
-            }
-            else {
-                this.stopListening(this.editor.model.document, 'change:data', this._onDocumentChange);
-            }
-        });
-    }
-    /**
-     * Initiate a search.
-     */
-    find(callbackOrText, findAttributes) {
-        this._isSearchActive = true;
-        this.editor.execute('find', callbackOrText, findAttributes);
-        return this.state.results;
-    }
-    /**
-     * Stops active results from updating, and clears out the results.
-     */
-    stop() {
-        this.state.clear(this.editor.model);
-        this._isSearchActive = false;
-    }
-    /**
-     * Sets up the commands.
-     */
-    _defineCommands() {
-        this.editor.commands.add('find', new FindCommand(this.editor, this.state));
-        this.editor.commands.add('findNext', new FindNextCommand(this.editor, this.state));
-        this.editor.commands.add('findPrevious', new FindPreviousCommand(this.editor, this.state));
-        this.editor.commands.add('replace', new ReplaceCommand(this.editor, this.state));
-        this.editor.commands.add('replaceAll', new ReplaceAllCommand(this.editor, this.state));
-    }
-    /**
-     * Sets up the marker downcast converters for search results highlighting.
-     */
-    _defineConverters() {
-        const { editor } = this;
-        // Setup the marker highlighting conversion.
-        editor.conversion.for('editingDowncast').markerToHighlight({
-            model: 'findResult',
-            view: ({ markerName }) => {
-                const [, id] = markerName.split(':');
-                // Marker removal from the view has a bug: https://github.com/ckeditor/ckeditor5/issues/7499
-                // A minimal option is to return a new object for each converted marker...
-                return {
-                    name: 'span',
-                    classes: ['ck-find-result'],
-                    attributes: {
-                        // ...however, adding a unique attribute should be future-proof..
-                        'data-find-result': id
-                    }
-                };
-            }
-        });
-        editor.conversion.for('editingDowncast').markerToHighlight({
-            model: 'findResultHighlighted',
-            view: ({ markerName }) => {
-                const [, id] = markerName.split(':');
-                // Marker removal from the view has a bug: https://github.com/ckeditor/ckeditor5/issues/7499
-                // A minimal option is to return a new object for each converted marker...
-                return {
-                    name: 'span',
-                    classes: [HIGHLIGHT_CLASS],
-                    attributes: {
-                        // ...however, adding a unique attribute should be future-proof..
-                        'data-find-result': id
-                    }
-                };
-            }
-        });
-    }
-    /**
-     * Reacts to document changes in order to update search list.
-     */
-    _onDocumentChange = () => {
-        const changedNodes = new Set();
-        const removedMarkers = new Set();
-        const model = this.editor.model;
-        const { results } = this.state;
-        const changes = model.document.differ.getChanges();
-        const changedMarkers = model.document.differ.getChangedMarkers();
-        // Get nodes in which changes happened to re-run a search callback on them.
-        changes.forEach(change => {
-            if (!change.position) {
-                return;
-            }
-            if (change.name === '$text' || (change.position.nodeAfter && model.schema.isInline(change.position.nodeAfter))) {
-                changedNodes.add(change.position.parent);
-                [...model.markers.getMarkersAtPosition(change.position)].forEach(markerAtChange => {
-                    removedMarkers.add(markerAtChange.name);
-                });
-            }
-            else if (change.type === 'insert' && change.position.nodeAfter) {
-                changedNodes.add(change.position.nodeAfter);
-            }
-        });
-        // Get markers from removed nodes also.
-        changedMarkers.forEach(({ name, data: { newRange } }) => {
-            if (newRange && newRange.start.root.rootName === '$graveyard') {
-                removedMarkers.add(name);
-            }
-        });
-        // Get markers from the updated nodes and remove all (search will be re-run on these nodes).
-        changedNodes.forEach(node => {
-            const markersInNode = [...model.markers.getMarkersIntersectingRange(model.createRangeIn(node))];
-            markersInNode.forEach(marker => removedMarkers.add(marker.name));
-        });
-        // Remove results from the changed part of content.
-        removedMarkers.forEach(markerName => {
-            if (!results.has(markerName)) {
-                return;
-            }
-            if (results.get(markerName) === this.state.highlightedResult) {
-                this.state.highlightedResult = null;
-            }
-            results.remove(markerName);
-        });
-        // Run search callback again on updated nodes.
-        const changedSearchResults = [];
-        const findAndReplaceUtils = this.editor.plugins.get('FindAndReplaceUtils');
-        changedNodes.forEach(nodeToCheck => {
-            const changedNodeSearchResults = findAndReplaceUtils.updateFindResultFromRange(model.createRangeOn(nodeToCheck), model, this.state.lastSearchCallback, results);
-            changedSearchResults.push(...changedNodeSearchResults);
-        });
-        changedMarkers.forEach(markerToCheck => {
-            // Handle search result highlight update when T&C plugin is active.
-            // Lookup is performed only on newly inserted markers.
-            if (markerToCheck.data.newRange) {
-                const changedNodeSearchResults = findAndReplaceUtils.updateFindResultFromRange(markerToCheck.data.newRange, model, this.state.lastSearchCallback, results);
-                changedSearchResults.push(...changedNodeSearchResults);
-            }
-        });
-        if (!this.state.highlightedResult && changedSearchResults.length) {
-            // If there are found phrases but none is selected, select the first one.
-            this.state.highlightedResult = changedSearchResults[0];
-        }
-        else {
-            // If there is already highlight item then refresh highlight offset after appending new items.
-            this.state.refreshHighlightOffset(model);
-        }
-    };
-}

package/src/findandreplacestate.js

@@ -1,93 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { ObservableMixin, Collection } from 'ckeditor5/src/utils.js';
-/**
- * The object storing find and replace plugin state for a given editor instance.
- */
-export class FindAndReplaceState extends /* #__PURE__ */ ObservableMixin() {
-    /**
-     * Creates an instance of the state.
-     */
-    constructor(model) {
-        super();
-        this.set('results', new Collection());
-        this.set('highlightedResult', null);
-        this.set('highlightedOffset', 0);
-        this.set('searchText', '');
-        this.set('replaceText', '');
-        this.set('lastSearchCallback', null);
-        this.set('matchCase', false);
-        this.set('matchWholeWords', false);
-        this.results.on('change', (eventInfo, { removed, index }) => {
-            if (Array.from(removed).length) {
-                let highlightedResultRemoved = false;
-                model.change(writer => {
-                    for (const removedResult of removed) {
-                        if (this.highlightedResult === removedResult) {
-                            highlightedResultRemoved = true;
-                        }
-                        if (model.markers.has(removedResult.marker.name)) {
-                            writer.removeMarker(removedResult.marker);
-                        }
-                    }
-                });
-                if (highlightedResultRemoved) {
-                    const nextHighlightedIndex = index >= this.results.length ? 0 : index;
-                    this.highlightedResult = this.results.get(nextHighlightedIndex);
-                }
-            }
-        });
-        this.on('change:highlightedResult', () => {
-            this.refreshHighlightOffset(model);
-        });
-    }
-    /**
-     * Cleans the state up and removes markers from the model.
-     */
-    clear(model) {
-        this.searchText = '';
-        model.change(writer => {
-            if (this.highlightedResult) {
-                const oldMatchId = this.highlightedResult.marker.name.split(':')[1];
-                const oldMarker = model.markers.get(`findResultHighlighted:${oldMatchId}`);
-                if (oldMarker) {
-                    writer.removeMarker(oldMarker);
-                }
-            }
-            [...this.results].forEach(({ marker }) => {
-                writer.removeMarker(marker);
-            });
-        });
-        this.results.clear();
-    }
-    /**
-     * Refreshes the highlight result offset based on it's index within the result list.
-     */
-    refreshHighlightOffset(model) {
-        const { highlightedResult, results } = this;
-        if (highlightedResult) {
-            this.highlightedOffset = sortSearchResultsByMarkerPositions(model, [...results]).indexOf(highlightedResult) + 1;
-        }
-        else {
-            this.highlightedOffset = 0;
-        }
-    }
-}
-/**
- * Sorts search results by marker positions. Make sure that the results are sorted in the same order as they appear in the document
- * to avoid issues with the `find next` command. Apparently, the order of the results in the state might be different than the order
- * of the markers in the model.
- *
- * @internal
- */
-export function sortSearchResultsByMarkerPositions(model, results) {
-    const sortMapping = { before: -1, same: 0, after: 1, different: 1 };
-    // `compareWith` doesn't play well with multi-root documents, so we need to sort results by root name first
-    // and then sort them within each root. It prevents "random" order of results when the document has multiple roots.
-    // See more: https://github.com/ckeditor/ckeditor5/pull/17292#issuecomment-2442084549
-    return model.document.getRootNames().flatMap(rootName => results
-        .filter(result => result.marker.getStart().root.rootName === rootName)
-        .sort((a, b) => sortMapping[a.marker.getStart().compareWith(b.marker.getStart())]));
-}