@ckeditor/ckeditor5-typing 47.6.1 → 48.0.0-alpha.0

package/src/typingconfig.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/utils/changebuffer.js

@@ -1,148 +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
- */
-/**
- * Change buffer allows to group atomic changes (like characters that have been typed) into
- * {@link module:engine/model/batch~Batch batches}.
- *
- * Batches represent single undo steps, hence changes added to one single batch are undone together.
- *
- * The buffer has a configurable limit of atomic changes that it can accommodate. After the limit was
- * exceeded (see {@link ~TypingChangeBuffer#input}), a new batch is created in {@link ~TypingChangeBuffer#batch}.
- *
- * To use the change buffer you need to let it know about the number of changes that were added to the batch:
- *
- * ```ts
- * const buffer = new ChangeBuffer( model, LIMIT );
- *
- * // Later on in your feature:
- * buffer.batch.insert( pos, insertedCharacters );
- * buffer.input( insertedCharacters.length );
- * ```
- */
-export class TypingChangeBuffer {
-    /**
-     * The model instance.
-     */
-    model;
-    /**
-     * The maximum number of atomic changes which can be contained in one batch.
-     */
-    limit;
-    /**
-     * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
-     */
-    _isLocked;
-    /**
-     * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
-     * the {@link #batch batch} is set to a new one.
-     */
-    _size;
-    /**
-     * The current batch instance.
-     */
-    _batch = null;
-    /**
-     * The callback to document the change event which later needs to be removed.
-     */
-    _changeCallback;
-    /**
-     * The callback to document selection `change:attribute` and `change:range` events which resets the buffer.
-     */
-    _selectionChangeCallback;
-    /**
-     * Creates a new instance of the change buffer.
-     *
-     * @param limit The maximum number of atomic changes which can be contained in one batch.
-     */
-    constructor(model, limit = 20) {
-        this.model = model;
-        this._size = 0;
-        this.limit = limit;
-        this._isLocked = false;
-        // The function to be called in order to notify the buffer about batches which appeared in the document.
-        // The callback will check whether it is a new batch and in that case the buffer will be flushed.
-        //
-        // The reason why the buffer needs to be flushed whenever a new batch appears is that the changes added afterwards
-        // should be added to a new batch. For instance, when the user types, then inserts an image, and then types again,
-        // the characters typed after inserting the image should be added to a different batch than the characters typed before.
-        this._changeCallback = (evt, batch) => {
-            if (batch.isLocal && batch.isUndoable && batch !== this._batch) {
-                this._reset(true);
-            }
-        };
-        this._selectionChangeCallback = () => {
-            this._reset();
-        };
-        this.model.document.on('change', this._changeCallback);
-        this.model.document.selection.on('change:range', this._selectionChangeCallback);
-        this.model.document.selection.on('change:attribute', this._selectionChangeCallback);
-    }
-    /**
-     * The current batch to which a feature should add its operations. Once the {@link #size}
-     * is reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-     */
-    get batch() {
-        if (!this._batch) {
-            this._batch = this.model.createBatch({ isTyping: true });
-        }
-        return this._batch;
-    }
-    /**
-     * The number of atomic changes in the buffer. Once it exceeds the {@link #limit},
-     * the {@link #batch batch} is set to a new one.
-     */
-    get size() {
-        return this._size;
-    }
-    /**
-     * The input number of changes into the buffer. Once the {@link #size} is
-     * reached or exceeds the {@link #limit}, the batch is set to a new instance and the size is reset.
-     *
-     * @param changeCount The number of atomic changes to input.
-     */
-    input(changeCount) {
-        this._size += changeCount;
-        if (this._size >= this.limit) {
-            this._reset(true);
-        }
-    }
-    /**
-     * Whether the buffer is locked. A locked buffer cannot be reset unless it gets unlocked.
-     */
-    get isLocked() {
-        return this._isLocked;
-    }
-    /**
-     * Locks the buffer.
-     */
-    lock() {
-        this._isLocked = true;
-    }
-    /**
-     * Unlocks the buffer.
-     */
-    unlock() {
-        this._isLocked = false;
-    }
-    /**
-     * Destroys the buffer.
-     */
-    destroy() {
-        this.model.document.off('change', this._changeCallback);
-        this.model.document.selection.off('change:range', this._selectionChangeCallback);
-        this.model.document.selection.off('change:attribute', this._selectionChangeCallback);
-    }
-    /**
-     * Resets the change buffer.
-     *
-     * @param ignoreLock Whether internal lock {@link #isLocked} should be ignored.
-     */
-    _reset(ignoreLock = false) {
-        if (!this.isLocked || ignoreLock) {
-            this._batch = null;
-            this._size = 0;
-        }
-    }
-}

package/src/utils/findattributerange.js

