@ckeditor/ckeditor5-clipboard 38.0.1 → 38.1.1

package/src/clipboardobserver.d.ts

@@ -1,312 +1,312 @@
-/**
- * @license Copyright (c) 2003-2023, 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 View, 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: View);
-    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];
-};
+/**
+ * @license Copyright (c) 2003-2023, 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 View, 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: View);
+    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];
+};