@ckeditor/ckeditor5-clipboard 41.2.0 → 41.3.0-alpha.1

package/dist/types/augmentation.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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 { Clipboard, ClipboardPipeline, PastePlainText, DragDrop, DragDropTarget, DragDropBlockToolbar, ClipboardMarkersUtils } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Clipboard.pluginName]: Clipboard;
+        [ClipboardPipeline.pluginName]: ClipboardPipeline;
+        [ClipboardMarkersUtils.pluginName]: ClipboardMarkersUtils;
+        [PastePlainText.pluginName]: PastePlainText;
+        [DragDrop.pluginName]: DragDrop;
+        [DragDropTarget.pluginName]: DragDropTarget;
+        [DragDropBlockToolbar.pluginName]: DragDropBlockToolbar;
+    }
+}

package/dist/types/clipboard.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @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 clipboard/clipboard
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import ClipboardPipeline from './clipboardpipeline.js';
+import DragDrop from './dragdrop.js';
+import PastePlainText from './pasteplaintext.js';
+import ClipboardMarkersUtils from './clipboardmarkersutils.js';
+/**
+ * The clipboard feature.
+ *
+ * Read more about the clipboard integration in the {@glink framework/deep-dive/clipboard clipboard deep-dive} guide.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ * * {@link module:clipboard/clipboardpipeline~ClipboardPipeline}
+ * * {@link module:clipboard/dragdrop~DragDrop}
+ * * {@link module:clipboard/pasteplaintext~PastePlainText}
+ */
+export default class Clipboard extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Clipboard";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof ClipboardPipeline, typeof DragDrop, typeof PastePlainText];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/clipboardmarkersutils.d.ts

@@ -0,0 +1,186 @@
+/**
+ * @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 { Plugin } from '@ckeditor/ckeditor5-core';
+import { Range, type Element, type DocumentFragment, type DocumentSelection, type Selection, type Writer } from '@ckeditor/ckeditor5-engine';
+/**
+ * Part of the clipboard logic. Responsible for collecting markers from selected fragments
+ * and restoring them with proper positions in pasted elements.
+ *
+ * @internal
+ */
+export default class ClipboardMarkersUtils extends Plugin {
+    /**
+     * Map of marker names that can be copied.
+     *
+     * @internal
+     */
+    private _markersToCopy;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ClipboardMarkersUtils";
+    /**
+     * Registers marker name as copyable in clipboard pipeline.
+     *
+     * @param markerName Name of marker that can be copied.
+     * @param restrictions Preset or specified array of actions that can be performed on specified marker name.
+     * @internal
+     */
+    _registerMarkerToCopy(markerName: string, restrictions: ClipboardMarkerRestrictionsPreset | Array<ClipboardMarkerRestrictedAction>): void;
+    /**
+     * Maps preset into array of clipboard operations to be allowed on marker.
+     *
+     * @param preset Restrictions preset to be mapped to actions
+     * @internal
+     */
+    private _mapRestrictionPresetToActions;
+    /**
+     * Performs copy markers on provided selection and paste it to fragment returned from `getCopiedFragment`.
+     *
+     * 	1. Picks all markers in provided selection.
+     * 	2. Inserts fake markers to document.
+     * 	3. Gets copied selection fragment from document.
+     * 	4. Removes fake elements from fragment and document.
+     * 	5. Inserts markers in the place of removed fake markers.
+     *
+     * Due to selection modification, when inserting items, `getCopiedFragment` must *always* operate on `writer.model.document.selection'.
+     * Do not use any other custom selection object within callback, as this will lead to out-of-bounds exceptions in rare scenarios.
+     *
+     * @param action Type of clipboard action.
+     * @param writer An instance of the model writer.
+     * @param selection Selection to be checked.
+     * @param getCopiedFragment	Callback that performs copy of selection and returns it as fragment.
+     * @internal
+     */
+    _copySelectedFragmentWithMarkers(action: ClipboardMarkerRestrictedAction, selection: Selection | DocumentSelection, getCopiedFragment?: (writer: Writer) => DocumentFragment): DocumentFragment;
+    /**
+     * Performs paste of markers on already pasted element.
+     *
+     * 	1. Inserts fake markers that are present in fragment element (such fragment will be processed in `getPastedDocumentElement`).
+     * 	2. Calls `getPastedDocumentElement` and gets element that is inserted into root model.
+     * 	3. Removes all fake markers present in transformed element.
+     * 	4. Inserts new markers with removed fake markers ranges into pasted fragment.
+     *
+     * There are multiple edge cases that have to be considered before calling this function:
+     *
+     * 	* `markers` are inserted into the same element that must be later transformed inside `getPastedDocumentElement`.
+     * 	* Fake marker elements inside `getPastedDocumentElement` can be cloned, but their ranges cannot overlap.
+     *
+     * @param action Type of clipboard action.
+     * @param markers Object that maps marker name to corresponding range.
+     * @param getPastedDocumentElement Getter used to get target markers element.
+     * @internal
+     */
+    _pasteMarkersIntoTransformedElement(markers: Record<string, Range> | Map<string, Range>, getPastedDocumentElement: (writer: Writer) => Element): Element;
+    /**
+     * In some situations we have to perform copy on selected fragment with certain markers. This function allows to temporarily bypass
+     * restrictions on markers that we want to copy.
+     *
+     * This function executes `executor()` callback. For the duration of the callback, if the clipboard pipeline is used to copy
+     * content, markers with the specified name will be copied to the clipboard as well.
+     *
+     * @param markerName Which markers should be copied.
+     * @param executor Callback executed.
+     * @internal
+     */
+    _forceMarkersCopy(markerName: string, executor: VoidFunction): void;
+    /**
+     * Checks if marker can be copied.
+     *
+     * @param markerName Name of checked marker.
+     * @param action Type of clipboard action. If null then checks only if marker is registered as copyable.
+     * @internal
+     */
+    _canPerformMarkerClipboardAction(markerName: string, action: ClipboardMarkerRestrictedAction | null): boolean;
+    /**
+     * Changes marker names for markers stored in given document fragment so that they are unique.
+     *
+     * @param fragment
+     * @internal
+     */
+    _setUniqueMarkerNamesInFragment(fragment: DocumentFragment): void;
+    /**
+     * First step of copying markers. It looks for markers intersecting with given selection and inserts `$marker` elements
+     * at positions where document markers start or end. This way `$marker` elements can be easily copied together with
+     * the rest of the content of the selection.
+     *
+     * @param writer An instance of the model writer.
+     * @param selection Selection to be checked.
+     * @param action Type of clipboard action.
+     */
+    private _insertFakeMarkersIntoSelection;
+    /**
+     * Returns array of markers that can be copied in specified selection.
+     *
+     * @param writer An instance of the model writer.
+     * @param selection  Selection which will be checked.
+     * @param action Type of clipboard action. If null then checks only if marker is registered as copyable.
+     */
+    private _getCopyableMarkersFromSelection;
+    /**
+     * Picks all markers from markers map that can be copied.
+     *
+     * @param markers Object that maps marker name to corresponding range.
+     * @param action Type of clipboard action. If null then checks only if marker is registered as copyable.
+     */
+    private _getCopyableMarkersFromRangeMap;
+    /**
+     * Inserts specified array of fake markers elements to document and assigns them `type` and `name` attributes.
+     * Fake markers elements are used to calculate position of markers on pasted fragment that were transformed during
+     * steps between copy and paste.
+     *
+     * @param writer An instance of the model writer.
+     * @param markers Array of markers that will be inserted.
+     */
+    private _insertFakeMarkersElements;
+    /**
+     * Removes all `$marker` elements from the given document fragment.
+     *
+     * Returns an object where keys are marker names, and values are ranges corresponding to positions
+     * where `$marker` elements were inserted.
+     *
+     * If the document fragment had only one `$marker` element for given marker (start or end) the other boundary is set automatically
+     * (to the end or start of the document fragment, respectively).
+     *
+     * @param writer An instance of the model writer.
+     * @param rootElement The element to be checked.
+     */
+    private _removeFakeMarkersInsideElement;
+    /**
+     * Returns array that contains list of fake markers with corresponding `$marker` elements.
+     *
+     * For each marker, there can be two `$marker` elements or only one (if the document fragment contained
+     * only the beginning or only the end of a marker).
+     *
+     * @param writer An instance of the model writer.
+     * @param rootElement The element to be checked.
+     */
+    private _getAllFakeMarkersFromElement;
+    /**
+     * When copy of markers occurs we have to make sure that pasted markers have different names
+     * than source markers. This functions helps with assigning unique part to marker name to
+     * prevent duplicated markers error.
+     *
+     * @param name Name of marker
+     */
+    private _getUniqueMarkerName;
+}
+/**
+ * Specifies which action is performed during clipboard event.
+ *
+ * @internal
+ */
+export type ClipboardMarkerRestrictedAction = 'copy' | 'cut' | 'dragstart';
+/**
+ * Specifies copy, paste or move marker restrictions in clipboard. Depending on specified mode
+ * it will disallow copy, cut or paste of marker in clipboard.
+ *
+ * 	* `'default'` - the markers will be preserved on cut-paste and drag and drop actions only.
+ * 	* `'always'` - the markers will be preserved on all clipboard actions (cut, copy, drag and drop).
+ * 	* `'never'` - the markers will be ignored by clipboard.
+ *
+ * @internal
+ */
+export type ClipboardMarkerRestrictionsPreset = 'default' | 'always' | 'never';

package/dist/types/clipboardobserver.d.ts

@@ -0,0 +1,312 @@
+/**
+ * @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 { DataTransfer, DomEventObserver, type DomEventData, type EditingView, type ViewDocumentFragment, type ViewElement, type ViewRange } from '@ckeditor/ckeditor5-engine';
+/**
+ * Clipboard events observer.
+ *
+ * Fires the following events:
+ *
+ * * {@link module:engine/view/document~Document#event:clipboardInput},
+ * * {@link module:engine/view/document~Document#event:paste},
+ * * {@link module:engine/view/document~Document#event:copy},
+ * * {@link module:engine/view/document~Document#event:cut},
+ * * {@link module:engine/view/document~Document#event:drop},
+ * * {@link module:engine/view/document~Document#event:dragover},
+ * * {@link module:engine/view/document~Document#event:dragging},
+ * * {@link module:engine/view/document~Document#event:dragstart},
+ * * {@link module:engine/view/document~Document#event:dragend},
+ * * {@link module:engine/view/document~Document#event:dragenter},
+ * * {@link module:engine/view/document~Document#event:dragleave}.
+ *
+ * **Note**: This observer is not available by default (ckeditor5-engine does not add it on its own).
+ * To make it available, it needs to be added to {@link module:engine/view/document~Document} by using
+ * the {@link module:engine/view/view~View#addObserver `View#addObserver()`} method. Alternatively, you can load the
+ * {@link module:clipboard/clipboard~Clipboard} plugin which adds this observer automatically (because it uses it).
+ */
+export default class ClipboardObserver extends DomEventObserver<'paste' | 'copy' | 'cut' | 'drop' | 'dragover' | 'dragstart' | 'dragend' | 'dragenter' | 'dragleave', ClipboardEventData> {
+    readonly domEventType: readonly ["paste", "copy", "cut", "drop", "dragover", "dragstart", "dragend", "dragenter", "dragleave"];
+    constructor(view: EditingView);
+    onDomEvent(domEvent: ClipboardEvent | DragEvent): void;
+}
+/**
+ * The data of 'paste', 'copy', 'cut', 'drop', 'dragover', 'dragstart', 'dragend', 'dragenter' and 'dragleave' events.
+ */
+export interface ClipboardEventData {
+    /**
+     * The data transfer instance.
+     */
+    dataTransfer: DataTransfer;
+    /**
+     * The position into which the content is dropped.
+     */
+    dropRange?: ViewRange | null;
+}
+/**
+ * Fired as a continuation of the {@link module:engine/view/document~Document#event:paste} and
+ * {@link module:engine/view/document~Document#event:drop} events.
+ *
+ * It is a part of the {@glink framework/deep-dive/clipboard#input-pipeline clipboard input pipeline}.
+ *
+ * This event carries a `dataTransfer` object which comes from the clipboard and whose content should be processed
+ * and inserted into the editor.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:clipboard/clipboardobserver~ClipboardObserver
+ * @see module:clipboard/clipboard~Clipboard
+ *
+ * @eventName module:engine/view/document~Document#clipboardInput
+ * @param data The event data.
+ */
+export type ViewDocumentClipboardInputEvent = {
+    name: 'clipboardInput';
+    args: [data: DomEventData<ClipboardEvent | DragEvent> & ClipboardInputEventData];
+};
+/**
+ * The value of the {@link module:engine/view/document~Document#event:paste},
+ * {@link module:engine/view/document~Document#event:copy} and {@link module:engine/view/document~Document#event:cut} events.
+ *
+ * In order to access the clipboard data, use the `dataTransfer` property.
+ */
+export interface ClipboardInputEventData {
+    /**
+     * Data transfer instance.
+     */
+    dataTransfer: DataTransfer;
+    /**
+     * Whether the event was triggered by a paste or a drop operation.
+     */
+    method: 'paste' | 'drop';
+    /**
+     * The tree view element representing the target.
+     */
+    target: ViewElement;
+    /**
+     * The ranges which are the target of the operation (usually – into which the content should be inserted).
+     * If the clipboard input was triggered by a paste operation, this property is not set. If by a drop operation,
+     * then it is the drop position (which can be different than the selection at the moment of the drop).
+     */
+    targetRanges: Array<ViewRange> | null;
+    /**
+     * The content of clipboard input.
+     */
+    content?: ViewDocumentFragment;
+}
+/**
+ * Fired when the user drags the content over one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#dragover
+ * @param data The event data.
+ */
+export type ViewDocumentDragOverEvent = {
+    name: 'dragover';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user dropped the content into one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#drop
+ * @param data The event data.
+ */
+export type ViewDocumentDropEvent = {
+    name: 'drop';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user pasted the content into one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#paste
+ * @param {module:clipboard/clipboardobserver~ClipboardEventData} data The event data.
+ */
+export type ViewDocumentPasteEvent = {
+    name: 'paste';
+    args: [data: DomEventData<ClipboardEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user copied the content from one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:clipboard/clipboardobserver~ClipboardObserver
+ *
+ * @eventName module:engine/view/document~Document#copy
+ * @param data The event data.
+ */
+export type ViewDocumentCopyEvent = {
+    name: 'copy';
+    args: [data: DomEventData<ClipboardEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user cut the content from one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:clipboard/clipboardobserver~ClipboardObserver
+ *
+ * @eventName module:engine/view/document~Document#cut
+ * @param data The event data.
+ */
+export type ViewDocumentCutEvent = {
+    name: 'cut';
+    args: [data: DomEventData<ClipboardEvent> & ClipboardEventData];
+};
+/**
+ * Fired as a continuation of the {@link module:engine/view/document~Document#event:dragover} event.
+ *
+ * It is a part of the {@glink framework/deep-dive/clipboard#input-pipeline clipboard input pipeline}.
+ *
+ * This event carries a `dataTransfer` object which comes from the clipboard and whose content should be processed
+ * and inserted into the editor.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:clipboard/clipboardobserver~ClipboardObserver
+ * @see module:clipboard/clipboard~Clipboard
+ *
+ * @eventName module:engine/view/document~Document#dragging
+ * @param data The event data.
+ */
+export type ViewDocumentDraggingEvent = {
+    name: 'dragging';
+    args: [data: DomEventData<DragEvent> & DraggingEventData];
+};
+export interface DraggingEventData {
+    /**
+     * The data transfer instance.
+     */
+    dataTransfer: DataTransfer;
+    /**
+     * Whether the event was triggered by a paste or a drop operation.
+     */
+    method: 'dragover';
+    /**
+     * The tree view element representing the target.
+     */
+    target: Element;
+    /**
+     * Ranges which are the target of the operation (usually – into which the content should be inserted).
+     * It is the drop position (which can be different than the selection at the moment of drop).
+     */
+    targetRanges: Array<ViewRange> | null;
+}
+/**
+ * Fired when the user starts dragging the content in one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#dragstart
+ * @param data The event data.
+ */
+export type ViewDocumentDragStartEvent = {
+    name: 'dragstart';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user ended dragging the content.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#dragend
+ * @param data The event data.
+ */
+export type ViewDocumentDragEndEvent = {
+    name: 'dragend';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user drags the content into one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#dragenter
+ * @param data The event data.
+ */
+export type ViewDocumentDragEnterEvent = {
+    name: 'dragenter';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};
+/**
+ * Fired when the user drags the content out of one of the editing roots of the editor.
+ *
+ * Introduced by {@link module:clipboard/clipboardobserver~ClipboardObserver}.
+ *
+ * **Note**: This event is not available by default. To make it available, {@link module:clipboard/clipboardobserver~ClipboardObserver}
+ * needs to be added to the {@link module:engine/view/document~Document} by using the {@link module:engine/view/view~View#addObserver}
+ * method. This is usually done by the {@link module:clipboard/clipboard~Clipboard} plugin, but if for some reason it is not loaded,
+ * the observer must be added manually.
+ *
+ * @see module:engine/view/document~Document#event:clipboardInput
+ *
+ * @eventName module:engine/view/document~Document#dragleave
+ * @param data The event data.
+ */
+export type ViewDocumentDragLeaveEvent = {
+    name: 'dragleave';
+    args: [data: DomEventData<DragEvent> & ClipboardEventData];
+};