@ckeditor/ckeditor5-link 47.6.1-alpha.1 → 48.0.0-alpha.0

package/src/ui/linkprovideritemsview.js

@@ -1,207 +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 link/ui/linkprovideritemsview
- */
-import { ButtonView, FocusCycler, FormHeaderView, View, ListView, ListItemView, ViewCollection } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils.js';
-import { IconPreviousArrow } from '@ckeditor/ckeditor5-icons';
-import '../../theme/linkprovideritems.css';
-/**
- * The link provider items view.
- */
-export class LinkProviderItemsView extends View {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    focusTracker = new FocusTracker();
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    keystrokes = new KeystrokeHandler();
-    /**
-     * The Back button view displayed in the header.
-     */
-    backButtonView;
-    /**
-     * The List view of links buttons.
-     */
-    listView;
-    /**
-     * The collection of child views, which is bind with the `listView`.
-     */
-    listChildren;
-    /**
-     * The view displayed when the list is empty.
-     */
-    emptyListInformation;
-    /**
-     * A collection of child views.
-     */
-    children;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    _focusables = new ViewCollection();
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    _focusCycler;
-    /**
-     * Creates an instance of the {@link module:link/ui/linkprovideritemsview~LinkProviderItemsView} class.
-     *
-     * Also see {@link #render}.
-     *
-     * @param locale The localization services instance.
-     */
-    constructor(locale) {
-        super(locale);
-        this.listChildren = this.createCollection();
-        this.backButtonView = this._createBackButton();
-        this.listView = this._createListView();
-        this.emptyListInformation = this._createEmptyLinksListItemView();
-        this.children = this.createCollection([
-            this._createHeaderView(),
-            this.emptyListInformation
-        ]);
-        this.set('title', '');
-        this.set('emptyListPlaceholder', '');
-        this.set('hasItems', false);
-        this.listenTo(this.listChildren, 'change', () => {
-            this.hasItems = this.listChildren.length > 0;
-        });
-        this.on('change:hasItems', (evt, propName, hasItems) => {
-            if (hasItems) {
-                this.children.remove(this.emptyListInformation);
-                this.children.add(this.listView);
-            }
-            else {
-                this.children.remove(this.listView);
-                this.children.add(this.emptyListInformation);
-            }
-        });
-        // Close the panel on esc key press when the **form has focus**.
-        this.keystrokes.set('Esc', (data, cancel) => {
-            this.fire('cancel');
-            cancel();
-        });
-        this._focusCycler = new FocusCycler({
-            focusables: this._focusables,
-            focusTracker: this.focusTracker,
-            keystrokeHandler: this.keystrokes,
-            actions: {
-                // Navigate form fields backwards using the Shift + Tab keystroke.
-                focusPrevious: 'shift + tab',
-                // Navigate form fields forwards using the Tab key.
-                focusNext: 'tab'
-            }
-        });
-        this.setTemplate({
-            tag: 'div',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-link-providers'
-                ],
-                // https://github.com/ckeditor/ckeditor5-link/issues/90
-                tabindex: '-1'
-            },
-            children: this.children
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        const childViews = [
-            this.listView,
-            this.backButtonView
-        ];
-        childViews.forEach(v => {
-            // Register the view as focusable.
-            this._focusables.add(v);
-            // Register the view in the focus tracker.
-            this.focusTracker.add(v.element);
-        });
-        // Start listening for the keystrokes coming from #element.
-        this.keystrokes.listenTo(this.element);
-    }
-    /**
-     * @inheritDoc
-     */
-    destroy() {
-        super.destroy();
-        this.focusTracker.destroy();
-        this.keystrokes.destroy();
-    }
-    /**
-     * Focuses the fist {@link #_focusables} in the form.
-     */
-    focus() {
-        this._focusCycler.focusFirst();
-    }
-    /**
-     * Creates a view for the list at the bottom.
-     */
-    _createListView() {
-        const listView = new ListView(this.locale);
-        listView.extendTemplate({
-            attributes: {
-                class: [
-                    'ck-link-providers__list'
-                ]
-            }
-        });
-        listView.items.bindTo(this.listChildren).using(button => {
-            const listItemView = new ListItemView(this.locale);
-            listItemView.children.add(button);
-            return listItemView;
-        });
-        return listView;
-    }
-    /**
-     * Creates a back button view that cancels the form.
-     */
-    _createBackButton() {
-        const t = this.locale.t;
-        const backButton = new ButtonView(this.locale);
-        backButton.set({
-            class: 'ck-button-back',
-            label: t('Back'),
-            icon: IconPreviousArrow,
-            tooltip: true
-        });
-        backButton.delegate('execute').to(this, 'cancel');
-        return backButton;
-    }
-    /**
-     * Creates a header view for the form.
-     */
-    _createHeaderView() {
-        const header = new FormHeaderView(this.locale);
-        header.bind('label').to(this, 'title');
-        header.children.add(this.backButtonView, 0);
-        return header;
-    }
-    /**
-     * Creates an info view for an empty list.
-     */
-    _createEmptyLinksListItemView() {
-        const view = new View(this.locale);
-        view.setTemplate({
-            tag: 'p',
-            attributes: {
-                class: ['ck', 'ck-link__empty-list-info']
-            },
-            children: [
-                {
-                    text: this.bindTemplate.to('emptyListPlaceholder')
-                }
-            ]
-        });
-        return view;
-    }
-}

package/src/unlinkcommand.js

@@ -1,66 +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 link/unlinkcommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { findAttributeRange } from 'ckeditor5/src/typing.js';
-import { isLinkableElement } from './utils.js';
-/**
- * The unlink command. It is used by the {@link module:link/link~Link link plugin}.
- */
-export class UnlinkCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const selectedElement = selection.getSelectedElement();
-        // A check for any integration that allows linking elements (e.g. `LinkImage`).
-        // Currently the selection reads attributes from text nodes only. See #7429 and #7465.
-        if (isLinkableElement(selectedElement, model.schema)) {
-            this.isEnabled = model.schema.checkAttribute(selectedElement, 'linkHref');
-        }
-        else {
-            this.isEnabled = model.schema.checkAttributeInSelection(selection, 'linkHref');
-        }
-    }
-    /**
-     * Executes the command.
-     *
-     * When the selection is collapsed, it removes the `linkHref` attribute from each node with the same `linkHref` attribute value.
-     * When the selection is non-collapsed, it removes the `linkHref` attribute from each node in selected ranges.
-     *
-     * # Decorators
-     *
-     * If {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} is specified,
-     * all configured decorators are removed together with the `linkHref` attribute.
-     *
-     * @fires execute
-     */
-    execute() {
-        const editor = this.editor;
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const linkCommand = editor.commands.get('link');
-        model.change(writer => {
-            // Get ranges to unlink.
-            const rangesToUnlink = selection.isCollapsed ?
-                [findAttributeRange(selection.getFirstPosition(), 'linkHref', selection.getAttribute('linkHref'), model)] :
-                model.schema.getValidRanges(selection.getRanges(), 'linkHref');
-            // Remove `linkHref` attribute from specified ranges.
-            for (const range of rangesToUnlink) {
-                writer.removeAttribute('linkHref', range);
-                // If there are registered custom attributes, then remove them during unlink.
-                if (linkCommand) {
-                    for (const manualDecorator of linkCommand.manualDecorators) {
-                        writer.removeAttribute(manualDecorator.id, range);
-                    }
-                }
-            }
-        });
-    }
-}

package/src/utils/automaticdecorators.js

@@ -1,181 +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 link/utils/automaticdecorators
- */
-import { toMap, priorities } from 'ckeditor5/src/utils.js';
-/**
- * Helper class that ties together all {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition} and provides
- * the {@link module:engine/conversion/downcasthelpers~DowncastHelpers#attributeToElement downcast dispatchers} for them.
- */
-export class AutomaticLinkDecorators {
-    /**
-     * Stores the definition of {@link module:link/linkconfig~LinkDecoratorAutomaticDefinition automatic decorators}.
-     * This data is used as a source for a downcast dispatcher to create a proper conversion to output data.
-     */
-    _definitions = new Set();
-    /**
-     * A callback that checks if a decorator can be applied to a given element.
-     * Returns `true` if there is a conflict preventing the decorator from being applied.
-     */
-    _conflictChecker;
-    /**
-     * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticLinkDecorators}
-     * instance.
-     */
-    get length() {
-        return this._definitions.size;
-    }
-    /**
-     * Sets a callback that checks if a decorator can be applied to a given element.
-     *
-     * @param checker A function that returns `true` if there is a conflict preventing the decorator from being applied.
-     */
-    setConflictChecker(checker) {
-        this._conflictChecker = checker;
-    }
-    /**
-     * Adds automatic decorator objects or an array with them to be used during downcasting.
-     *
-     * @param item A configuration object of automatic rules for decorating links. It might also be an array of such objects.
-     */
-    add(item) {
-        if (Array.isArray(item)) {
-            item.forEach(item => this._definitions.add(item));
-        }
-        else {
-            this._definitions.add(item);
-        }
-    }
-    /**
-     * Provides the conversion helper used in the {@link module:engine/conversion/downcasthelpers~DowncastHelpers#add} method.
-     *
-     * @returns A dispatcher function used as conversion helper in {@link module:engine/conversion/downcasthelpers~DowncastHelpers#add}.
-     */
-    getDispatcher() {
-        return dispatcher => {
-            const elementCreator = (item, viewWriter) => {
-                const viewElement = viewWriter.createAttributeElement('a', item.attributes, {
-                    priority: 5
-                });
-                if (item.classes) {
-                    viewWriter.addClass(item.classes, viewElement);
-                }
-                for (const key in item.styles) {
-                    viewWriter.setStyle(key, item.styles[key], viewElement);
-                }
-                viewWriter.setCustomProperty('link', true, viewElement);
-                return viewElement;
-            };
-            const createConverter = (isApplyingConverter) => {
-                return (evt, data, conversionApi) => {
-                    if (!data.attributeKey.startsWith('link')) {
-                        return;
-                    }
-                    // There is only test as this behavior decorates links and
-                    // it is run before dispatcher which actually consumes this node.
-                    // This allows on writing own dispatcher with highest priority,
-                    // which blocks both native converter and this additional decoration.
-                    if (data.attributeKey == 'linkHref' && !conversionApi.consumable.test(data.item, 'attribute:linkHref')) {
-                        return;
-                    }
-                    // Automatic decorators for block links are handled e.g. in LinkImageEditing.
-                    if (!data.item.is('selection') && !conversionApi.schema.isInline(data.item)) {
-                        return;
-                    }
-                    for (const decorator of this._definitions) {
-                        // Check if automatic decorator is matched and does not conflict with any other active manual decorator.
-                        if (decorator.callback(data.item.getAttribute('linkHref')) &&
-                            !this._conflictChecker?.(decorator, data.item) &&
-                            isApplyingConverter) {
-                            if (data.item.is('selection')) {
-                                conversionApi.writer.wrap(conversionApi.writer.document.selection.getFirstRange(), elementCreator(decorator, conversionApi.writer));
-                            }
-                            else {
-                                conversionApi.writer.wrap(conversionApi.mapper.toViewRange(data.range), elementCreator(decorator, conversionApi.writer));
-                            }
-                        }
-                        else {
-                            conversionApi.writer.unwrap(conversionApi.mapper.toViewRange(data.range), elementCreator(decorator, conversionApi.writer));
-                        }
-                    }
-                };
-            };
-            dispatcher.on('attribute', createConverter(false), { priority: priorities.high - 1 });
-            // Apply decorators after all automatic and manual decorators are removed so removing one decorator
-            // won't strip part of the other decorator's attributes, classes or styles.
-            dispatcher.on('attribute', createConverter(true), { priority: priorities.high - 2 });
-        };
-    }
-    /**
-     * Provides the conversion helper used in the {@link module:engine/conversion/downcasthelpers~DowncastHelpers#add} method
-     * when linking images.
-     *
-     * @returns A dispatcher function used as conversion helper in {@link module:engine/conversion/downcasthelpers~DowncastHelpers#add}.
-     */
-    getDispatcherForLinkedImage() {
-        return dispatcher => {
-            const createConverter = (isApplyingConverter) => {
-                return (evt, data, { writer, mapper }) => {
-                    if (!data.item.is('element', 'imageBlock') || !data.attributeKey.startsWith('link')) {
-                        return;
-                    }
-                    const viewFigure = mapper.toViewElement(data.item);
-                    const linkInImage = Array.from(viewFigure.getChildren())
-                        .find((child) => child.is('element', 'a'));
-                    // It's not guaranteed that the anchor is present in the image block during execution of this dispatcher.
-                    // It might have been removed during the execution of unlink command that runs the image link downcast dispatcher
-                    // that is executed before this one and removes the anchor from the image block.
-                    if (!linkInImage) {
-                        return;
-                    }
-                    for (const decorator of this._definitions) {
-                        const attributes = toMap(decorator.attributes);
-                        if (decorator.callback(data.item.getAttribute('linkHref')) &&
-                            !this._conflictChecker?.(decorator, data.item) &&
-                            isApplyingConverter) {
-                            for (const [key, val] of attributes) {
-                                // Left for backward compatibility. Since v30 decorator should
-                                // accept `classes` and `styles` separately from `attributes`.
-                                if (key === 'class') {
-                                    writer.addClass(val, linkInImage);
-                                }
-                                else {
-                                    writer.setAttribute(key, val, false, linkInImage);
-                                }
-                            }
-                            if (decorator.classes) {
-                                writer.addClass(decorator.classes, linkInImage);
-                            }
-                            for (const key in decorator.styles) {
-                                writer.setStyle(key, decorator.styles[key], linkInImage);
-                            }
-                        }
-                        else {
-                            for (const [key, val] of attributes) {
-                                if (key === 'class') {
-                                    writer.removeClass(val, linkInImage);
-                                }
-                                else {
-                                    writer.removeAttribute(key, val, linkInImage);
-                                }
-                            }
-                            if (decorator.classes) {
-                                writer.removeClass(decorator.classes, linkInImage);
-                            }
-                            for (const key in decorator.styles) {
-                                writer.removeStyle(key, linkInImage);
-                            }
-                        }
-                    }
-                };
-            };
-            dispatcher.on('attribute', createConverter(false), { priority: priorities.high - 1 });
-            // Apply decorators after all automatic and manual decorators are removed so removing one decorator
-            // won't strip part of the other decorator's attributes, classes or styles.
-            dispatcher.on('attribute', createConverter(true), { priority: priorities.high - 2 });
-        };
-    }
-}

