@ckeditor/ckeditor5-typing 40.0.0 → 40.2.0

package/src/utils/getlasttextline.d.ts

@@ -1,49 +1,49 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/utils/getlasttextline
- */
-import type { Model, Range } from '@ckeditor/ckeditor5-engine';
-/**
- * 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 default function getLastTextLine(range: Range, model: Model): LastTextLineData;
-/**
- * The value returned by {@link module:typing/utils/getlasttextline~getLastTextLine}.
- */
-export type LastTextLineData = {
-    /**
-     * The text from the text nodes in the last text line.
-     */
-    text: string;
-    /**
-     * The range set on the text nodes in the last text line.
-     */
-    range: Range;
-};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module typing/utils/getlasttextline
+ */
+import type { Model, Range } from '@ckeditor/ckeditor5-engine';
+/**
+ * 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 default function getLastTextLine(range: Range, model: Model): LastTextLineData;
+/**
+ * The value returned by {@link module:typing/utils/getlasttextline~getLastTextLine}.
+ */
+export type LastTextLineData = {
+    /**
+     * The text from the text nodes in the last text line.
+     */
+    text: string;
+    /**
+     * The range set on the text nodes in the last text line.
+     */
+    range: Range;
+};

package/src/utils/getlasttextline.js

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

@@ -1,33 +1,33 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-/**
- * 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 default function inlineHighlight(editor: Editor, attributeName: string, tagName: string, className: string): void;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Editor } from '@ckeditor/ckeditor5-core';
+/**
+ * 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 default function inlineHighlight(editor: Editor, attributeName: string, tagName: string, className: string): void;

package/src/utils/inlinehighlight.js

@@ -1,74 +1,74 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/utils/inlinehighlight
- */
-import findAttributeRange from './findattributerange';
-/**
- * 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 default 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);
-                }
-            });
-        }
-    });
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module typing/utils/inlinehighlight
+ */
+import findAttributeRange from './findattributerange';
+/**
+ * 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 default 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);
+                }
+            });
+        }
+    });
+}