@@ -1,41 +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
- */
-/**
- * Returns a model range that covers all consecutive nodes with the same `attributeName` and its `value`
- * that intersect the given `position`.
- *
- * It can be used e.g. to get the entire range on which the `linkHref` attribute needs to be changed when having a
- * selection inside a link.
- *
- * @param position The start position.
- * @param attributeName The attribute name.
- * @param value The attribute value.
- * @param model The model instance.
- * @returns The link range.
- */
-export function findAttributeRange(position, attributeName, value, model) {
-    return model.createRange(findAttributeRangeBound(position, attributeName, value, true, model), findAttributeRangeBound(position, attributeName, value, false, model));
-}
-/**
- * Walks forward or backward (depends on the `lookBack` flag), node by node, as long as they have the same attribute value
- * and returns a position just before or after (depends on the `lookBack` flag) the last matched node.
- *
- * @param position The start position.
- * @param attributeName The attribute name.
- * @param value The attribute value.
- * @param lookBack Whether the walk direction is forward (`false`) or backward (`true`).
- * @returns The position just before the last matched node.
- */
-export function findAttributeRangeBound(position, attributeName, value, lookBack, model) {
-    // Get node before or after position (depends on `lookBack` flag).
-    // When position is inside text node then start searching from text node.
-    let node = position.textNode || (lookBack ? position.nodeBefore : position.nodeAfter);
-    let lastNode = null;
-    while (node && node.getAttribute(attributeName) == value) {
-        lastNode = node;
-        node = lookBack ? node.previousSibling : node.nextSibling;
-    }
-    return lastNode ? model.createPositionAt(lastNode, lookBack ? 'before' : 'after') : position;
-}

package/src/utils/getlasttextline.js

@@ -1,43 +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
- */
-/**
- * Returns the last text line from the given range.
- *
- * "The last text line" is understood as text (from one or more text nodes) which is limited either by a parent block
- * or by inline elements (e.g. `<softBreak>`).
- *
- * ```ts
- * const rangeToCheck = model.createRange(
- * 	model.createPositionAt( paragraph, 0 ),
- * 	model.createPositionAt( paragraph, 'end' )
- * );
- *
- * const { text, range } = getLastTextLine( rangeToCheck, model );
- * ```
- *
- * For model below, the returned `text` will be "Foo bar baz" and `range` will be set on whole `<paragraph>` content:
- *
- * ```xml
- * <paragraph>Foo bar baz<paragraph>
- * ```
- *
- * However, in below case, `text` will be set to "baz" and `range` will be set only on "baz".
- *
- * ```xml
- * <paragraph>Foo<softBreak></softBreak>bar<softBreak></softBreak>baz<paragraph>
- * ```
- */
-export function getLastTextLine(range, model) {
-    let start = range.start;
-    const text = Array.from(range.getWalker({ ignoreElementEnd: false })).reduce((rangeText, { item }) => {
-        // Trim text to a last occurrence of an inline element and update range start.
-        if (!(item.is('$text') || item.is('$textProxy'))) {
-            start = model.createPositionAfter(item);
-            return '';
-        }
-        return rangeText + item.data;
-    }, '');
-    return { text, range: model.createRange(start, range.end) };
-}

package/src/utils/inlinehighlight.js

@@ -1,74 +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 typing/utils/inlinehighlight
- */
-import { findAttributeRange } from './findattributerange.js';
-/**
- * Adds a visual highlight style to an attribute element in which the selection is anchored.
- * Together with two-step caret movement, they indicate that the user is typing inside the element.
- *
- * Highlight is turned on by adding the given class to the attribute element in the view:
- *
- * * The class is removed before the conversion has started, as callbacks added with the `'highest'` priority
- * to {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher} events.
- * * The class is added in the view post fixer, after other changes in the model tree were converted to the view.
- *
- * This way, adding and removing the highlight does not interfere with conversion.
- *
- * Usage:
- *
- * ```ts
- * import { inlineHighlight } from '@ckeditor/ckeditor5-typing/src/utils/inlinehighlight';
- *
- * // Make `ck-link_selected` class be applied on an `a` element
- * // whenever the corresponding `linkHref` attribute element is selected.
- * inlineHighlight( editor, 'linkHref', 'a', 'ck-link_selected' );
- * ```
- *
- * @param editor The editor instance.
- * @param attributeName The attribute name to check.
- * @param tagName The tagName of a view item.
- * @param className The class name to apply in the view.
- */
-export function inlineHighlight(editor, attributeName, tagName, className) {
-    const view = editor.editing.view;
-    const highlightedElements = new Set();
-    // Adding the class.
-    view.document.registerPostFixer(writer => {
-        const selection = editor.model.document.selection;
-        let changed = false;
-        if (selection.hasAttribute(attributeName)) {
-            const modelRange = findAttributeRange(selection.getFirstPosition(), attributeName, selection.getAttribute(attributeName), editor.model);
-            const viewRange = editor.editing.mapper.toViewRange(modelRange);
-            // There might be multiple view elements in the `viewRange`, for example, when the `a` element is
-            // broken by a UIElement.
-            for (const item of viewRange.getItems()) {
-                if (item.is('element', tagName) && !item.hasClass(className)) {
-                    writer.addClass(className, item);
-                    highlightedElements.add(item);
-                    changed = true;
-                }
-            }
-        }
-        return changed;
-    });
-    // Removing the class.
-    editor.conversion.for('editingDowncast').add(dispatcher => {
-        // Make sure the highlight is removed on every possible event, before conversion is started.
-        dispatcher.on('insert', removeHighlight, { priority: 'highest' });
-        dispatcher.on('remove', removeHighlight, { priority: 'highest' });
-        dispatcher.on('attribute', removeHighlight, { priority: 'highest' });
-        dispatcher.on('selection', removeHighlight, { priority: 'highest' });
-        function removeHighlight() {
-            view.change(writer => {
-                for (const item of highlightedElements.values()) {
-                    writer.removeClass(className, item);
-                    highlightedElements.delete(item);
-                }
-            });
-        }
-    });
-}