@ckeditor/ckeditor5-typing 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/twostepcaretmovement.d.ts

@@ -1,239 +1,239 @@
 /**
- * @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
- */
+* @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 typing/twostepcaretmovement
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { type ViewDocumentDomEventData } from '@ckeditor/ckeditor5-engine';
+* @module typing/twostepcaretmovement
+*/
+import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
+import { type ViewDocumentDomEventData } from "@ckeditor/ckeditor5-engine";
 /**
- * This plugin enables the two-step caret (phantom) movement behavior for
- * {@link module:typing/twostepcaretmovement~TwoStepCaretMovement#registerAttribute registered attributes}
- * on arrow right (<kbd>→</kbd>) and left (<kbd>←</kbd>) key press.
- *
- * Thanks to this (phantom) caret movement the user is able to type before/after as well as at the
- * beginning/end of an attribute.
- *
- * **Note:** This plugin support right–to–left (Arabic, Hebrew, etc.) content by mirroring its behavior
- * but for the sake of simplicity examples showcase only left–to–right use–cases.
- *
- * # Forward movement
- *
- * ## "Entering" an attribute:
- *
- * When this plugin is enabled and registered for the `a` attribute and the selection is right before it
- * (at the attribute boundary), pressing the right arrow key will not move the selection but update its
- * attributes accordingly:
- *
- * * When enabled:
- *
- * ```xml
- * foo{}<$text a="true">bar</$text>
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * foo<$text a="true">{}bar</$text>
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * foo{}<$text a="true">bar</$text>
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * foo<$text a="true">b{}ar</$text>
- * ```
- *
- *
- * ## "Leaving" an attribute:
- *
- * * When enabled:
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * 	<kbd>→</kbd>
- *
- * ```xml
- * <$text a="true">bar</$text>b{}az
- * ```
- *
- * # Backward movement
- *
- * * When enabled:
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">bar{}</$text>baz
- * ```
- *
- * * When disabled:
- *
- * ```xml
- * <$text a="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">ba{}r</$text>b{}az
- * ```
- *
- * # Multiple attributes
- *
- * * When enabled and many attributes starts or ends at the same position:
- *
- * ```xml
- * <$text a="true" b="true">bar</$text>{}baz
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true" b="true">bar{}</$text>baz
- * ```
- *
- * * When enabled and one procedes another:
- *
- * ```xml
- * <$text a="true">bar</$text><$text b="true">{}bar</$text>
- * ```
- *
- * 	<kbd>←</kbd>
- *
- * ```xml
- * <$text a="true">bar{}</$text><$text b="true">bar</$text>
- * ```
- *
- */
+* This plugin enables the two-step caret (phantom) movement behavior for
+* {@link module:typing/twostepcaretmovement~TwoStepCaretMovement#registerAttribute registered attributes}
+* on arrow right (<kbd>→</kbd>) and left (<kbd>←</kbd>) key press.
+*
+* Thanks to this (phantom) caret movement the user is able to type before/after as well as at the
+* beginning/end of an attribute.
+*
+* **Note:** This plugin support right–to–left (Arabic, Hebrew, etc.) content by mirroring its behavior
+* but for the sake of simplicity examples showcase only left–to–right use–cases.
+*
+* # Forward movement
+*
+* ## "Entering" an attribute:
+*
+* When this plugin is enabled and registered for the `a` attribute and the selection is right before it
+* (at the attribute boundary), pressing the right arrow key will not move the selection but update its
+* attributes accordingly:
+*
+* * When enabled:
+*
+* ```xml
+* foo{}<$text a="true">bar</$text>
+* ```
+*
+* 	<kbd>→</kbd>
+*
+* ```xml
+* foo<$text a="true">{}bar</$text>
+* ```
+*
+* * When disabled:
+*
+* ```xml
+* foo{}<$text a="true">bar</$text>
+* ```
+*
+* 	<kbd>→</kbd>
+*
+* ```xml
+* foo<$text a="true">b{}ar</$text>
+* ```
+*
+*
+* ## "Leaving" an attribute:
+*
+* * When enabled:
+*
+* ```xml
+* <$text a="true">bar{}</$text>baz
+* ```
+*
+* 	<kbd>→</kbd>
+*
+* ```xml
+* <$text a="true">bar</$text>{}baz
+* ```
+*
+* * When disabled:
+*
+* ```xml
+* <$text a="true">bar{}</$text>baz
+* ```
+*
+* 	<kbd>→</kbd>
+*
+* ```xml
+* <$text a="true">bar</$text>b{}az
+* ```
+*
+* # Backward movement
+*
+* * When enabled:
+*
+* ```xml
+* <$text a="true">bar</$text>{}baz
+* ```
+*
+* 	<kbd>←</kbd>
+*
+* ```xml
+* <$text a="true">bar{}</$text>baz
+* ```
+*
+* * When disabled:
+*
+* ```xml
+* <$text a="true">bar</$text>{}baz
+* ```
+*
+* 	<kbd>←</kbd>
+*
+* ```xml
+* <$text a="true">ba{}r</$text>b{}az
+* ```
+*
+* # Multiple attributes
+*
+* * When enabled and many attributes starts or ends at the same position:
+*
+* ```xml
+* <$text a="true" b="true">bar</$text>{}baz
+* ```
+*
+* 	<kbd>←</kbd>
+*
+* ```xml
+* <$text a="true" b="true">bar{}</$text>baz
+* ```
+*
+* * When enabled and one procedes another:
+*
+* ```xml
+* <$text a="true">bar</$text><$text b="true">{}bar</$text>
+* ```
+*
+* 	<kbd>←</kbd>
+*
+* ```xml
+* <$text a="true">bar{}</$text><$text b="true">bar</$text>
+* ```
+*
+*/
 export declare class TwoStepCaretMovement extends Plugin {
-    /**
-     * A set of attributes to handle.
-     */
-    private attributes;
-    /**
-     * The current UID of the overridden gravity, as returned by
-     * {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
-     */
-    private _overrideUid;
-    /**
-     * A flag indicating that the automatic gravity restoration should not happen upon the next
-     * gravity restoration.
-     * {@link module:engine/model/selection~ModelSelection#event:change:range} event.
-     */
-    private _isNextGravityRestorationSkipped;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TwoStepCaretMovement";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Registers a given attribute for the two-step caret movement.
-     *
-     * @param attribute Name of the attribute to handle.
-     */
-    registerAttribute(attribute: string): void;
-    /**
-     * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
-     *
-     * @internal
-     * @param eventData Data of the key press.
-     * @returns `true` when the handler prevented caret movement.
-     */
-    _handleForwardMovement(eventData?: ViewDocumentDomEventData): boolean;
-    /**
-     * Updates the document selection and the view according to the two–step caret movement state
-     * when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
-     *
-     * @internal
-     * @param eventData Data of the key press.
-     * @returns `true` when the handler prevented caret movement
-     */
-    _handleBackwardMovement(eventData?: ViewDocumentDomEventData): boolean;
-    /**
-     * Starts listening to {@link module:engine/view/document~ViewDocument#event:mousedown} and
-     * {@link module:engine/view/document~ViewDocument#event:selectionChange} and puts the selection before/after a 2-step node
-     * if clicked at the beginning/ending of the 2-step node.
-     *
-     * The purpose of this action is to allow typing around the 2-step node directly after a click.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/1016.
-     */
-    private _enableClickingAfterNode;
-    /**
-     * Starts listening to {@link module:engine/model/model~Model#event:insertContent} and corrects the model
-     * selection attributes if the selection is at the end of a two-step node after inserting the content.
-     *
-     * The purpose of this action is to improve the overall UX because the user is no longer "trapped" by the
-     * two-step attribute of the selection, and they can type a "clean" (`linkHref`–less) text right away.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/6053.
-     */
-    private _enableInsertContentSelectionAttributesFixer;
-    /**
-     * Starts listening to {@link module:engine/model/model~Model#deleteContent} and checks whether
-     * removing a content right after the tow-step attribute.
-     *
-     * If so, the selection should not preserve the two-step attribute. However, if
-     * the {@link module:typing/twostepcaretmovement~TwoStepCaretMovement} plugin is active and
-     * the selection has the two-step attribute due to overridden gravity (at the end), the two-step attribute should stay untouched.
-     *
-     * The purpose of this action is to allow removing the link text and keep the selection outside the link.
-     *
-     * See https://github.com/ckeditor/ckeditor5/issues/7521.
-     */
-    private _handleDeleteContentAfterNode;
-    /**
-     * `true` when the gravity is overridden for the plugin.
-     */
-    private get _isGravityOverridden();
-    /**
-     * Overrides the gravity using the {@link module:engine/model/writer~ModelWriter model writer}
-     * and stores the information about this fact in the {@link #_overrideUid}.
-     *
-     * A shorthand for {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
-     */
-    private _overrideGravity;
-    /**
-     * Restores the gravity using the {@link module:engine/model/writer~ModelWriter model writer}.
-     *
-     * A shorthand for {@link module:engine/model/writer~ModelWriter#restoreSelectionGravity}.
-     */
-    private _restoreGravity;
+	/**
+	* A set of attributes to handle.
+	*/
+	private attributes;
+	/**
+	* The current UID of the overridden gravity, as returned by
+	* {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
+	*/
+	private _overrideUid;
+	/**
+	* A flag indicating that the automatic gravity restoration should not happen upon the next
+	* gravity restoration.
+	* {@link module:engine/model/selection~ModelSelection#event:change:range} event.
+	*/
+	private _isNextGravityRestorationSkipped;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "TwoStepCaretMovement";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Registers a given attribute for the two-step caret movement.
+	*
+	* @param attribute Name of the attribute to handle.
+	*/
+	registerAttribute(attribute: string): void;
+	/**
+	* Updates the document selection and the view according to the two–step caret movement state
+	* when moving **forwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
+	*
+	* @internal
+	* @param eventData Data of the key press.
+	* @returns `true` when the handler prevented caret movement.
+	*/
+	_handleForwardMovement(eventData?: ViewDocumentDomEventData): boolean;
+	/**
+	* Updates the document selection and the view according to the two–step caret movement state
+	* when moving **backwards**. Executed upon `keypress` in the {@link module:engine/view/view~EditingView}.
+	*
+	* @internal
+	* @param eventData Data of the key press.
+	* @returns `true` when the handler prevented caret movement
+	*/
+	_handleBackwardMovement(eventData?: ViewDocumentDomEventData): boolean;
+	/**
+	* Starts listening to {@link module:engine/view/document~ViewDocument#event:mousedown} and
+	* {@link module:engine/view/document~ViewDocument#event:selectionChange} and puts the selection before/after a 2-step node
+	* if clicked at the beginning/ending of the 2-step node.
+	*
+	* The purpose of this action is to allow typing around the 2-step node directly after a click.
+	*
+	* See https://github.com/ckeditor/ckeditor5/issues/1016.
+	*/
+	private _enableClickingAfterNode;
+	/**
+	* Starts listening to {@link module:engine/model/model~Model#event:insertContent} and corrects the model
+	* selection attributes if the selection is at the end of a two-step node after inserting the content.
+	*
+	* The purpose of this action is to improve the overall UX because the user is no longer "trapped" by the
+	* two-step attribute of the selection, and they can type a "clean" (`linkHref`–less) text right away.
+	*
+	* See https://github.com/ckeditor/ckeditor5/issues/6053.
+	*/
+	private _enableInsertContentSelectionAttributesFixer;
+	/**
+	* Starts listening to {@link module:engine/model/model~Model#deleteContent} and checks whether
+	* removing a content right after the tow-step attribute.
+	*
+	* If so, the selection should not preserve the two-step attribute. However, if
+	* the {@link module:typing/twostepcaretmovement~TwoStepCaretMovement} plugin is active and
+	* the selection has the two-step attribute due to overridden gravity (at the end), the two-step attribute should stay untouched.
+	*
+	* The purpose of this action is to allow removing the link text and keep the selection outside the link.
+	*
+	* See https://github.com/ckeditor/ckeditor5/issues/7521.
+	*/
+	private _handleDeleteContentAfterNode;
+	/**
+	* `true` when the gravity is overridden for the plugin.
+	*/
+	private get _isGravityOverridden();
+	/**
+	* Overrides the gravity using the {@link module:engine/model/writer~ModelWriter model writer}
+	* and stores the information about this fact in the {@link #_overrideUid}.
+	*
+	* A shorthand for {@link module:engine/model/writer~ModelWriter#overrideSelectionGravity}.
+	*/
+	private _overrideGravity;
+	/**
+	* Restores the gravity using the {@link module:engine/model/writer~ModelWriter model writer}.
+	*
+	* A shorthand for {@link module:engine/model/writer~ModelWriter#restoreSelectionGravity}.
+	*/
+	private _restoreGravity;
 }

package/dist/typing.d.ts

@@ -1,27 +1,27 @@
 /**
- * @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
- */
+* @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 typing/typing
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { Input } from './input.js';
-import { Delete } from './delete.js';
+* @module typing/typing
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Input } from "./input.js";
+import { Delete } from "./delete.js";
 /**
- * The typing feature. It handles typing.
- *
- * This is a "glue" plugin which loads the {@link module:typing/input~Input} and {@link module:typing/delete~Delete}
- * plugins.
- */
+* The typing feature. It handles typing.
+*
+* This is a "glue" plugin which loads the {@link module:typing/input~Input} and {@link module:typing/delete~Delete}
+* plugins.
+*/
 export declare class Typing extends Plugin {
-    static get requires(): readonly [typeof Input, typeof Delete];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Typing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	static get requires(): PluginDependenciesOf<[Input, Delete]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Typing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }