@ckeditor/ckeditor5-link 45.2.1 → 46.0.0-alpha.1

package/src/linkui.d.ts

@@ -7,10 +7,10 @@
  */
 import { Plugin } from 'ckeditor5/src/core.js';
 import { ContextualBalloon, ToolbarView, type ViewWithCssTransitionDisabler } from 'ckeditor5/src/ui.js';
-import LinkEditing from './linkediting.js';
-import LinkFormView from './ui/linkformview.js';
-import LinkProviderItemsView from './ui/linkprovideritemsview.js';
-import LinkPropertiesView from './ui/linkpropertiesview.js';
+import { LinkEditing } from './linkediting.js';
+import { LinkFormView } from './ui/linkformview.js';
+import { LinkProviderItemsView } from './ui/linkprovideritemsview.js';
+import { LinkPropertiesView } from './ui/linkpropertiesview.js';
 import '../theme/linktoolbar.css';
 /**
  * The link UI plugin. It introduces the `'link'` and `'unlink'` buttons and support for the <kbd>Ctrl+K</kbd> keystroke.
@@ -18,7 +18,7 @@ import '../theme/linktoolbar.css';
  * It uses the
  * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
  */
-export default class LinkUI extends Plugin {
+export declare class LinkUI extends Plugin {
     /**
      * The toolbar view displayed inside of the balloon.
      */
@@ -240,8 +240,8 @@ export default class LinkUI extends Plugin {
      */
     private _getBalloonPositionData;
     /**
-     * Returns the link {@link module:engine/view/attributeelement~AttributeElement} under
-     * the {@link module:engine/view/document~Document editing view's} selection or `null`
+     * Returns the link {@link module:engine/view/attributeelement~ViewAttributeElement} under
+     * the {@link module:engine/view/document~ViewDocument editing view's} selection or `null`
      * if there is none.
      *
      * **Note**: For a non–collapsed selection, the link element is returned when **fully**

package/src/linkui.js

@@ -11,12 +11,12 @@ import { ClickObserver } from 'ckeditor5/src/engine.js';
 import { ButtonView, SwitchButtonView, ContextualBalloon, clickOutsideHandler, CssTransitionDisablerMixin, MenuBarMenuListItemButtonView, ToolbarView } from 'ckeditor5/src/ui.js';
 import { Collection } from 'ckeditor5/src/utils.js';
 import { isWidget } from 'ckeditor5/src/widget.js';
-import LinkEditing from './linkediting.js';
-import LinkPreviewButtonView from './ui/linkpreviewbuttonview.js';
-import LinkFormView from './ui/linkformview.js';
-import LinkProviderItemsView from './ui/linkprovideritemsview.js';
-import LinkPropertiesView from './ui/linkpropertiesview.js';
-import LinkButtonView from './ui/linkbuttonview.js';
+import { LinkEditing } from './linkediting.js';
+import { LinkPreviewButtonView } from './ui/linkpreviewbuttonview.js';
+import { LinkFormView } from './ui/linkformview.js';
+import { LinkProviderItemsView } from './ui/linkprovideritemsview.js';
+import { LinkPropertiesView } from './ui/linkpropertiesview.js';
+import { LinkButtonView } from './ui/linkbuttonview.js';
 import { addLinkProtocolIfApplicable, ensureSafeUrl, isLinkElement, extractTextFromLinkRange, LINK_KEYSTROKE } from './utils.js';
 import '../theme/linktoolbar.css';
 const VISUAL_SELECTION_MARKER_NAME = 'link-ui';
@@ -26,7 +26,7 @@ const VISUAL_SELECTION_MARKER_NAME = 'link-ui';
  * It uses the
  * {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon contextual balloon plugin}.
  */
-export default class LinkUI extends Plugin {
+export class LinkUI extends Plugin {
     /**
      * The toolbar view displayed inside of the balloon.
      */
@@ -930,8 +930,8 @@ export default class LinkUI extends Plugin {
         };
     }
     /**
-     * Returns the link {@link module:engine/view/attributeelement~AttributeElement} under
-     * the {@link module:engine/view/document~Document editing view's} selection or `null`
+     * Returns the link {@link module:engine/view/attributeelement~ViewAttributeElement} under
+     * the {@link module:engine/view/document~ViewDocument editing view's} selection or `null`
      * if there is none.
      *
      * **Note**: For a non–collapsed selection, the link element is returned when **fully**

package/src/ui/linkbuttonview.d.ts

@@ -7,7 +7,7 @@ import type { Locale } from 'ckeditor5/src/utils.js';
 /**
  * Represents a view for a dropdown menu button.
  */
-export default class LinkButtonView extends ButtonView {
+export declare class LinkButtonView extends ButtonView {
     /**
      * An icon that displays an arrow to indicate a direction of the menu.
      */

package/src/ui/linkbuttonview.js

@@ -10,7 +10,7 @@ import { ButtonView, IconView } from 'ckeditor5/src/ui.js';
 /**
  * Represents a view for a dropdown menu button.
  */
-export default class LinkButtonView extends ButtonView {
+export class LinkButtonView extends ButtonView {
     /**
      * An icon that displays an arrow to indicate a direction of the menu.
      */

package/src/ui/linkformview.d.ts

@@ -13,7 +13,7 @@ import '../../theme/linkform.css';
 /**
  * The link form view.
  */
-export default class LinkFormView extends View {
+export declare class LinkFormView extends View {
     /**
      * Tracks information about DOM focus in the form.
      */
@@ -141,7 +141,7 @@ export type LinkFormValidatorCallback = (form: LinkFormView) => string | undefin
  *
  * @eventName ~LinkFormView#submit
  */
-export type SubmitEvent = {
+export type LinkFormSubmitEvent = {
     name: 'submit';
     args: [];
 };
@@ -150,7 +150,7 @@ export type SubmitEvent = {
  *
  * @eventName ~LinkFormView#cancel
  */
-export type CancelEvent = {
+export type LinkFormCancelEvent = {
     name: 'cancel';
     args: [];
 };

package/src/ui/linkformview.js

@@ -17,7 +17,7 @@ import '../../theme/linkform.css';
 /**
  * The link form view.
  */
-export default class LinkFormView extends View {
+export class LinkFormView extends View {
     /**
      * Tracks information about DOM focus in the form.
      */

package/src/ui/linkpreviewbuttonview.d.ts

@@ -12,7 +12,7 @@ import type { Locale } from 'ckeditor5/src/utils.js';
  *
  * Provides a custom `navigate` cancelable event.
  */
-export default class LinkPreviewButtonView extends ButtonView {
+export declare class LinkPreviewButtonView extends ButtonView {
     /**
      * The value of the "href" attribute of the link.
      *

package/src/ui/linkpreviewbuttonview.js

@@ -11,7 +11,7 @@ import { ButtonView } from 'ckeditor5/src/ui.js';
  *
  * Provides a custom `navigate` cancelable event.
  */
-export default class LinkPreviewButtonView extends ButtonView {
+export class LinkPreviewButtonView extends ButtonView {
     /**
      * @inheritDoc
      */

package/src/ui/linkpropertiesview.d.ts

@@ -13,7 +13,7 @@ import '../../theme/linkproperties.css';
  *
  * See {@link module:link/ui/linkpropertiesview~LinkPropertiesView}.
  */
-export default class LinkPropertiesView extends View {
+export declare class LinkPropertiesView extends View {
     /**
      * Tracks information about DOM focus in the form.
      */
@@ -82,7 +82,7 @@ export default class LinkPropertiesView extends View {
  *
  * @eventName ~LinkPropertiesView#back
  */
-export type BackEvent = {
+export type LinkPropertiesBackEvent = {
     name: 'back';
     args: [];
 };

package/src/ui/linkpropertiesview.js

@@ -14,7 +14,7 @@ import '../../theme/linkproperties.css';
  *
  * See {@link module:link/ui/linkpropertiesview~LinkPropertiesView}.
  */
-export default class LinkPropertiesView extends View {
+export class LinkPropertiesView extends View {
     /**
      * Tracks information about DOM focus in the form.
      */

package/src/ui/linkprovideritemsview.d.ts

@@ -11,7 +11,7 @@ import '../../theme/linkprovideritems.css';
 /**
  * The link provider items view.
  */
-export default class LinkProviderItemsView extends View {
+export declare class LinkProviderItemsView extends View {
     /**
      * Tracks information about the list of links.
      *
@@ -108,7 +108,7 @@ export default class LinkProviderItemsView extends View {
  *
  * @eventName ~LinkProviderItemsView#cancel
  */
-export type CancelEvent = {
+export type LinkProvidersCancelEvent = {
     name: 'cancel';
     args: [];
 };

package/src/ui/linkprovideritemsview.js

@@ -12,7 +12,7 @@ import '../../theme/linkprovideritems.css';
 /**
  * The link provider items view.
  */
-export default class LinkProviderItemsView extends View {
+export class LinkProviderItemsView extends View {
     /**
      * Tracks information about DOM focus in the form.
      */

package/src/unlinkcommand.d.ts

@@ -9,7 +9,7 @@ import { Command } from 'ckeditor5/src/core.js';
 /**
  * The unlink command. It is used by the {@link module:link/link~Link link plugin}.
  */
-export default class UnlinkCommand extends Command {
+export declare class UnlinkCommand extends Command {
     /**
      * @inheritDoc
      */

package/src/unlinkcommand.js

@@ -11,7 +11,7 @@ import { isLinkableElement } from './utils.js';
 /**
  * The unlink command. It is used by the {@link module:link/link~Link link plugin}.
  */
-export default class UnlinkCommand extends Command {
+export class UnlinkCommand extends Command {
     /**
      * @inheritDoc
      */

package/src/utils/automaticdecorators.d.ts

@@ -12,14 +12,14 @@ import type { NormalizedLinkDecoratorAutomaticDefinition } from '../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 default class AutomaticDecorators {
+export declare 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.
      */
     private _definitions;
     /**
-     * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticDecorators}
+     * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticLinkDecorators}
      * instance.
      */
     get length(): number;

package/src/utils/automaticdecorators.js

@@ -10,14 +10,14 @@ import { toMap } 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 default class AutomaticDecorators {
+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();
     /**
-     * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticDecorators}
+     * Gives information about the number of decorators stored in the {@link module:link/utils/automaticdecorators~AutomaticLinkDecorators}
      * instance.
      */
     get length() {

package/src/utils/manualdecorator.d.ts

@@ -8,16 +8,16 @@
 import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
 import type { MatcherObjectPattern } from 'ckeditor5/src/engine.js';
 import type { NormalizedLinkDecoratorManualDefinition } from '../utils.js';
-declare const ManualDecorator_base: {
+declare const LinkManualDecorator_base: {
     new (): import("ckeditor5/src/utils.js").Observable;
     prototype: import("ckeditor5/src/utils.js").Observable;
 };
 /**
- * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~ManualDecorator#value}
+ * 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 default class ManualDecorator extends /* #__PURE__ */ ManualDecorator_base {
+export declare class LinkManualDecorator extends /* #__PURE__ */ LinkManualDecorator_base {
     /**
      * An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
      */
@@ -38,21 +38,21 @@ export default class ManualDecorator extends /* #__PURE__ */ ManualDecorator_bas
     label: string;
     /**
      * 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~ElementDefinition}.
+     * Attributes should be added in a form of attributes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
      */
     attributes?: Record<string, string>;
     /**
      * 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~ElementDefinition}.
+     * Classes should be added in a form of classes defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
      */
     classes?: ArrayOrItem<string>;
     /**
      * 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~ElementDefinition}.
+     * Styles should be added in a form of styles defined in {@link module:engine/view/elementdefinition~ViewElementDefinition}.
      */
     styles?: Record<string, string>;
     /**
-     * Creates a new instance of {@link module:link/utils/manualdecorator~ManualDecorator}.
+     * Creates a new instance of {@link module:link/utils/manualdecorator~LinkManualDecorator}.
      *
      * @param options The configuration object.
      */

package/src/utils/manualdecorator.js

@@ -7,11 +7,11 @@
  */
 import { ObservableMixin } from 'ckeditor5/src/utils.js';
 /**
- * Helper class that stores manual decorators with observable {@link module:link/utils/manualdecorator~ManualDecorator#value}
+ * 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 default class ManualDecorator extends /* #__PURE__ */ ObservableMixin() {
+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'.
      */
@@ -26,21 +26,21 @@ export default class ManualDecorator extends /* #__PURE__ */ ObservableMixin() {
     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~ElementDefinition}.
+     * 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~ElementDefinition}.
+     * 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~ElementDefinition}.
+     * 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~ManualDecorator}.
+     * Creates a new instance of {@link module:link/utils/manualdecorator~LinkManualDecorator}.
      *
      * @param options The configuration object.
      */

package/src/utils.d.ts

@@ -5,7 +5,7 @@
 /**
  * @module link/utils
  */
-import type { DowncastConversionApi, Element, Schema, ViewAttributeElement, ViewNode, ViewDocumentFragment, Range } from 'ckeditor5/src/engine.js';
+import type { DowncastConversionApi, ModelElement, ModelSchema, ViewAttributeElement, ViewNode, ViewDocumentFragment, ModelRange } from 'ckeditor5/src/engine.js';
 import type { LocaleTranslate } from 'ckeditor5/src/utils.js';
 import type { LinkDecoratorAutomaticDefinition, LinkDecoratorDefinition, LinkDecoratorManualDefinition } from './linkconfig.js';
 /**
@@ -17,7 +17,7 @@ export declare const LINK_KEYSTROKE = "Ctrl+K";
  */
 export declare function isLinkElement(node: ViewNode | ViewDocumentFragment): boolean;
 /**
- * Creates a link {@link module:engine/view/attributeelement~AttributeElement} with the provided `href` attribute.
+ * Creates a link {@link module:engine/view/attributeelement~ViewAttributeElement} with the provided `href` attribute.
  */
 export declare function createLinkElement(href: string, { writer }: DowncastConversionApi): ViewAttributeElement;
 /**
@@ -40,19 +40,24 @@ export declare function ensureSafeUrl(url: unknown, allowedProtocols?: Array<str
  *
  * @param t Shorthand for {@link module:utils/locale~Locale#t Locale#t}.
  * @param decorators The decorator reference where the label values should be localized.
+ * @internal
  */
 export declare function getLocalizedDecorators(t: LocaleTranslate, decorators: Array<NormalizedLinkDecoratorDefinition>): Array<NormalizedLinkDecoratorDefinition>;
 /**
  * Converts an object with defined decorators to a normalized array of decorators. The `id` key is added for each decorator and
  * is used as the attribute's name in the model.
+ *
+ * @internal
  */
 export declare function normalizeDecorators(decorators?: Record<string, LinkDecoratorDefinition>): Array<NormalizedLinkDecoratorDefinition>;
 /**
  * Returns `true` if the specified `element` can be linked (the element allows the `linkHref` attribute).
  */
-export declare function isLinkableElement(element: Element | null, schema: Schema): element is Element;
+export declare function isLinkableElement(element: ModelElement | null, schema: ModelSchema): element is ModelElement;
 /**
  * Returns `true` if the specified `value` is an email.
+ *
+ * @internal
  */
 export declare function isEmail(value: string): boolean;
 /**
@@ -65,6 +70,8 @@ export declare function isEmail(value: string): boolean;
 export declare function addLinkProtocolIfApplicable(link: string, defaultProtocol?: string): string;
 /**
  * Checks if protocol is already included in the link.
+ *
+ * @internal
  */
 export declare function linkHasProtocol(link: string): boolean;
 /**
@@ -76,7 +83,7 @@ export declare function openLink(link: string): void;
  *
  * If the returned value is `undefined`, the range contains elements other than text nodes.
  */
-export declare function extractTextFromLinkRange(range: Range): string | undefined;
+export declare function extractTextFromLinkRange(range: ModelRange): string | undefined;
 export type NormalizedLinkDecoratorAutomaticDefinition = LinkDecoratorAutomaticDefinition & {
     id: string;
 };

package/src/utils.js

@@ -26,7 +26,7 @@ export function isLinkElement(node) {
     return node.is('attributeElement') && !!node.getCustomProperty('link');
 }
 /**
- * Creates a link {@link module:engine/view/attributeelement~AttributeElement} with the provided `href` attribute.
+ * Creates a link {@link module:engine/view/attributeelement~ViewAttributeElement} with the provided `href` attribute.
  */
 export function createLinkElement(href, { writer }) {
     // Priority 5 - https://github.com/ckeditor/ckeditor5-link/issues/121.
@@ -66,6 +66,7 @@ function isSafeUrl(url, customRegexp) {
  *
  * @param t Shorthand for {@link module:utils/locale~Locale#t Locale#t}.
  * @param decorators The decorator reference where the label values should be localized.
+ * @internal
  */
 export function getLocalizedDecorators(t, decorators) {
     const localizedDecoratorsLabels = {
@@ -83,6 +84,8 @@ export function getLocalizedDecorators(t, decorators) {
 /**
  * Converts an object with defined decorators to a normalized array of decorators. The `id` key is added for each decorator and
  * is used as the attribute's name in the model.
+ *
+ * @internal
  */
 export function normalizeDecorators(decorators) {
     const retArray = [];
@@ -105,6 +108,8 @@ export function isLinkableElement(element, schema) {
 }
 /**
  * Returns `true` if the specified `value` is an email.
+ *
+ * @internal
  */
 export function isEmail(value) {
     return EMAIL_REG_EXP.test(value);
@@ -123,6 +128,8 @@ export function addLinkProtocolIfApplicable(link, defaultProtocol) {
 }
 /**
  * Checks if protocol is already included in the link.
+ *
+ * @internal
  */
 export function linkHasProtocol(link) {
     return PROTOCOL_REG_EXP.test(link);