@ckeditor/ckeditor5-find-and-replace 0.0.0-internal-20241017.0

package/lang/translations/vi.po

@@ -0,0 +1,74 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Vietnamese (https://app.transifex.com/ckeditor/teams/11143/vi/)\n"
+"Language: vi\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 "Tìm và thay thế"
+
+msgctxt "The label for the searched text in the find and replace dropdown."
+msgid "Find in text…"
+msgstr "Tìm trong văn bản..."
+
+msgctxt "The label for the find action button in the find and replace dropdown."
+msgid "Find"
+msgstr "Tìm"
+
+msgctxt "The label for the previous result button in the find and replace dropdown."
+msgid "Previous result"
+msgstr "Kết quả trước"
+
+msgctxt "The label for the previous result button in the find and replace dropdown."
+msgid "Next result"
+msgstr "Kết quả tiếp theo"
+
+msgctxt "The label for the (single) replace action button in the find and replace dropdown."
+msgid "Replace"
+msgstr "Thay thế"
+
+msgctxt "The label for the replace all action button in the find and replace dropdown."
+msgid "Replace all"
+msgstr "Thay thế tất cả"
+
+msgctxt "The label for the match case checkbox in the find and replace dropdown."
+msgid "Match case"
+msgstr "Khớp chữ hoa/chữ thường"
+
+msgctxt "The label for the whole words only checkbox in the find and replace dropdown."
+msgid "Whole words only"
+msgstr "Chỉ toàn bộ từ"
+
+msgctxt "The label for the text replacement in the find and replace dropdown."
+msgid "Replace with…"
+msgstr "Thay thế bằng..."
+
+msgctxt "An error text displayed when user attempted to find an empty text."
+msgid "Text to find must not be empty."
+msgstr "Không được để trống trường văn bản cần tìm."
+
+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 "Mẹo: Tìm một đoạn văn bản trước để thay thế."
+
+msgctxt "The label and the tooltip of the options dropdown button in the find and replace form."
+msgid "Advanced options"
+msgstr "Tùy chọn nâng cao"
+
+msgctxt "Keystroke description for assistive technologies: keystroke for opening the find and replace UI."
+msgid "Find in the document"
+msgstr "Tìm trong tài liệu"

package/lang/translations/zh-cn.po

@@ -0,0 +1,74 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (China) (https://app.transifex.com/ckeditor/teams/11143/zh_CN/)\n"
+"Language: zh_CN\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/lang/translations/zh.po

@@ -0,0 +1,74 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (Taiwan) (https://app.transifex.com/ckeditor/teams/11143/zh_TW/)\n"
+"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/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@ckeditor/ckeditor5-find-and-replace",
+  "version": "0.0.0-internal-20241017.0",
+  "description": "Find and replace feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "@ckeditor/ckeditor5-core": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-internal-20241017.0",
+    "ckeditor5": "0.0.0-internal-20241017.0",
+    "lodash-es": "4.17.21"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-find-and-replace"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
+}

package/src/augmentation.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { FindAndReplace, FindAndReplaceEditing, FindAndReplaceUI, FindAndReplaceUtils, FindCommand, FindNextCommand, FindPreviousCommand, ReplaceAllCommand, ReplaceCommand } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [FindAndReplace.pluginName]: FindAndReplace;
+        [FindAndReplaceEditing.pluginName]: FindAndReplaceEditing;
+        [FindAndReplaceUI.pluginName]: FindAndReplaceUI;
+        [FindAndReplaceUtils.pluginName]: FindAndReplaceUtils;
+    }
+    interface CommandsMap {
+        find: FindCommand;
+        findNext: FindNextCommand;
+        findPrevious: FindPreviousCommand;
+        replace: ReplaceCommand;
+        replaceAll: ReplaceAllCommand;
+    }
+}

package/src/augmentation.js

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

package/src/findandreplace.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/findandreplace
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import FindAndReplaceUI from './findandreplaceui.js';
+import FindAndReplaceEditing from './findandreplaceediting.js';
+import type { Marker } from 'ckeditor5/src/engine.js';
+export type ResultType = {
+    id?: string;
+    label?: string;
+    start?: number;
+    end?: number;
+    marker?: Marker;
+};
+/**
+ * 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 default class FindAndReplace extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FindAndReplaceEditing, typeof FindAndReplaceUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FindAndReplace";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/findandreplace.js

@@ -0,0 +1,90 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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 default 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.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/findandreplaceconfig
+ */
+/**
+ * The configuration of the find and replace feature.
+ * The option is used by the {@link module:find-and-replace/findandreplace~FindAndReplace} feature.
+ *
+ * ```ts
+ * ClassicEditor
+ *   .create( {
+ *     findAndReplace: ... // Find and replace feature config.
+ *   } )
+ *   .then( ... )
+ *   .catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface FindAndReplaceConfig {
+    /**
+     * The type of the find and replace UI opened by the `'findAndReplace'` button registered in the
+     * editor's {@link module:ui/componentfactory~ComponentFactory component factory}
+     *
+     * The default value is `'dialog'`.
+     */
+    uiType?: 'dialog' | 'dropdown';
+}

package/src/findandreplaceconfig.js

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

package/src/findandreplaceediting.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module find-and-replace/findandreplaceediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { type Collection } from 'ckeditor5/src/utils.js';
+import { type FindAttributes } from './findcommand.js';
+import FindAndReplaceState, { type FindCallback } from './findandreplacestate.js';
+import FindAndReplaceUtils from './findandreplaceutils.js';
+import type { ResultType } from './findandreplace.js';
+import '../theme/findandreplace.css';
+/**
+ * Implements the editing part for find and replace plugin. For example conversion, commands etc.
+ */
+export default class FindAndReplaceEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FindAndReplaceUtils];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FindAndReplaceEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * An object storing the find and replace state within a given editor instance.
+     */
+    state?: FindAndReplaceState;
+    /**
+     * A flag that indicates that the user has started a search and the editor is listening for changes
+     * to the text on which it will perform an automatic search. Among other things, the mode is activated
+     * when the user first clicks 'Find' button and then later deactivated when the modal or search dropdown is closed.
+     *
+     * @internal
+     */
+    _isSearchActive: boolean;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Initiate a search.
+     */
+    find(callbackOrText: string | FindCallback, findAttributes?: FindAttributes): Collection<ResultType>;
+    /**
+     * Stops active results from updating, and clears out the results.
+     */
+    stop(): void;
+    /**
+     * Sets up the commands.
+     */
+    private _defineCommands;
+    /**
+     * Sets up the marker downcast converters for search results highlighting.
+     */
+    private _defineConverters;
+    /**
+     * Reacts to document changes in order to update search list.
+     */
+    private _onDocumentChange;
+}