@ckeditor/ckeditor5-widget 41.1.0 → 41.3.0-alpha.0

package/dist/types/augmentation.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Widget, WidgetResize, WidgetToolbarRepository, WidgetTypeAround } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Widget.pluginName]: Widget;
+        [WidgetResize.pluginName]: WidgetResize;
+        [WidgetToolbarRepository.pluginName]: WidgetToolbarRepository;
+        [WidgetTypeAround.pluginName]: WidgetTypeAround;
+    }
+}

package/dist/types/highlightstack.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @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
+ */
+import type { DowncastWriter, HighlightDescriptor } from '@ckeditor/ckeditor5-engine';
+declare const HighlightStack_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
+};
+/**
+ * Class used to handle the correct order of highlights on elements.
+ *
+ * When different highlights are applied to same element the correct order should be preserved:
+ *
+ * * highlight with highest priority should be applied,
+ * * if two highlights have same priority - sort by CSS class provided in
+ * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
+ *
+ * This way, highlight will be applied with the same rules it is applied on texts.
+ */
+export default class HighlightStack extends HighlightStack_base {
+    private readonly _stack;
+    /**
+     * Adds highlight descriptor to the stack.
+     *
+     * @fires change:top
+     */
+    add(descriptor: HighlightDescriptor, writer: DowncastWriter): void;
+    /**
+     * Removes highlight descriptor from the stack.
+     *
+     * @fires change:top
+     * @param id Id of the descriptor to remove.
+     */
+    remove(id: string, writer: DowncastWriter): void;
+    /**
+     * Inserts a given descriptor in correct place in the stack. It also takes care about updating information
+     * when descriptor with same id is already present.
+     */
+    private _insertDescriptor;
+    /**
+     * Removes descriptor with given id from the stack.
+     *
+     * @param id Descriptor's id.
+     */
+    private _removeDescriptor;
+}
+/**
+ * Fired when top element on {@link module:widget/highlightstack~HighlightStack} has been changed
+ *
+ * @eventName ~HighlightStack#change:top
+ */
+export type HighlightStackChangeEvent = {
+    name: 'change' | 'change:top';
+    args: [HighlightStackChangeEventData];
+};
+/**
+ * Additional information about the change.
+ */
+export type HighlightStackChangeEventData = {
+    /**
+     * Old highlight descriptor. It will be `undefined` when first descriptor is added to the stack.
+     */
+    oldDescriptor: HighlightDescriptor;
+    /**
+     * New highlight descriptor. It will be `undefined` when last descriptor is removed from the stack.
+     */
+    newDescriptor: HighlightDescriptor;
+    /**
+     * View writer that can be used to modify element.
+     */
+    writer: DowncastWriter;
+};
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module widget
+ */
+export { default as Widget } from './widget.js';
+export { default as WidgetToolbarRepository } from './widgettoolbarrepository.js';
+export { default as WidgetResize } from './widgetresize.js';
+export { default as WidgetTypeAround } from './widgettypearound/widgettypearound.js';
+export * from './utils.js';
+import './augmentation.js';

package/dist/types/utils.d.ts

