@ckeditor/ckeditor5-find-and-replace 44.1.0 → 44.2.0-alpha.0

package/dist/findpreviouscommand.d.ts

@@ -1,23 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace/findpreviouscommand
-*/
-import FindNextCommand from './findnextcommand.js';
-/**
- * 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}.
- */
-export default class FindPreviousCommand extends FindNextCommand {
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
-}

package/dist/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace
- */
-export { default as FindAndReplace } from './findandreplace.js';
-export { default as FindAndReplaceEditing } from './findandreplaceediting.js';
-export { default as FindAndReplaceUI } from './findandreplaceui.js';
-export { default as FindAndReplaceUtils } from './findandreplaceutils.js';
-export { default as FindCommand } from './findcommand.js';
-export { default as FindNextCommand } from './findnextcommand.js';
-export { default as FindPreviousCommand } from './findpreviouscommand.js';
-export { default as ReplaceCommand } from './replacecommand.js';
-export { default as ReplaceAllCommand } from './replaceallcommand.js';
-export type { FindAndReplaceConfig } from './findandreplaceconfig.js';
-import './augmentation.js';

package/dist/replaceallcommand.d.ts

@@ -1,39 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace/replaceallcommand
- */
-import { Collection } from 'ckeditor5/src/utils.js';
-import type { ResultType } from './findandreplace.js';
-import { ReplaceCommandBase } from './replacecommandbase.js';
-/**
- * The replace all command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- */
-export default class ReplaceAllCommand extends ReplaceCommandBase {
-    /**
-     * Replaces all the occurrences of `textToReplace` with a given `newText` string.
-     *
-     * ```ts
-     *	replaceAllCommand.execute( 'replaceAll', 'new text replacement', 'text to replace' );
-     * ```
-     *
-     * Alternatively you can call it from editor instance:
-     *
-     * ```ts
-     *	editor.execute( 'replaceAll', 'new text', 'old text' );
-     * ```
-     *
-     * @param newText Text that will be inserted to the editor for each match.
-     * @param 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: string, textToReplace: string | Collection<ResultType>): void;
-}

package/dist/replacecommand.d.ts

@@ -1,26 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace/replacecommand
-*/
-import type { ResultType } from './findandreplace.js';
-import { ReplaceCommandBase } from './replacecommandbase.js';
-/**
- * The replace command. It is used by the {@link module:find-and-replace/findandreplace~FindAndReplace find and replace feature}.
- */
-export default class ReplaceCommand extends ReplaceCommandBase {
-    /**
-     * Replace a given find result by a string or a callback.
-     *
-     * @param result A single result from the find command.
-     *
-     * @fires execute
-     */
-    execute(replacementText: string, result: ResultType): void;
-}

package/dist/replacecommandbase.d.ts

@@ -1,35 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace/replacecommandbase
-*/
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import type { ResultType } from './findandreplace.js';
-import type FindAndReplaceState from './findandreplacestate.js';
-export declare abstract class ReplaceCommandBase extends Command {
-    /**
-     * The find and replace state object used for command operations.
-     */
-    protected _state: FindAndReplaceState;
-    /**
-     * Creates a new `ReplaceCommand` instance.
-     *
-     * @param editor Editor on which this command will be used.
-     * @param state An object to hold plugin state.
-     */
-    constructor(editor: Editor, state: FindAndReplaceState);
-    abstract execute(...args: Array<unknown>): void;
-    /**
-     * Common logic for both `replace` commands.
-     * Replace a given find result by a string or a callback.
-     *
-     * @param result A single result from the find command.
-     */
-    protected _replace(replacementText: string, result: ResultType): void;
-}

package/dist/ui/findandreplaceformview.d.ts

@@ -1,313 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module find-and-replace/ui/findandreplaceformview
- */
-import { View, LabeledFieldView, FocusCycler, ViewCollection, type InputView } from 'ckeditor5/src/ui.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/findandreplaceform.css';
-/**
- * The find and replace form view class.
- *
- * See {@link module:find-and-replace/ui/findandreplaceformview~FindAndReplaceFormView}.
- */
-export default class FindAndReplaceFormView extends View {
-    /**
-     * A collection of child views.
-     */
-    children: ViewCollection;
-    /**
-     * Stores the number of matched search results.
-     *
-     * @readonly
-     * @observable
-     */
-    matchCount: number;
-    /**
-     * The offset of currently highlighted search result in {@link #matchCount matched results}.
-     *
-     * @observable
-     */
-    readonly highlightOffset: number;
-    /**
-     * `true` when the search params (find text, options) has been changed by the user since
-     * the last time find was executed. `false` otherwise.
-     *
-     * @readonly
-     * @observable
-     */
-    isDirty: boolean;
-    /**
-     * A live object with the aggregated `isEnabled` states of editor commands related to find and
-     * replace. For instance, it may look as follows:
-     *
-     * ```json
-     * {
-     * 	findNext: true,
-     * 	findPrevious: true,
-     * 	replace: false,
-     * 	replaceAll: false
-     * }
-     * ```
-     *
-     * @internal
-     * @observable
-     */
-    readonly _areCommandsEnabled: Record<string, boolean>;
-    /**
-     * The content of the counter label displaying the index of the current highlighted match
-     * on top of the find input, for instance "3 of 50".
-     *
-     * @internal
-     * @readonly
-     * @observable
-     */
-    _resultsCounterText: string;
-    /**
-     * The flag reflecting the state of the "Match case" switch button in the search options
-     * dropdown.
-     *
-     * @internal
-     * @readonly
-     * @observable
-     */
-    _matchCase: boolean;
-    /**
-     * The flag reflecting the state of the "Whole words only" switch button in the search options
-     * dropdown.
-     *
-     * @internal
-     * @readonly
-     * @observable
-     */
-    _wholeWordsOnly: boolean;
-    /**
-     * This flag is set `true` when some matches were found and the user didn't change the search
-     * params (text to find, options) yet. This is only possible immediately after hitting the "Find" button.
-     * `false` when there were no matches (see {@link #matchCount}) or the user changed the params (see {@link #isDirty}).
-     *
-     * It is used to control the enabled state of the replace UI (input and buttons); replacing text is only possible
-     * if this flag is `true`.
-     *
-     * @internal
-     * @observable
-     */
-    readonly _searchResultsFound: boolean;
-    /**
-     * The find in text input view that stores the searched string.
-     *
-     * @internal
-     */
-    readonly _findInputView: LabeledFieldView<InputView>;
-    /**
-     * The replace input view.
-     */
-    private readonly _replaceInputView;
-    /**
-     * The find button view that initializes the search process.
-     */
-    private readonly _findButtonView;
-    /**
-     * The find previous button view.
-     */
-    private readonly _findPrevButtonView;
-    /**
-     * The find next button view.
-     */
-    private readonly _findNextButtonView;
-    /**
-     * A collapsible view aggregating the advanced search options.
-     */
-    private readonly _advancedOptionsCollapsibleView;
-    /**
-     * A switch button view controlling the "Match case" option.
-     */
-    private readonly _matchCaseSwitchView;
-    /**
-     * A switch button view controlling the "Whole words only" option.
-     */
-    private readonly _wholeWordsOnlySwitchView;
-    /**
-     * The replace button view.
-     */
-    private readonly _replaceButtonView;
-    /**
-     * The replace all button view.
-     */
-    private readonly _replaceAllButtonView;
-    /**
-     * The `div` aggregating the inputs.
-     */
-    private readonly _inputsDivView;
-    /**
-     * The `div` aggregating the action buttons.
-     */
-    private readonly _actionButtonsDivView;
-    /**
-     * Tracks information about the DOM focus in the form.
-     */
-    private readonly _focusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    private readonly _keystrokes;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    private readonly _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    readonly focusCycler: FocusCycler;
-    locale: Locale;
-    /**
-     * Creates a view of find and replace form.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(direction?: 1 | -1): void;
-    /**
-     * Resets the form before re-appearing.
-     *
-     * It clears error messages, hides the match counter and disables the replace feature
-     * until the next hit of the "Find" button.
-     *
-     * **Note**: It does not reset inputs and options, though. This way the form works better in editors with
-     * disappearing toolbar (e.g. BalloonEditor): hiding the toolbar by accident (together with the find and replace UI)
-     * does not require filling the entire form again.
-     */
-    reset(): void;
-    /**
-     * Returns the value of the find input.
-     */
-    private get _textToFind();
-    /**
-     * Returns the value of the replace input.
-     */
-    private get _textToReplace();
-    /**
-     * Configures and returns the `<div>` aggregating all form inputs.
-     */
-    private _createInputsDiv;
-    /**
-     * The action performed when the {@link #_findButtonView} is pressed.
-     */
-    private _onFindButtonExecute;
-    /**
-     * Configures an injects the find results counter displaying a "N of M" label of the {@link #_findInputView}.
-     */
-    private _injectFindResultsCounter;
-    /**
-     * Creates the collapsible view aggregating the advanced search options.
-     */
-    private _createAdvancedOptionsCollapsible;
-    /**
-     * Configures and returns the `<div>` element aggregating all form action buttons.
-     */
-    private _createActionButtonsDiv;
-    /**
-     * Creates, configures and returns and instance of a dropdown allowing users to narrow
-     * the search criteria down. The dropdown has a list with switch buttons for each option.
-     */
-    private _createMatchCaseSwitch;
-    /**
-     * Creates, configures and returns and instance of a dropdown allowing users to narrow
-     * the search criteria down. The dropdown has a list with switch buttons for each option.
-     */
-    private _createWholeWordsOnlySwitch;
-    /**
-     * Initializes the {@link #_focusables} and {@link #_focusTracker} to allow navigation
-     * using <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keystrokes in the right order.
-     */
-    private _initFocusCycling;
-    /**
-     * Initializes the keystroke handling in the form.
-     */
-    private _initKeystrokeHandling;
-    /**
-     * Creates a button view.
-     *
-     * @param options The properties of the `ButtonView`.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * Creates a labeled input view.
-     *
-     * @param label The input label.
-     * @returns The labeled input view instance.
-     */
-    private _createInputField;
-}
-/**
- * Fired when the find next button is triggered.
- *
- * @eventName ~FindAndReplaceFormView#findNext
- * @param data The event data.
- */
-export type FindNextEvent = {
-    name: 'findNext';
-    args: [data?: FindNextEventData];
-};
-export type FindNextEventData = FindEventBaseData & {
-    matchCase: boolean;
-    wholeWords: boolean;
-};
-/**
- * Fired when the find previous button is triggered.
- *
- * @eventName ~FindAndReplaceFormView#findPrevious
- * @param data The event data.
- */
-export type FindPreviousEvent = {
-    name: 'findPrevious';
-    args: [data?: FindEventBaseData];
-};
-/**
- * Base type for all find/replace events.
- */
-export type FindEventBaseData = {
-    searchText: string;
-};
-/**
- * Fired when the replace button is triggered.
- *
- * @eventName ~FindAndReplaceFormView#replace
- * @param data The event data.
- */
-export type ReplaceEvent = {
-    name: 'replace';
-    args: [data: ReplaceEventData];
-};
-export type ReplaceEventData = FindEventBaseData & {
-    replaceText: string;
-};
-/**
- * Fired when the replaceAll button is triggered.
- *
- * @eventName ~FindAndReplaceFormView#replaceAll
- * @param data The event data.
- */
-export type ReplaceAllEvent = {
-    name: 'replaceAll';
-    args: [data: ReplaceEventData];
-};