@ckeditor/ckeditor5-highlight 40.0.0 → 40.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 highlight feature** – https://github.com/ckeditor/ckeditor5-highlight <br>
-Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003–2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -14,4 +14,4 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-highlight",
-  "version": "40.0.0",
+  "version": "40.1.0",
   "description": "Highlight feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "40.0.0"
+    "ckeditor5": "40.1.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/augmentation.d.ts

@@ -1,23 +1,23 @@
-/**
- * @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 { Highlight, HighlightCommand, HighlightConfig, HighlightEditing, HighlightUI } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:highlight/highlight~Highlight} feature.
-         *
-         * Read more in {@link module:highlight/highlightconfig~HighlightConfig}.
-         */
-        highlight?: HighlightConfig;
-    }
-    interface PluginsMap {
-        [Highlight.pluginName]: Highlight;
-        [HighlightEditing.pluginName]: HighlightEditing;
-        [HighlightUI.pluginName]: HighlightUI;
-    }
-    interface CommandsMap {
-        highlight: HighlightCommand;
-    }
-}
+/**
+ * @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 { Highlight, HighlightCommand, HighlightConfig, HighlightEditing, HighlightUI } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:highlight/highlight~Highlight} feature.
+         *
+         * Read more in {@link module:highlight/highlightconfig~HighlightConfig}.
+         */
+        highlight?: HighlightConfig;
+    }
+    interface PluginsMap {
+        [Highlight.pluginName]: Highlight;
+        [HighlightEditing.pluginName]: HighlightEditing;
+        [HighlightUI.pluginName]: HighlightUI;
+    }
+    interface CommandsMap {
+        highlight: HighlightCommand;
+    }
+}

package/src/augmentation.js

@@ -1,5 +1,5 @@
-/**
- * @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
- */
-export {};
+/**
+ * @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
+ */
+export {};

package/src/highlight.d.ts

@@ -1,28 +1,28 @@
-/**
- * @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 highlight/highlight
- */
-import { Plugin } from 'ckeditor5/src/core';
-import HighlightEditing from './highlightediting';
-import HighlightUI from './highlightui';
-/**
- * The highlight plugin.
- *
- * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
- *
- * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
- * {@link module:highlight/highlightui~HighlightUI} plugins.
- */
-export default class Highlight extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof HighlightEditing, typeof HighlightUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Highlight";
-}
+/**
+ * @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 highlight/highlight
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import HighlightEditing from './highlightediting';
+import HighlightUI from './highlightui';
+/**
+ * The highlight plugin.
+ *
+ * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
+ *
+ * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
+ * {@link module:highlight/highlightui~HighlightUI} plugins.
+ */
+export default class Highlight extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof HighlightEditing, typeof HighlightUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Highlight";
+}

package/src/highlight.js

@@ -1,32 +1,32 @@
-/**
- * @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 highlight/highlight
- */
-import { Plugin } from 'ckeditor5/src/core';
-import HighlightEditing from './highlightediting';
-import HighlightUI from './highlightui';
-/**
- * The highlight plugin.
- *
- * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
- *
- * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
- * {@link module:highlight/highlightui~HighlightUI} plugins.
- */
-export default class Highlight extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [HighlightEditing, HighlightUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Highlight';
-    }
-}
+/**
+ * @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 highlight/highlight
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import HighlightEditing from './highlightediting';
+import HighlightUI from './highlightui';
+/**
+ * The highlight plugin.
+ *
+ * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
+ *
+ * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
+ * {@link module:highlight/highlightui~HighlightUI} plugins.
+ */
+export default class Highlight extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [HighlightEditing, HighlightUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Highlight';
+    }
+}

package/src/highlightcommand.d.ts

