@ckeditor/ckeditor5-link 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/ui/linkactionsview.d.ts

@@ -1,121 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/ui/linkactionsview
- */
-import { ButtonView, View } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type LocaleTranslate, type Locale } from 'ckeditor5/src/utils.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/linkactions.css';
-import type { LinkConfig } from '../linkconfig.js';
-/**
- * The link actions view class. This view displays the link preview, allows
- * unlinking or editing the link.
- */
-export default class LinkActionsView extends View {
-    /**
-     * Tracks information about DOM focus in the actions.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The href preview view.
-     */
-    previewButtonView: ButtonView;
-    /**
-     * The unlink button view.
-     */
-    unlinkButtonView: ButtonView;
-    /**
-     * The edit link button view.
-     */
-    editButtonView: ButtonView;
-    /**
-     * The value of the "href" attribute of the link to use in the {@link #previewButtonView}.
-     *
-     * @observable
-     */
-    href: string | undefined;
-    /**
-     * A collection of views that can be focused in the view.
-     */
-    private readonly _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the view.
-     */
-    private readonly _focusCycler;
-    private readonly _linkConfig;
-    private readonly _options?;
-    t: LocaleTranslate;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale, linkConfig?: LinkConfig, options?: LinkActionsViewOptions);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the fist {@link #_focusables} in the actions.
-     */
-    focus(): void;
-    /**
-     * Creates a button view.
-     *
-     * @param label The button label.
-     * @param icon The button icon.
-     * @param eventName An event name that the `ButtonView#execute` event will be delegated to.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * Creates a link href preview button.
-     *
-     * @returns The button view instance.
-     */
-    private _createPreviewButton;
-}
-/**
- * Fired when the {@link ~LinkActionsView#editButtonView} is clicked.
- *
- * @eventName ~LinkActionsView#edit
- */
-export type EditEvent = {
-    name: 'edit';
-    args: [];
-};
-/**
- * Fired when the {@link ~LinkActionsView#unlinkButtonView} is clicked.
- *
- * @eventName ~LinkActionsView#unlink
- */
-export type UnlinkEvent = {
-    name: 'unlink';
-    args: [];
-};
-/**
- * The options that are passed to the {@link ~LinkActionsView#constructor} constructor.
- */
-export type LinkActionsViewOptions = {
-    /**
-     * Returns `true` when bookmark `id` matches the hash from `link`.
-     */
-    isScrollableToTarget: (href: string | undefined) => boolean;
-    /**
-     * Scrolls the view to the desired bookmark or open a link in new window.
-     */
-    scrollToTarget: (href: string) => void;
-};

package/dist/ui/linkformview.d.ts

