@ckeditor/ckeditor5-highlight 0.0.0-internal-20241017.0

package/src/highlightediting.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, 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, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * 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(): "HighlightEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/highlightediting.js

@@ -0,0 +1,115 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import HighlightCommand from './highlightcommand.js';
+/**
+ * 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
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @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

@@ -0,0 +1,81 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+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
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @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;
+    /**
+     * Creates the menu bar button for highlight including submenu with available options.
+     */
+    private _addMenuBarButton;
+}

package/src/highlightui.js

@@ -0,0 +1,277 @@
+/**
+ * @license Copyright (c) 2003-2024, 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, icons } from 'ckeditor5/src/core.js';
+import { addToolbarToDropdown, createDropdown, ButtonView, ListSeparatorView, MenuBarMenuView, MenuBarMenuListView, MenuBarMenuListItemView, MenuBarMenuListItemButtonView, SplitButtonView, ToolbarSeparatorView } from 'ckeditor5/src/ui.js';
+import markerIcon from './../theme/icons/marker.svg';
+import penIcon from './../theme/icons/pen.svg';
+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() {
+        const t = this.editor.t;
+        return {
+            'Yellow marker': t('Yellow marker'),
+            'Green marker': t('Green marker'),
+            'Pink marker': t('Pink marker'),
+            'Blue marker': t('Blue marker'),
+            'Red pen': t('Red pen'),
+            'Green pen': t('Green pen')
+        };
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'HighlightUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const options = this.editor.config.get('highlight.options');
+        for (const option of options) {
+            this._addHighlighterButton(option);
+        }
+        this._addRemoveHighlightButton();
+        this._addDropdown(options);
+        this._addMenuBarButton(options);
+    }
+    /**
+     * Creates the "Remove highlight" button.
+     */
+    _addRemoveHighlightButton() {
+        const t = this.editor.t;
+        const command = this.editor.commands.get('highlight');
+        this._addButton('removeHighlight', t('Remove highlight'), icons.eraser, null, button => {
+            button.bind('isEnabled').to(command, 'isEnabled');
+        });
+    }
+    /**
+     * Creates a toolbar button from the provided highlight option.
+     */
+    _addHighlighterButton(option) {
+        const command = this.editor.commands.get('highlight');
+        // TODO: change naming
+        this._addButton('highlight:' + option.model, option.title, getIconForType(option.type), option.model, decorateHighlightButton);
+        function decorateHighlightButton(button) {
+            button.bind('isEnabled').to(command, 'isEnabled');
+            button.bind('isOn').to(command, 'value', value => value === option.model);
+            button.iconView.fillColor = option.color;
+            button.isToggleable = true;
+        }
+    }
+    /**
+     * 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.
+     */
+    _addButton(name, label, icon, value, decorateButton) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(name, locale => {
+            const buttonView = new ButtonView(locale);
+            const localized = this.localizedOptionTitles[label] ? this.localizedOptionTitles[label] : label;
+            buttonView.set({
+                label: localized,
+                icon,
+                tooltip: true
+            });
+            buttonView.on('execute', () => {
+                editor.execute('highlight', { value });
+                editor.editing.view.focus();
+            });
+            // Add additional behavior for buttonView.
+            decorateButton(buttonView);
+            return buttonView;
+        });
+    }
+    /**
+     * Creates the split button dropdown UI from the provided highlight options.
+     */
+    _addDropdown(options) {
+        const editor = this.editor;
+        const t = editor.t;
+        const componentFactory = editor.ui.componentFactory;
+        const startingHighlighter = options[0];
+        const optionsMap = options.reduce((retVal, option) => {
+            retVal[option.model] = option;
+            return retVal;
+        }, {});
+        componentFactory.add('highlight', locale => {
+            const command = editor.commands.get('highlight');
+            const dropdownView = createDropdown(locale, SplitButtonView);
+            const splitButtonView = dropdownView.buttonView;
+            splitButtonView.set({
+                label: t('Highlight'),
+                tooltip: true,
+                // Holds last executed highlighter.
+                lastExecuted: startingHighlighter.model,
+                // Holds current highlighter to execute (might be different then last used).
+                commandValue: startingHighlighter.model,
+                isToggleable: true
+            });
+            // Dropdown button changes to selection (command.value):
+            // - If selection is in highlight it get active highlight appearance (icon, color) and is activated.
+            // - Otherwise it gets appearance (icon, color) of last executed highlight.
+            splitButtonView.bind('icon').to(command, 'value', value => getIconForType(getActiveOption(value, 'type')));
+            splitButtonView.bind('color').to(command, 'value', value => getActiveOption(value, 'color'));
+            splitButtonView.bind('commandValue').to(command, 'value', value => getActiveOption(value, 'model'));
+            splitButtonView.bind('isOn').to(command, 'value', value => !!value);
+            splitButtonView.delegate('execute').to(dropdownView);
+            // Create buttons array.
+            const buttonsCreator = () => {
+                const buttons = options.map(option => {
+                    // Get existing highlighter button.
+                    const buttonView = componentFactory.create('highlight:' + option.model);
+                    // Update lastExecutedHighlight on execute.
+                    this.listenTo(buttonView, 'execute', () => {
+                        dropdownView.buttonView.set({ lastExecuted: option.model });
+                    });
+                    return buttonView;
+                });
+                // Add separator and eraser buttons to dropdown.
+                buttons.push(new ToolbarSeparatorView());
+                buttons.push(componentFactory.create('removeHighlight'));
+                return buttons;
+            };
+            // Make toolbar button enabled when any button in dropdown is enabled before adding separator and eraser.
+            dropdownView.bind('isEnabled').to(command, 'isEnabled');
+            addToolbarToDropdown(dropdownView, buttonsCreator, {
+                enableActiveItemFocusOnDropdownOpen: true,
+                ariaLabel: t('Text highlight toolbar')
+            });
+            bindToolbarIconStyleToActiveColor(dropdownView);
+            // Execute current action from dropdown's split button action button.
+            splitButtonView.on('execute', () => {
+                editor.execute('highlight', { value: splitButtonView.commandValue });
+            });
+            // Focus the editable after executing the command.
+            // It overrides a default behaviour where the focus is moved to the dropdown button (#12125).
+            this.listenTo(dropdownView, 'execute', () => {
+                editor.editing.view.focus();
+            });
+            /**
+             * Returns active highlighter option depending on current command value.
+             * If current is not set or it is the same as last execute this method will return the option key (like icon or color)
+             * of last executed highlighter. Otherwise it will return option key for current one.
+             */
+            function getActiveOption(current, key) {
+                const whichHighlighter = !current ||
+                    current === splitButtonView.lastExecuted ? splitButtonView.lastExecuted : current;
+                return optionsMap[whichHighlighter][key];
+            }
+            return dropdownView;
+        });
+    }
+    /**
+     * Creates the menu bar button for highlight including submenu with available options.
+     */
+    _addMenuBarButton(options) {
+        const editor = this.editor;
+        const t = editor.t;
+        const command = editor.commands.get('highlight');
+        editor.ui.componentFactory.add('menuBar:highlight', locale => {
+            const menuView = new MenuBarMenuView(locale);
+            menuView.buttonView.set({
+                label: t('Highlight'),
+                icon: getIconForType('marker')
+            });
+            menuView.bind('isEnabled').to(command);
+            menuView.buttonView.iconView.fillColor = 'transparent';
+            const listView = new MenuBarMenuListView(locale);
+            for (const option of options) {
+                const listItemView = new MenuBarMenuListItemView(locale, menuView);
+                const buttonView = new MenuBarMenuListItemButtonView(locale);
+                buttonView.set({
+                    label: option.title,
+                    icon: getIconForType(option.type),
+                    role: 'menuitemradio',
+                    isToggleable: true
+                });
+                buttonView.iconView.fillColor = option.color;
+                buttonView.delegate('execute').to(menuView);
+                buttonView.bind('isOn').to(command, 'value', value => value === option.model);
+                buttonView.on('execute', () => {
+                    editor.execute('highlight', { value: option.model });
+                    editor.editing.view.focus();
+                });
+                listItemView.children.add(buttonView);
+                listView.items.add(listItemView);
+            }
+            // Add remove highlight button
+            listView.items.add(new ListSeparatorView(locale));
+            const listItemView = new MenuBarMenuListItemView(locale, menuView);
+            const buttonView = new MenuBarMenuListItemButtonView(locale);
+            buttonView.set({
+                label: t('Remove highlight'),
+                icon: icons.eraser
+            });
+            buttonView.delegate('execute').to(menuView);
+            buttonView.on('execute', () => {
+                editor.execute('highlight', { value: null });
+                editor.editing.view.focus();
+            });
+            listItemView.children.add(buttonView);
+            listView.items.add(listItemView);
+            menuView.panelView.children.add(listView);
+            return menuView;
+        });
+    }
+}
+/**
+ * Extends split button icon style to reflect last used button style.
+ */
+function bindToolbarIconStyleToActiveColor(dropdownView) {
+    const actionView = dropdownView.buttonView.actionView;
+    actionView.iconView.bind('fillColor').to(dropdownView.buttonView, 'color');
+}
+/**
+ * Returns icon for given highlighter type.
+ */
+function getIconForType(type) {
+    return type === 'marker' ? markerIcon : penIcon;
+}