package/src/utils/conflictingdecorators.js

@@ -1,80 +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 link/utils/conflictingdecorators
- */
-/**
- * Checks if two decorators conflict with each other.
- *
- * Decorators conflict when they share the same HTML attribute names (excluding mergeable attributes)
- * or style properties.
- *
- * @internal
- * @param a The first decorator.
- * @param b The second decorator.
- */
-export function areDecoratorsConflicting(a, b) {
-    if (a.attributes && b.attributes) {
-        const hasConflict = Object.keys(a.attributes).some(key => !isMergeableAttribute(key) && key in b.attributes);
-        if (hasConflict) {
-            return true;
-        }
-    }
-    // Check for conflicting style properties (same CSS property names).
-    if (a.styles && b.styles) {
-        const hasConflict = Object.keys(a.styles).some(key => key in b.styles);
-        if (hasConflict) {
-            return true;
-        }
-    }
-    // Classes don't conflict with each other - they can be merged.
-    return false;
-    function isMergeableAttribute(key) {
-        return key === 'class' || key === 'style' || key === 'rel';
-    }
-}
-/**
- * Resolves conflicting manual decorators by automatically disabling decorators that share
- * the same HTML attributes with newly enabled decorators.
- *
- * @internal
- * @param options Configuration object.
- * @param options.decoratorStates Initial decorator states.
- * @param options.allDecorators Collection of all manual decorators.
- * @returns Updated decorator states with conflicts resolved.
- */
-export function resolveConflictingDecorators({ decoratorStates, allDecorators }) {
-    const resolved = { ...decoratorStates };
-    for (const name in decoratorStates) {
-        if (decoratorStates[name] && isNewlyAddedDecorator(name)) {
-            const conflicts = getConflictingManualDecorators(name, allDecorators);
-            for (const conflict of conflicts) {
-                resolved[conflict] = false;
-            }
-        }
-    }
-    function isNewlyAddedDecorator(name) {
-        return allDecorators.some(item => item.id === name && !item.value);
-    }
-    return resolved;
-}
-/**
- * Returns array of decorator names that conflict with the given decorator.
- * Decorators conflict when they share the same HTML attribute names or style properties.
- *
- * @param decoratorId The id/name of the manual decorator to check for conflicts.
- * @param manualDecorators Collection of all manual decorators.
- * @returns Array of conflicting decorator names.
- */
-function getConflictingManualDecorators(decoratorId, manualDecorators) {
-    const decorator = manualDecorators.find(item => item.id === decoratorId);
-    /* istanbul ignore next -- @preserve */
-    if (!decorator) {
-        return [];
-    }
-    return manualDecorators
-        .filter(otherDecorator => otherDecorator.id !== decoratorId && areDecoratorsConflicting(decorator, otherDecorator))
-        .map(item => item.id);
-}

