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

package/lang/translations/zh-cn.po

@@ -1,48 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: zh_CN\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Toolbar button tooltip for applying yellow marker (text highlight)."
-msgid "Yellow marker"
-msgstr "黄色标记"
-
-msgctxt "Toolbar button tooltip for applying green marker (text highlight)."
-msgid "Green marker"
-msgstr "绿色标记"
-
-msgctxt "Toolbar button tooltip for applying pink marker (text highlight)."
-msgid "Pink marker"
-msgstr "粉色标记"
-
-msgctxt "Toolbar button tooltip for applying blue marker (text highlight)."
-msgid "Blue marker"
-msgstr "蓝色标记"
-
-msgctxt "Toolbar button tooltip for applying red pen (text color)."
-msgid "Red pen"
-msgstr "红色笔"
-
-msgctxt "Toolbar button tooltip for applying green pen (text color)."
-msgid "Green pen"
-msgstr "绿色笔"
-
-msgctxt "Toolbar button tooltip for removing text highlight."
-msgid "Remove highlight"
-msgstr "清除高亮"
-
-msgctxt "Toolbar button tooltip for the text highlight feature."
-msgid "Highlight"
-msgstr "高亮"
-
-msgctxt "Label used by assistive technologies describing the highlight feature toolbar."
-msgid "Text highlight toolbar"
-msgstr "文本高亮工具栏"

package/lang/translations/zh.po

@@ -1,48 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: zh_TW\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Toolbar button tooltip for applying yellow marker (text highlight)."
-msgid "Yellow marker"
-msgstr "黃色標記"
-
-msgctxt "Toolbar button tooltip for applying green marker (text highlight)."
-msgid "Green marker"
-msgstr "綠色標記"
-
-msgctxt "Toolbar button tooltip for applying pink marker (text highlight)."
-msgid "Pink marker"
-msgstr "粉色標記"
-
-msgctxt "Toolbar button tooltip for applying blue marker (text highlight)."
-msgid "Blue marker"
-msgstr "藍色標記"
-
-msgctxt "Toolbar button tooltip for applying red pen (text color)."
-msgid "Red pen"
-msgstr "紅色筆"
-
-msgctxt "Toolbar button tooltip for applying green pen (text color)."
-msgid "Green pen"
-msgstr "綠色筆"
-
-msgctxt "Toolbar button tooltip for removing text highlight."
-msgid "Remove highlight"
-msgstr "清除高亮"
-
-msgctxt "Toolbar button tooltip for the text highlight feature."
-msgid "Highlight"
-msgstr "高亮"
-
-msgctxt "Label used by assistive technologies describing the highlight feature toolbar."
-msgid "Text highlight toolbar"
-msgstr "高亮"

package/src/augmentation.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/highlight.js

@@ -1,38 +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 highlight/highlight
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { HighlightEditing } from './highlightediting.js';
-import { HighlightUI } from './highlightui.js';
-/**
- * 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 class Highlight extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [HighlightEditing, HighlightUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Highlight';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-}

package/src/highlightcommand.js

@@ -1,100 +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 highlight/highlightcommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { ModelDocumentSelection } from 'ckeditor5/src/engine.js';
-/**
- * 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 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', {
-                    includeEmptyRanges: true
-                });
-                for (const range of ranges) {
-                    let itemOrRange = range;
-                    let attributeKey = 'highlight';
-                    if (range.isCollapsed) {
-                        itemOrRange = range.start.parent;
-                        attributeKey = ModelDocumentSelection._getStoreAttributeKey('highlight');
-                    }
-                    if (highlighter) {
-                        writer.setAttribute(attributeKey, highlighter, itemOrRange);
-                    }
-                    else {
-                        writer.removeAttribute(attributeKey, itemOrRange);
-                    }
-                }
-            }
-        });
-    }
-}

package/src/highlightconfig.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/highlightediting.js

@@ -1,115 +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 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 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-content-highlight-marker-yellow)',
-                    type: 'marker'
-                },
-                {
-                    model: 'greenMarker',
-                    class: 'marker-green',
-                    title: 'Green marker',
-                    color: 'var(--ck-content-highlight-marker-green)',
-                    type: 'marker'
-                },
-                {
-                    model: 'pinkMarker',
-                    class: 'marker-pink',
-                    title: 'Pink marker',
-                    color: 'var(--ck-content-highlight-marker-pink)',
-                    type: 'marker'
-                },
-                {
-                    model: 'blueMarker',
-                    class: 'marker-blue',
-                    title: 'Blue marker',
-                    color: 'var(--ck-content-highlight-marker-blue)',
-                    type: 'marker'
-                },
-                {
-                    model: 'redPen',
-                    class: 'pen-red',
-                    title: 'Red pen',
-                    color: 'var(--ck-content-highlight-pen-red)',
-                    type: 'pen'
-                },
-                {
-                    model: 'greenPen',
-                    class: 'pen-green',
-                    title: 'Green pen',
-                    color: 'var(--ck-content-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.js

@@ -1,276 +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 highlight/highlightui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { IconEraser, IconMarker, IconPen } from 'ckeditor5/src/icons.js';
-import { addToolbarToDropdown, createDropdown, ButtonView, ListSeparatorView, MenuBarMenuView, MenuBarMenuListView, MenuBarMenuListItemView, MenuBarMenuListItemButtonView, SplitButtonView, ToolbarSeparatorView } from 'ckeditor5/src/ui.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 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'), IconEraser, 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: IconEraser
-            });
-            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' ? IconMarker : IconPen;
-}

package/src/index.js

@@ -1,12 +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 highlight
- */
-export { Highlight } from './highlight.js';
-export { HighlightEditing } from './highlightediting.js';
-export { HighlightUI } from './highlightui.js';
-export { HighlightCommand } from './highlightcommand.js';
-import './augmentation.js';