@@ -0,0 +1,198 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module widget/utils
+ */
+import { type GetCallback } from '@ckeditor/ckeditor5-utils';
+import { type HighlightDescriptor, type MapperViewToModelPositionEvent, type DocumentSelection, type DowncastWriter, type Model, type Range, type Selection, type ViewEditableElement, type ViewElement, type ViewTypeCheckable } from '@ckeditor/ckeditor5-engine';
+/**
+ * CSS class added to each widget element.
+ */
+export declare const WIDGET_CLASS_NAME = "ck-widget";
+/**
+ * CSS class added to currently selected widget element.
+ */
+export declare const WIDGET_SELECTED_CLASS_NAME = "ck-widget_selected";
+/**
+ * Returns `true` if given {@link module:engine/view/node~Node} is an {@link module:engine/view/element~Element} and a widget.
+ */
+export declare function isWidget(node: ViewTypeCheckable): boolean;
+/**
+ * Converts the given {@link module:engine/view/element~Element} to a widget in the following way:
+ *
+ * * sets the `contenteditable` attribute to `"false"`,
+ * * adds the `ck-widget` CSS class,
+ * * adds a custom {@link module:engine/view/element~Element#getFillerOffset `getFillerOffset()`} method returning `null`,
+ * * adds a custom property allowing to recognize widget elements by using {@link ~isWidget `isWidget()`},
+ * * implements the {@link ~setHighlightHandling view highlight on widgets}.
+ *
+ * This function needs to be used in conjunction with
+ * {@link module:engine/conversion/downcasthelpers~DowncastHelpers downcast conversion helpers}
+ * like {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToElement `elementToElement()`}.
+ * Moreover, typically you will want to use `toWidget()` only for `editingDowncast`, while keeping the `dataDowncast` clean.
+ *
+ * For example, in order to convert a `<widget>` model element to `<div class="widget">` in the view, you can define
+ * such converters:
+ *
+ * ```ts
+ * editor.conversion.for( 'editingDowncast' )
+ * 	.elementToElement( {
+ * 		model: 'widget',
+ * 		view: ( modelItem, { writer } ) => {
+ * 			const div = writer.createContainerElement( 'div', { class: 'widget' } );
+ *
+ * 			return toWidget( div, writer, { label: 'some widget' } );
+ * 		}
+ * 	} );
+ *
+ * editor.conversion.for( 'dataDowncast' )
+ * 	.elementToElement( {
+ * 		model: 'widget',
+ * 		view: ( modelItem, { writer } ) => {
+ * 			return writer.createContainerElement( 'div', { class: 'widget' } );
+ * 		}
+ * 	} );
+ * ```
+ *
+ * See the full source code of the widget (with a nested editable) schema definition and converters in
+ * [this sample](https://github.com/ckeditor/ckeditor5-widget/blob/master/tests/manual/widget-with-nestededitable.js).
+ *
+ * @param options Additional options.
+ * @param options.label Element's label provided to the {@link ~setLabel} function. It can be passed as
+ * a plain string or a function returning a string. It represents the widget for assistive technologies (like screen readers).
+ * @param options.hasSelectionHandle If `true`, the widget will have a selection handle added.
+ * @returns Returns the same element.
+ */
+export declare function toWidget(element: ViewElement, writer: DowncastWriter, options?: {
+    label?: string | (() => string);
+    hasSelectionHandle?: boolean;
+}): ViewElement;
+/**
+ * Sets highlight handling methods. Uses {@link module:widget/highlightstack~HighlightStack} to
+ * properly determine which highlight descriptor should be used at given time.
+ */
+export declare function setHighlightHandling(element: ViewElement, writer: DowncastWriter, add?: (element: ViewElement, descriptor: HighlightDescriptor, writer: DowncastWriter) => void, remove?: (element: ViewElement, descriptor: HighlightDescriptor, writer: DowncastWriter) => void): void;
+/**
+ * Sets label for given element.
+ * It can be passed as a plain string or a function returning a string. Function will be called each time label is retrieved by
+ * {@link ~getLabel `getLabel()`}.
+ */
+export declare function setLabel(element: ViewElement, labelOrCreator: string | (() => string)): void;
+/**
+ * Returns the label of the provided element.
+ */
+export declare function getLabel(element: ViewElement): string;
+/**
+ * Adds functionality to the provided {@link module:engine/view/editableelement~EditableElement} to act as a widget's editable:
+ *
+ * * sets the `contenteditable` attribute to `true` when {@link module:engine/view/editableelement~EditableElement#isReadOnly} is `false`,
+ * otherwise sets it to `false`,
+ * * adds the `ck-editor__editable` and `ck-editor__nested-editable` CSS classes,
+ * * adds the `ck-editor__nested-editable_focused` CSS class when the editable is focused and removes it when it is blurred.
+ * * implements the {@link ~setHighlightHandling view highlight on widget's editable}.
+ *
+ * Similarly to {@link ~toWidget `toWidget()`} this function should be used in `editingDowncast` only and it is usually
+ * used together with {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToElement `elementToElement()`}.
+ *
+ * For example, in order to convert a `<nested>` model element to `<div class="nested">` in the view, you can define
+ * such converters:
+ *
+ * ```ts
+ * editor.conversion.for( 'editingDowncast' )
+ * 	.elementToElement( {
+ * 		model: 'nested',
+ * 		view: ( modelItem, { writer } ) => {
+ * 			const div = writer.createEditableElement( 'div', { class: 'nested' } );
+ *
+ * 			return toWidgetEditable( nested, writer, { label: 'label for editable' } );
+ * 		}
+ * 	} );
+ *
+ * editor.conversion.for( 'dataDowncast' )
+ * 	.elementToElement( {
+ * 		model: 'nested',
+ * 		view: ( modelItem, { writer } ) => {
+ * 			return writer.createContainerElement( 'div', { class: 'nested' } );
+ * 		}
+ * 	} );
+ * ```
+ *
+ * See the full source code of the widget (with nested editable) schema definition and converters in
+ * [this sample](https://github.com/ckeditor/ckeditor5-widget/blob/master/tests/manual/widget-with-nestededitable.js).
+ *
+ * @param options Additional options.
+ * @param options.label Editable's label used by assistive technologies (e.g. screen readers).
+ * @returns Returns the same element that was provided in the `editable` parameter
+ */
+export declare function toWidgetEditable(editable: ViewEditableElement, writer: DowncastWriter, options?: {
+    label?: string;
+}): ViewEditableElement;
+/**
+ * Returns a model range which is optimal (in terms of UX) for inserting a widget block.
+ *
+ * For instance, if a selection is in the middle of a paragraph, the collapsed range before this paragraph
+ * will be returned so that it is not split. If the selection is at the end of a paragraph,
+ * the collapsed range after this paragraph will be returned.
+ *
+ * Note: If the selection is placed in an empty block, the range in that block will be returned. If that range
+ * is then passed to {@link module:engine/model/model~Model#insertContent}, the block will be fully replaced
+ * by the inserted widget block.
+ *
+ * @param selection The selection based on which the insertion position should be calculated.
+ * @param model Model instance.
+ * @returns The optimal range.
+ */
+export declare function findOptimalInsertionRange(selection: Selection | DocumentSelection, model: Model): Range;
+/**
+ * A util to be used in order to map view positions to correct model positions when implementing a widget
+ * which renders non-empty view element for an empty model element.
+ *
+ * For example:
+ *
+ * ```
+ * // Model:
+ * <placeholder type="name"></placeholder>
+ *
+ * // View:
+ * <span class="placeholder">name</span>
+ * ```
+ *
+ * In such case, view positions inside `<span>` cannot be correctly mapped to the model (because the model element is empty).
+ * To handle mapping positions inside `<span class="placeholder">` to the model use this util as follows:
+ *
+ * ```ts
+ * editor.editing.mapper.on(
+ * 	'viewToModelPosition',
+ * 	viewToModelPositionOutsideModelElement( model, viewElement => viewElement.hasClass( 'placeholder' ) )
+ * );
+ * ```
+ *
+ * The callback will try to map the view offset of selection to an expected model position.
+ *
+ * 1. When the position is at the end (or in the middle) of the inline widget:
+ *
+ * ```
+ * // View:
+ * <p>foo <span class="placeholder">name|</span> bar</p>
+ *
+ * // Model:
+ * <paragraph>foo <placeholder type="name"></placeholder>| bar</paragraph>
+ * ```
+ *
+ * 2. When the position is at the beginning of the inline widget:
+ *
+ * ```
+ * // View:
+ * <p>foo <span class="placeholder">|name</span> bar</p>
+ *
+ * // Model:
+ * <paragraph>foo |<placeholder type="name"></placeholder> bar</paragraph>
+ * ```
+ *
+ * @param model Model instance on which the callback operates.
+ * @param viewElementMatcher Function that is passed a view element and should return `true` if the custom mapping
+ * should be applied to the given view element.
+ */
+export declare function viewToModelPositionOutsideModelElement(model: Model, viewElementMatcher: (element: ViewElement) => boolean): GetCallback<MapperViewToModelPositionEvent>;