@@ -1,45 +1,45 @@
-/**
- * @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 highlight/highlightcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
- * to apply the text highlighting.
- *
- * ```ts
- * editor.execute( 'highlight', { value: 'greenMarker' } );
- * ```
- *
- * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
- * inside a text with the highlight attribute, the command will remove the attribute from the entire range
- * of that text.
- */
-export default class HighlightCommand extends Command {
-    /**
-     * A value indicating whether the command is active. If the selection has some highlight attribute,
-     * it corresponds to the value of that attribute.
-     *
-     * @observable
-     * @readonly
-     */
-    value: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     *
-     * @fires execute
-     */
-    execute(options?: {
-        value?: string | null;
-    }): 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
+ */
+/**
+ * @module highlight/highlightcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
+ * to apply the text highlighting.
+ *
+ * ```ts
+ * editor.execute( 'highlight', { value: 'greenMarker' } );
+ * ```
+ *
+ * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
+ * inside a text with the highlight attribute, the command will remove the attribute from the entire range
+ * of that text.
+ */
+export default class HighlightCommand extends Command {
+    /**
+     * A value indicating whether the command is active. If the selection has some highlight attribute,
+     * it corresponds to the value of that attribute.
+     *
+     * @observable
+     * @readonly
+     */
+    value: string | undefined;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     *
+     * @fires execute
+     */
+    execute(options?: {
+        value?: string | null;
+    }): void;
+}

package/src/highlightcommand.js

@@ -1,91 +1,91 @@
-/**
- * @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 highlight/highlightcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
- * to apply the text highlighting.
- *
- * ```ts
- * editor.execute( 'highlight', { value: 'greenMarker' } );
- * ```
- *
- * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
- * inside a text with the highlight attribute, the command will remove the attribute from the entire range
- * of that text.
- */
-export default class HighlightCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const doc = model.document;
-        this.value = doc.selection.getAttribute('highlight');
-        this.isEnabled = model.schema.checkAttributeInSelection(doc.selection, 'highlight');
-    }
-    /**
-     * Executes the command.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     *
-     * @fires execute
-     */
-    execute(options = {}) {
-        const model = this.editor.model;
-        const document = model.document;
-        const selection = document.selection;
-        const highlighter = options.value;
-        model.change(writer => {
-            if (selection.isCollapsed) {
-                const position = selection.getFirstPosition();
-                // When selection is inside text with `highlight` attribute.
-                if (selection.hasAttribute('highlight')) {
-                    // Find the full highlighted range.
-                    const isSameHighlight = (value) => {
-                        return value.item.hasAttribute('highlight') && value.item.getAttribute('highlight') === this.value;
-                    };
-                    const highlightStart = position.getLastMatchingPosition(isSameHighlight, { direction: 'backward' });
-                    const highlightEnd = position.getLastMatchingPosition(isSameHighlight);
-                    const highlightRange = writer.createRange(highlightStart, highlightEnd);
-                    // Then depending on current value...
-                    if (!highlighter || this.value === highlighter) {
-                        // ...remove attribute when passing highlighter different then current or executing "eraser".
-                        // If we're at the end of the highlighted range, we don't want to remove highlight of the range.
-                        if (!position.isEqual(highlightEnd)) {
-                            writer.removeAttribute('highlight', highlightRange);
-                        }
-                        writer.removeSelectionAttribute('highlight');
-                    }
-                    else {
-                        // ...update `highlight` value.
-                        // If we're at the end of the highlighted range, we don't want to change the highlight of the range.
-                        if (!position.isEqual(highlightEnd)) {
-                            writer.setAttribute('highlight', highlighter, highlightRange);
-                        }
-                        writer.setSelectionAttribute('highlight', highlighter);
-                    }
-                }
-                else if (highlighter) {
-                    writer.setSelectionAttribute('highlight', highlighter);
-                }
-            }
-            else {
-                const ranges = model.schema.getValidRanges(selection.getRanges(), 'highlight');
-                for (const range of ranges) {
-                    if (highlighter) {
-                        writer.setAttribute('highlight', highlighter, range);
-                    }
-                    else {
-                        writer.removeAttribute('highlight', 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 highlight/highlightcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The highlight command. It is used by the {@link module:highlight/highlightediting~HighlightEditing highlight feature}
+ * to apply the text highlighting.
+ *
+ * ```ts
+ * editor.execute( 'highlight', { value: 'greenMarker' } );
+ * ```
+ *
+ * **Note**: Executing the command without a value removes the attribute from the model. If the selection is collapsed
+ * inside a text with the highlight attribute, the command will remove the attribute from the entire range
+ * of that text.
+ */
+export default class HighlightCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        const doc = model.document;
+        this.value = doc.selection.getAttribute('highlight');
+        this.isEnabled = model.schema.checkAttributeInSelection(doc.selection, 'highlight');
+    }
+    /**
+     * Executes the command.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     *
+     * @fires execute
+     */
+    execute(options = {}) {
+        const model = this.editor.model;
+        const document = model.document;
+        const selection = document.selection;
+        const highlighter = options.value;
+        model.change(writer => {
+            if (selection.isCollapsed) {
+                const position = selection.getFirstPosition();
+                // When selection is inside text with `highlight` attribute.
+                if (selection.hasAttribute('highlight')) {
+                    // Find the full highlighted range.
+                    const isSameHighlight = (value) => {
+                        return value.item.hasAttribute('highlight') && value.item.getAttribute('highlight') === this.value;
+                    };
+                    const highlightStart = position.getLastMatchingPosition(isSameHighlight, { direction: 'backward' });
+                    const highlightEnd = position.getLastMatchingPosition(isSameHighlight);
+                    const highlightRange = writer.createRange(highlightStart, highlightEnd);
+                    // Then depending on current value...
+                    if (!highlighter || this.value === highlighter) {
+                        // ...remove attribute when passing highlighter different then current or executing "eraser".
+                        // If we're at the end of the highlighted range, we don't want to remove highlight of the range.
+                        if (!position.isEqual(highlightEnd)) {
+                            writer.removeAttribute('highlight', highlightRange);
+                        }
+                        writer.removeSelectionAttribute('highlight');
+                    }
+                    else {
+                        // ...update `highlight` value.
+                        // If we're at the end of the highlighted range, we don't want to change the highlight of the range.
+                        if (!position.isEqual(highlightEnd)) {
+                            writer.setAttribute('highlight', highlighter, highlightRange);
+                        }
+                        writer.setSelectionAttribute('highlight', highlighter);
+                    }
+                }
+                else if (highlighter) {
+                    writer.setSelectionAttribute('highlight', highlighter);
+                }
+            }
+            else {
+                const ranges = model.schema.getValidRanges(selection.getRanges(), 'highlight');
+                for (const range of ranges) {
+                    if (highlighter) {
+                        writer.setAttribute('highlight', highlighter, range);
+                    }
+                    else {
+                        writer.removeAttribute('highlight', range);
+                    }
+                }
+            }
+        });
+    }
+}