@ckeditor/ckeditor5-highlight 38.0.1 → 38.1.1

package/src/highlightediting.js

@@ -1,109 +1,109 @@
-/**
- * @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/highlightediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import HighlightCommand from './highlightcommand';
-/**
- * The highlight editing feature. It introduces the {@link module:highlight/highlightcommand~HighlightCommand command} and the `highlight`
- * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
- * as a `<mark>` element with a `class` attribute (`<mark class="marker-green">...</mark>`) depending
- * on the {@link module:highlight/highlightconfig~HighlightConfig configuration}.
- */
-export default class HighlightEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'HighlightEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define('highlight', {
-            options: [
-                {
-                    model: 'yellowMarker',
-                    class: 'marker-yellow',
-                    title: 'Yellow marker',
-                    color: 'var(--ck-highlight-marker-yellow)',
-                    type: 'marker'
-                },
-                {
-                    model: 'greenMarker',
-                    class: 'marker-green',
-                    title: 'Green marker',
-                    color: 'var(--ck-highlight-marker-green)',
-                    type: 'marker'
-                },
-                {
-                    model: 'pinkMarker',
-                    class: 'marker-pink',
-                    title: 'Pink marker',
-                    color: 'var(--ck-highlight-marker-pink)',
-                    type: 'marker'
-                },
-                {
-                    model: 'blueMarker',
-                    class: 'marker-blue',
-                    title: 'Blue marker',
-                    color: 'var(--ck-highlight-marker-blue)',
-                    type: 'marker'
-                },
-                {
-                    model: 'redPen',
-                    class: 'pen-red',
-                    title: 'Red pen',
-                    color: 'var(--ck-highlight-pen-red)',
-                    type: 'pen'
-                },
-                {
-                    model: 'greenPen',
-                    class: 'pen-green',
-                    title: 'Green pen',
-                    color: 'var(--ck-highlight-pen-green)',
-                    type: 'pen'
-                }
-            ]
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Allow highlight attribute on text nodes.
-        editor.model.schema.extend('$text', { allowAttributes: 'highlight' });
-        const options = editor.config.get('highlight.options');
-        // Set-up the two-way conversion.
-        editor.conversion.attributeToElement(_buildDefinition(options));
-        editor.commands.add('highlight', new HighlightCommand(editor));
-    }
-}
-/**
- * Converts the options array to a converter definition.
- *
- * @param options An array with configured options.
- */
-function _buildDefinition(options) {
-    const definition = {
-        model: {
-            key: 'highlight',
-            values: []
-        },
-        view: {}
-    };
-    for (const option of options) {
-        definition.model.values.push(option.model);
-        definition.view[option.model] = {
-            name: 'mark',
-            classes: option.class
-        };
-    }
-    return definition;
-}
+/**
+ * @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/highlightediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import HighlightCommand from './highlightcommand';
+/**
+ * The highlight editing feature. It introduces the {@link module:highlight/highlightcommand~HighlightCommand command} and the `highlight`
+ * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
+ * as a `<mark>` element with a `class` attribute (`<mark class="marker-green">...</mark>`) depending
+ * on the {@link module:highlight/highlightconfig~HighlightConfig configuration}.
+ */
+export default class HighlightEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HighlightEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define('highlight', {
+            options: [
+                {
+                    model: 'yellowMarker',
+                    class: 'marker-yellow',
+                    title: 'Yellow marker',
+                    color: 'var(--ck-highlight-marker-yellow)',
+                    type: 'marker'
+                },
+                {
+                    model: 'greenMarker',
+                    class: 'marker-green',
+                    title: 'Green marker',
+                    color: 'var(--ck-highlight-marker-green)',
+                    type: 'marker'
+                },
+                {
+                    model: 'pinkMarker',
+                    class: 'marker-pink',
+                    title: 'Pink marker',
+                    color: 'var(--ck-highlight-marker-pink)',
+                    type: 'marker'
+                },
+                {
+                    model: 'blueMarker',
+                    class: 'marker-blue',
+                    title: 'Blue marker',
+                    color: 'var(--ck-highlight-marker-blue)',
+                    type: 'marker'
+                },
+                {
+                    model: 'redPen',
+                    class: 'pen-red',
+                    title: 'Red pen',
+                    color: 'var(--ck-highlight-pen-red)',
+                    type: 'pen'
+                },
+                {
+                    model: 'greenPen',
+                    class: 'pen-green',
+                    title: 'Green pen',
+                    color: 'var(--ck-highlight-pen-green)',
+                    type: 'pen'
+                }
+            ]
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Allow highlight attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: 'highlight' });
+        const options = editor.config.get('highlight.options');
+        // Set-up the two-way conversion.
+        editor.conversion.attributeToElement(_buildDefinition(options));
+        editor.commands.add('highlight', new HighlightCommand(editor));
+    }
+}
+/**
+ * Converts the options array to a converter definition.
+ *
+ * @param options An array with configured options.
+ */
+function _buildDefinition(options) {
+    const definition = {
+        model: {
+            key: 'highlight',
+            values: []
+        },
+        view: {}
+    };
+    for (const option of options) {
+        definition.model.values.push(option.model);
+        definition.view[option.model] = {
+            name: 'mark',
+            classes: option.class
+        };
+    }
+    return definition;
+}