package/dist/types/verticalnavigation.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module widget/verticalnavigation
+ */
+import { type GetCallback } from '@ckeditor/ckeditor5-utils';
+import type { EditingController, ViewDocumentArrowKeyEvent } from '@ckeditor/ckeditor5-engine';
+/**
+ * Returns 'keydown' handler for up/down arrow keys that modifies the caret movement if it's in a text line next to an object.
+ *
+ * @param editing The editing controller.
+ */
+export default function verticalNavigationHandler(editing: EditingController): GetCallback<ViewDocumentArrowKeyEvent>;

package/dist/types/widget.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module widget/widget
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { type Element, type Node } from '@ckeditor/ckeditor5-engine';
+import { Delete } from '@ckeditor/ckeditor5-typing';
+import WidgetTypeAround from './widgettypearound/widgettypearound.js';
+import '../theme/widget.css';
+/**
+ * The widget plugin. It enables base support for widgets.
+ *
+ * See {@glink api/widget package page} for more details and documentation.
+ *
+ * This plugin enables multiple behaviors required by widgets:
+ *
+ * * The model to view selection converter for the editing pipeline (it handles widget custom selection rendering).
+ * If a converted selection wraps around a widget element, that selection is marked as
+ * {@link module:engine/view/selection~Selection#isFake fake}. Additionally, the `ck-widget_selected` CSS class
+ * is added to indicate that widget has been selected.
+ * * The mouse and keyboard events handling on and around widget elements.
+ */
+export default class Widget extends Plugin {
+    /**
+     * Holds previously selected widgets.
+     */
+    private _previouslySelected;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Widget";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof WidgetTypeAround, typeof Delete];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Handles {@link module:engine/view/document~Document#event:mousedown mousedown} events on widget elements.
+     */
+    private _onMousedown;
+    /**
+     * Selects entire block content, e.g. on triple click it selects entire paragraph.
+     */
+    private _selectBlockContent;
+    /**
+     * Handles {@link module:engine/view/document~Document#event:keydown keydown} events and changes
+     * the model selection when:
+     *
+     * * arrow key is pressed when the widget is selected,
+     * * the selection is next to a widget and the widget should become selected upon the arrow key press.
+     *
+     * See {@link #_preventDefaultOnArrowKeyPress}.
+     */
+    private _handleSelectionChangeOnArrowKeyPress;
+    /**
+     * Handles {@link module:engine/view/document~Document#event:keydown keydown} events and prevents
+     * the default browser behavior to make sure the fake selection is not being moved from a fake selection
+     * container.
+     *
+     * See {@link #_handleSelectionChangeOnArrowKeyPress}.
+     */
+    private _preventDefaultOnArrowKeyPress;
+    /**
+     * Handles delete keys: backspace and delete.
+     *
+     * @param isForward Set to true if delete was performed in forward direction.
+     * @returns Returns `true` if keys were handled correctly.
+     */
+    private _handleDelete;
+    /**
+     * Sets {@link module:engine/model/selection~Selection document's selection} over given element.
+     *
+     * @internal
+     */
+    _setSelectionOverElement(element: Node): void;
+    /**
+     * Checks if {@link module:engine/model/element~Element element} placed next to the current
+     * {@link module:engine/model/selection~Selection model selection} exists and is marked in
+     * {@link module:engine/model/schema~Schema schema} as `object`.
+     *
+     * @internal
+     * @param forward Direction of checking.
+     */
+    _getObjectElementNextToSelection(forward: boolean): Element | null;
+    /**
+     * Removes CSS class from previously selected widgets.
+     */
+    private _clearPreviouslySelectedWidgets;
+}