package/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module highlight
+ */
+export { default as Highlight } from './highlight.js';
+export { default as HighlightEditing } from './highlightediting.js';
+export { default as HighlightUI } from './highlightui.js';
+export type { default as HighlightCommand } from './highlightcommand.js';
+export type { HighlightOption, HighlightConfig } from './highlightconfig.js';
+import './augmentation.js';

package/src/index.js

@@ -0,0 +1,11 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module highlight
+ */
+export { default as Highlight } from './highlight.js';
+export { default as HighlightEditing } from './highlightediting.js';
+export { default as HighlightUI } from './highlightui.js';
+import './augmentation.js';

package/theme/highlight.css

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+:root {
+	--ck-highlight-marker-yellow: hsl(60, 97%, 73%);
+	--ck-highlight-marker-green: hsl(120, 93%, 68%);
+	--ck-highlight-marker-pink: hsl(345, 96%, 73%);
+	--ck-highlight-marker-blue: hsl(201, 97%, 72%);
+	--ck-highlight-pen-red: hsl(0, 85%, 49%);
+	--ck-highlight-pen-green: hsl(112, 100%, 27%);
+}
+
+@define-mixin highlight-marker-color $color {
+	.ck-content .marker-$color {
+		background-color: var(--ck-highlight-marker-$color);
+	}
+}
+
+@define-mixin highlight-pen-color $color {
+	.ck-content .pen-$color {
+		color: var(--ck-highlight-pen-$color);
+
+		/* Override default yellow background of `<mark>` from user agent stylesheet */
+		background-color: transparent;
+	}
+}
+
+@mixin highlight-marker-color yellow;
+@mixin highlight-marker-color green;
+@mixin highlight-marker-color pink;
+@mixin highlight-marker-color blue;
+
+@mixin highlight-pen-color red;
+@mixin highlight-pen-color green;