package/src/highlightui.d.ts

@@ -1,73 +1,73 @@
-/**
- * @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/highlightui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import './../theme/highlight.css';
-/**
- * The default highlight UI plugin. It introduces:
- *
- * * The `'highlight'` dropdown,
- * * The `'removeHighlight'` and `'highlight:*'` buttons.
- *
- * The default configuration includes the following buttons:
- *
- * * `'highlight:yellowMarker'`
- * * `'highlight:greenMarker'`
- * * `'highlight:pinkMarker'`
- * * `'highlight:blueMarker'`
- * * `'highlight:redPen'`
- * * `'highlight:greenPen'`
- *
- * See the {@link module:highlight/highlightconfig~HighlightConfig#options configuration} to learn more
- * about the defaults.
- */
-export default class HighlightUI extends Plugin {
-    /**
-     * Returns the localized option titles provided by the plugin.
-     *
-     * The following localized titles corresponding with default
-     * {@link module:highlight/highlightconfig~HighlightConfig#options} are available:
-     *
-     * * `'Yellow marker'`,
-     * * `'Green marker'`,
-     * * `'Pink marker'`,
-     * * `'Blue marker'`,
-     * * `'Red pen'`,
-     * * `'Green pen'`.
-     */
-    get localizedOptionTitles(): Record<string, string>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): 'HighlightUI';
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates the "Remove highlight" button.
-     */
-    private _addRemoveHighlightButton;
-    /**
-     * Creates a toolbar button from the provided highlight option.
-     */
-    private _addHighlighterButton;
-    /**
-     * Internal method for creating highlight buttons.
-     *
-     * @param name The name of the button.
-     * @param label The label for the button.
-     * @param icon The button icon.
-     * @param value The `value` property passed to the executed command.
-     * @param decorateButton A callback getting ButtonView instance so that it can be further customized.
-     */
-    private _addButton;
-    /**
-     * Creates the split button dropdown UI from the provided highlight options.
-     */
-    private _addDropdown;
-}
+/**
+ * @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/highlightui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import './../theme/highlight.css';
+/**
+ * The default highlight UI plugin. It introduces:
+ *
+ * * The `'highlight'` dropdown,
+ * * The `'removeHighlight'` and `'highlight:*'` buttons.
+ *
+ * The default configuration includes the following buttons:
+ *
+ * * `'highlight:yellowMarker'`
+ * * `'highlight:greenMarker'`
+ * * `'highlight:pinkMarker'`
+ * * `'highlight:blueMarker'`
+ * * `'highlight:redPen'`
+ * * `'highlight:greenPen'`
+ *
+ * See the {@link module:highlight/highlightconfig~HighlightConfig#options configuration} to learn more
+ * about the defaults.
+ */
+export default class HighlightUI extends Plugin {
+    /**
+     * Returns the localized option titles provided by the plugin.
+     *
+     * The following localized titles corresponding with default
+     * {@link module:highlight/highlightconfig~HighlightConfig#options} are available:
+     *
+     * * `'Yellow marker'`,
+     * * `'Green marker'`,
+     * * `'Pink marker'`,
+     * * `'Blue marker'`,
+     * * `'Red pen'`,
+     * * `'Green pen'`.
+     */
+    get localizedOptionTitles(): Record<string, string>;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "HighlightUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates the "Remove highlight" button.
+     */
+    private _addRemoveHighlightButton;
+    /**
+     * Creates a toolbar button from the provided highlight option.
+     */
+    private _addHighlighterButton;
+    /**
+     * Internal method for creating highlight buttons.
+     *
+     * @param name The name of the button.
+     * @param label The label for the button.
+     * @param icon The button icon.
+     * @param value The `value` property passed to the executed command.
+     * @param decorateButton A callback getting ButtonView instance so that it can be further customized.
+     */
+    private _addButton;
+    /**
+     * Creates the split button dropdown UI from the provided highlight options.
+     */
+    private _addDropdown;
+}