@@ -1,175 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/ui/linkformview
- */
-import { ButtonView, LabeledFieldView, View, ViewCollection, type InputTextView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import type LinkCommand from '../linkcommand.js';
-import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
-import '../../theme/linkform.css';
-/**
- * The link form view controller class.
- *
- * See {@link module:link/ui/linkformview~LinkFormView}.
- */
-export default class LinkFormView extends View {
-    /**
-     * Tracks information about DOM focus in the form.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The URL input view.
-     */
-    urlInputView: LabeledFieldView<InputTextView>;
-    /**
-     * The Save button view.
-     */
-    saveButtonView: ButtonView;
-    /**
-     * The Cancel button view.
-     */
-    cancelButtonView: ButtonView;
-    /**
-     * A collection of {@link module:ui/button/switchbuttonview~SwitchButtonView},
-     * which corresponds to {@link module:link/linkcommand~LinkCommand#manualDecorators manual decorators}
-     * configured in the editor.
-     */
-    private readonly _manualDecoratorSwitches;
-    /**
-     * A collection of child views in the form.
-     */
-    readonly children: ViewCollection;
-    /**
-     * An array of form validators used by {@link #isValid}.
-     */
-    private readonly _validators;
-    /**
-     * A collection of views that can be focused in the form.
-     */
-    private readonly _focusables;
-    /**
-     * Helps cycling over {@link #_focusables} in the form.
-     */
-    private readonly _focusCycler;
-    /**
-     * Creates an instance of the {@link module:link/ui/linkformview~LinkFormView} class.
-     *
-     * Also see {@link #render}.
-     *
-     * @param locale The localization services instance.
-     * @param linkCommand Reference to {@link module:link/linkcommand~LinkCommand}.
-     * @param validators  Form validators used by {@link #isValid}.
-     */
-    constructor(locale: Locale, linkCommand: LinkCommand, validators: Array<LinkFormValidatorCallback>);
-    /**
-     * Obtains the state of the {@link module:ui/button/switchbuttonview~SwitchButtonView switch buttons} representing
-     * {@link module:link/linkcommand~LinkCommand#manualDecorators manual link decorators}
-     * in the {@link module:link/ui/linkformview~LinkFormView}.
-     *
-     * @returns Key-value pairs, where the key is the name of the decorator and the value is its state.
-     */
-    getDecoratorSwitchesState(): Record<string, boolean>;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the fist {@link #_focusables} in the form.
-     */
-    focus(): void;
-    /**
-     * Validates the form and returns `false` when some fields are invalid.
-     */
-    isValid(): boolean;
-    /**
-     * Cleans up the supplementary error and information text of the {@link #urlInputView}
-     * bringing them back to the state when the form has been displayed for the first time.
-     *
-     * See {@link #isValid}.
-     */
-    resetFormStatus(): void;
-    /**
-     * Creates a labeled input view.
-     *
-     * @returns Labeled field view instance.
-     */
-    private _createUrlInput;
-    /**
-     * Creates a button view.
-     *
-     * @param label The button label.
-     * @param icon The button icon.
-     * @param className The additional button CSS class name.
-     * @param eventName An event name that the `ButtonView#execute` event will be delegated to.
-     * @returns The button view instance.
-     */
-    private _createButton;
-    /**
-     * Populates {@link module:ui/viewcollection~ViewCollection} of {@link module:ui/button/switchbuttonview~SwitchButtonView}
-     * made based on {@link module:link/linkcommand~LinkCommand#manualDecorators}.
-     *
-     * @param linkCommand A reference to the link command.
-     * @returns ViewCollection of switch buttons.
-     */
-    private _createManualDecoratorSwitches;
-    /**
-     * Populates the {@link #children} collection of the form.
-     *
-     * If {@link module:link/linkcommand~LinkCommand#manualDecorators manual decorators} are configured in the editor, it creates an
-     * additional `View` wrapping all {@link #_manualDecoratorSwitches} switch buttons corresponding
-     * to these decorators.
-     *
-     * @param manualDecorators A reference to
-     * the collection of manual decorators stored in the link command.
-     * @returns The children of link form view.
-     */
-    private _createFormChildren;
-    /**
-     * The native DOM `value` of the {@link #urlInputView} element.
-     *
-     * **Note**: Do not confuse it with the {@link module:ui/inputtext/inputtextview~InputTextView#value}
-     * which works one way only and may not represent the actual state of the component in the DOM.
-     */
-    get url(): string | null;
-}
-/**
- * Callback used by {@link ~LinkFormView} to check if passed form value is valid.
- *
- * 	* If `undefined` is returned, it is assumed that the form value is correct and there is no error.
- * 	* If string is returned, it is assumed that the form value is incorrect and the returned string is displayed in the error label
- */
-export type LinkFormValidatorCallback = (form: LinkFormView) => string | undefined;
-/**
- * Fired when the form view is submitted (when one of the children triggered the submit event),
- * for example with a click on {@link ~LinkFormView#saveButtonView}.
- *
- * @eventName ~LinkFormView#submit
- */
-export type SubmitEvent = {
-    name: 'submit';
-    args: [];
-};
-/**
- * Fired when the form view is canceled, for example with a click on {@link ~LinkFormView#cancelButtonView}.
- *
- * @eventName ~LinkFormView#cancel
- */
-export type CancelEvent = {
-    name: 'cancel';
-    args: [];
-};

package/dist/unlinkcommand.d.ts

@@ -1,35 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/unlinkcommand
- */
-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 {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * 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(): void;
-}

package/dist/utils/automaticdecorators.d.ts

@@ -1,49 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/utils/automaticdecorators
- */
-import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
-import type { DowncastDispatcher } from 'ckeditor5/src/engine.js';
-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 {
-    /**
-     * 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}
-     * instance.
-     */
-    get length(): number;
-    /**
-     * 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: ArrayOrItem<NormalizedLinkDecoratorAutomaticDefinition>): void;
-    /**
-     * 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(): (dispatcher: DowncastDispatcher) => void;
-    /**
-     * 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(): (dispatcher: DowncastDispatcher) => void;
-}

package/dist/utils/manualdecorator.d.ts

@@ -1,76 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/utils/manualdecorator
- */
-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: {
-    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}
- * 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 {
-    /**
-     * An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
-     */
-    id: string;
-    /**
-     * The value of the current manual decorator. It reflects its state from the UI.
-     *
-     * @observable
-     */
-    value: boolean | undefined;
-    /**
-     * The default value of manual decorator.
-     */
-    defaultValue?: boolean;
-    /**
-     * The label used in the user interface to toggle the manual decorator.
-     */
-    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?: 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?: 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?: Record<string, string>;
-    /**
-     * Creates a new instance of {@link module:link/utils/manualdecorator~ManualDecorator}.
-     *
-     * @param config.id The name of the attribute used in the model that represents a given manual decorator.
-     * For example: `'linkIsExternal'`.
-     * @param config.label The label used in the user interface to toggle the manual decorator.
-     * @param config.attributes A set of attributes added to output data when the decorator is active for a specific link.
-     * Attributes should keep the format of attributes defined in {@link module:engine/view/elementdefinition~ElementDefinition}.
-     * @param [config.defaultValue] Controls whether the decorator is "on" by default.
-     */
-    constructor({ id, label, attributes, classes, styles, defaultValue }: NormalizedLinkDecoratorManualDefinition);
-    /**
-     * Returns {@link module:engine/view/matcher~MatcherPattern} with decorator attributes.
-     *
-     * @internal
-     */
-    _createPattern(): MatcherObjectPattern;
-}
-export {};

package/dist/utils.d.ts

@@ -1,90 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module link/utils
- */
-import type { DowncastConversionApi, Element, Schema, ViewAttributeElement, ViewNode, ViewDocumentFragment } from 'ckeditor5/src/engine.js';
-import type { Editor } from 'ckeditor5/src/core.js';
-import type { LocaleTranslate } from 'ckeditor5/src/utils.js';
-import type { LinkDecoratorAutomaticDefinition, LinkDecoratorDefinition, LinkDecoratorManualDefinition } from './linkconfig.js';
-import type { LinkActionsViewOptions } from './ui/linkactionsview.js';
-/**
- * A keystroke used by the {@link module:link/linkui~LinkUI link UI feature}.
- */
-export declare const LINK_KEYSTROKE = "Ctrl+K";
-/**
- * Returns `true` if a given view node is the link element.
- */
-export declare function isLinkElement(node: ViewNode | ViewDocumentFragment): boolean;
-/**
- * Creates a link {@link module:engine/view/attributeelement~AttributeElement} with the provided `href` attribute.
- */
-export declare function createLinkElement(href: string, { writer }: DowncastConversionApi): ViewAttributeElement;
-/**
- * Returns a safe URL based on a given value.
- *
- * A URL is considered safe if it is safe for the user (does not contain any malicious code).
- *
- * If a URL is considered unsafe, a simple `"#"` is returned.
- *
- * @internal
- */
-export declare function ensureSafeUrl(url: unknown, allowedProtocols?: Array<string>): string;
-/**
- * Returns the {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} configuration processed
- * to respect the locale of the editor, i.e. to display the {@link module:link/linkconfig~LinkDecoratorManualDefinition label}
- * in the correct language.
- *
- * **Note**: Only the few most commonly used labels are translated automatically. Other labels should be manually
- * translated in the {@link module:link/linkconfig~LinkConfig#decorators `config.link.decorators`} configuration.
- *
- * @param t Shorthand for {@link module:utils/locale~Locale#t Locale#t}.
- * @param decorators The decorator reference where the label values should be localized.
- */
-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.
- */
-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;
-/**
- * Returns `true` if the specified `value` is an email.
- */
-export declare function isEmail(value: string): boolean;
-/**
- * Adds the protocol prefix to the specified `link` when:
- *
- * * it does not contain it already, and there is a {@link module:link/linkconfig~LinkConfig#defaultProtocol `defaultProtocol` }
- * configuration value provided,
- * * or the link is an email address.
- */
-export declare function addLinkProtocolIfApplicable(link: string, defaultProtocol?: string): string;
-/**
- * Checks if protocol is already included in the link.
- */
-export declare function linkHasProtocol(link: string): boolean;
-/**
- * Opens the link in a new browser tab.
- */
-export declare function openLink(link: string): void;
-/**
- * Creates the bookmark callbacks for handling link opening experience.
- */
-export declare function createBookmarkCallbacks(editor: Editor): LinkActionsViewOptions;
-export type NormalizedLinkDecoratorAutomaticDefinition = LinkDecoratorAutomaticDefinition & {
-    id: string;
-};
-export type NormalizedLinkDecoratorManualDefinition = LinkDecoratorManualDefinition & {
-    id: string;
-};
-export type NormalizedLinkDecoratorDefinition = NormalizedLinkDecoratorAutomaticDefinition | NormalizedLinkDecoratorManualDefinition;