package/theme/icons/marker.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.798 1.59 3.002 12.875l1.895 1.852 2.521 1.402 6.997-12.194z"/><path d="m2.556 16.727.234-.348c-.297-.151-.462-.293-.498-.426-.036-.137.002-.416.115-.837.094-.25.15-.449.169-.595a4.495 4.495 0 0 0 0-.725c-.209-.621-.303-1.041-.284-1.26.02-.218.178-.506.475-.862l6.77-9.414c.539-.91 1.605-.85 3.199.18 1.594 1.032 2.188 1.928 1.784 2.686l-5.877 10.36c-.158.412-.333.673-.526.782-.193.108-.604.179-1.232.21-.362.131-.608.237-.738.318-.13.081-.305.238-.526.47-.293.265-.504.397-.632.397-.096 0-.27-.075-.524-.226l-.31.41-1.6-1.12zm-.279.415 1.575 1.103-.392.515H1.19l1.087-1.618zm8.1-13.656-4.953 6.9L8.75 12.57l4.247-7.574c.175-.25-.188-.647-1.092-1.192-.903-.546-1.412-.652-1.528-.32zM8.244 18.5 9.59 17h9.406v1.5H8.245z"/></svg>

package/theme/icons/pen.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path class="ck-icon__fill" d="M10.126 2.268 2.002 13.874l1.895 1.852 2.521 1.402L14.47 5.481l-1.543-2.568-2.801-.645z"/><path d="m4.5 18.088-2.645-1.852-.04-2.95-.006-.005.006-.008v-.025l.011.008L8.73 2.97c.165-.233.356-.417.567-.557l-1.212.308L4.604 7.9l-.83-.558 3.694-5.495 2.708-.69 1.65 1.145.046.018.85-1.216 2.16 1.512-.856 1.222c.828.967 1.144 2.141.432 3.158L7.55 17.286l.006.005-3.055.797H4.5zm-.634.166-1.976.516-.026-1.918 2.002 1.402zM9.968 3.817l-.006-.004-6.123 9.184 3.277 2.294 6.108-9.162.005.003c.317-.452-.16-1.332-1.064-1.966-.891-.624-1.865-.776-2.197-.349zM8.245 18.5 9.59 17h9.406v1.5H8.245z"/></svg>