package/src/utils/manualdecorator.js

@@ -1,69 +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 link/utils/manualdecorator
- */
-import { ObservableMixin } from 'ckeditor5/src/utils.js';
-/**
- * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~LinkManualDecorator#value}
- * to support integration with the UI state. An instance of this class is a model with the state of individual manual decorators.
- * These decorators are kept as collections in {@link module:link/linkcommand~LinkCommand#manualDecorators}.
- */
-export class LinkManualDecorator extends /* #__PURE__ */ ObservableMixin() {
-    /**
-     * An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
-     */
-    id;
-    /**
-     * The default value of manual decorator.
-     */
-    defaultValue;
-    /**
-     * The label used in the user interface to toggle the manual decorator.
-     */
-    label;
-    /**
-     * A set of attributes added to downcasted data when the decorator is activated for a specific link.
-     * Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
-     */
-    attributes;
-    /**
-     * A set of classes added to downcasted data when the decorator is activated for a specific link.
-     * Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
-     */
-    classes;
-    /**
-     * A set of styles added to downcasted data when the decorator is activated for a specific link.
-     * Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
-     */
-    styles;
-    /**
-     * Creates a new instance of {@link module:link/utils/manualdecorator~LinkManualDecorator}.
-     *
-     * @param options The configuration object.
-     */
-    constructor({ id, label, attributes, classes, styles, defaultValue }) {
-        super();
-        this.id = id;
-        this.set('value', undefined);
-        this.defaultValue = defaultValue;
-        this.label = label;
-        this.attributes = attributes;
-        this.classes = classes;
-        this.styles = styles;
-    }
-    /**
-     * Returns {@link module:engine/view/matcher~MatcherPattern} with decorator attributes.
-     *
-     * @internal
-     */
-    _createPattern() {
-        return {
-            attributes: this.attributes,
-            classes: this.classes,
-            styles: this.styles
-        };
-    }
-}