package/dist/types/widgetresize/resizer.d.ts

@@ -0,0 +1,177 @@
+/**
+ * @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
+ */
+import { Rect, type DecoratedMethodEvent } from '@ckeditor/ckeditor5-utils';
+import ResizeState from './resizerstate.js';
+import type { ResizerOptions } from '../widgetresize.js';
+declare const Resizer_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Observable;
+    prototype: import("@ckeditor/ckeditor5-utils").Observable;
+};
+/**
+ * Represents a resizer for a single resizable object.
+ */
+export default class Resizer extends Resizer_base {
+    /**
+     * Flag that indicates whether resizer can be used.
+     *
+     * @observable
+     */
+    isEnabled: boolean;
+    /**
+     * Flag that indicates that resizer is currently focused.
+     *
+     * @observable
+     */
+    isSelected: boolean;
+    /**
+     * Flag that indicates whether resizer is rendered (visible on the screen).
+     *
+     * @readonly
+     * @observable
+     */
+    isVisible: boolean;
+    /**
+     * Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
+     *
+     * Note that a new state is created for each resize transaction.
+     */
+    private _state;
+    /**
+     * A view displaying the proposed new element size during the resizing.
+     */
+    private _sizeView;
+    /**
+     * Options passed to the {@link #constructor}.
+     */
+    private _options;
+    /**
+     * A wrapper that is controlled by the resizer. This is usually a widget element.
+     */
+    private _viewResizerWrapper;
+    /**
+     * The width of the resized {@link module:widget/widgetresize~ResizerOptions#viewElement viewElement} before the resizing started.
+     */
+    private _initialViewWidth;
+    /**
+     * @param options Resizer options.
+     */
+    constructor(options: ResizerOptions);
+    /**
+     * Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
+     *
+     * Note that a new state is created for each resize transaction.
+     */
+    get state(): ResizeState;
+    /**
+     * Makes resizer visible in the UI.
+     */
+    show(): void;
+    /**
+     * Hides resizer in the UI.
+     */
+    hide(): void;
+    /**
+     * Attaches the resizer to the DOM.
+     */
+    attach(): void;
+    /**
+     * Starts the resizing process.
+     *
+     * Creates a new {@link #state} for the current process.
+     *
+     * @fires begin
+     * @param domResizeHandle Clicked handle.
+     */
+    begin(domResizeHandle: HTMLElement): void;
+    /**
+     * Updates the proposed size based on `domEventData`.
+     *
+     * @fires updateSize
+     */
+    updateSize(domEventData: MouseEvent): void;
+    /**
+     * Applies the geometry proposed with the resizer.
+     *
+     * @fires commit
+     */
+    commit(): void;
+    /**
+     * Cancels and rejects the proposed resize dimensions, hiding the UI.
+     *
+     * @fires cancel
+     */
+    cancel(): void;
+    /**
+     * Destroys the resizer.
+     */
+    destroy(): void;
+    /**
+     * Redraws the resizer.
+     *
+     * @param handleHostRect Handle host rectangle might be given to improve performance.
+     */
+    redraw(handleHostRect?: Rect): void;
+    containsHandle(domElement: HTMLElement): boolean;
+    static isResizeHandle(domElement: HTMLElement): boolean;
+    /**
+     * Cleans up the context state.
+     */
+    private _cleanup;
+    /**
+     * Calculates the proposed size as the resize handles are dragged.
+     *
+     * @param domEventData Event data that caused the size update request. It should be used to calculate the proposed size.
+     */
+    private _proposeNewSize;
+    /**
+     * Obtains the resize host.
+     *
+     * Resize host is an object that receives dimensions which are the result of resizing.
+     */
+    private _getResizeHost;
+    /**
+     * Obtains the handle host.
+     *
+     * Handle host is an object that the handles are aligned to.
+     *
+     * Handle host will not always be an entire widget itself. Take an image as an example. The image widget
+     * contains an image and a caption. Only the image should be surrounded with handles.
+     */
+    private _getHandleHost;
+    /**
+     * DOM container of the entire resize UI.
+     *
+     * Note that this property will have a value only after the element bound with the resizer is rendered
+     * (otherwise `null`).
+     */
+    private get _domResizerWrapper();
+    /**
+     * Renders the resize handles in the DOM.
+     *
+     * @param domElement The resizer wrapper.
+     */
+    private _appendHandles;
+    /**
+     * Sets up the {@link #_sizeView} property and adds it to the passed `domElement`.
+     */
+    private _appendSizeUI;
+}
+/**
+ * @eventName ~Resizer#begin
+ */
+export type ResizerBeginEvent = DecoratedMethodEvent<Resizer, 'begin'>;
+/**
+ * @eventName ~Resizer#cancel
+ */
+export type ResizerCancelEvent = DecoratedMethodEvent<Resizer, 'cancel'>;
+/**
+ * @eventName ~Resizer#commit
+ */
+export type ResizerCommitEvent = DecoratedMethodEvent<Resizer, 'commit'>;
+/**
+ * @eventName ~Resizer#updateSize
+ */
+export type ResizerUpdateSizeEvent = DecoratedMethodEvent<Resizer, 'updateSize'>;
+export {};