@ckeditor/ckeditor5-clipboard 48.1.1 → 48.2.0-alpha.0

package/dist/clipboardobserver.d.ts

@@ -93,9 +93,14 @@ export interface ClipboardInputEventData {
      */
     targetRanges: Array<ViewRange> | null;
     /**
-     * The content of clipboard input.
+     * The content of clipboard input. Defaults to `text/html`. Falls-back to `text/plain`.
      */
-    content?: ViewDocumentFragment;
+    content: string | ViewDocumentFragment;
+    /**
+     * Custom data stored by the `clipboardInput` event handlers. Custom properties of this object can be defined and use to
+     * pass parameters between listeners. Content of this property is passed to the `inputTransformation` event.
+     */
+    extraContent?: unknown;
 }
 /**
  * Fired when the user drags the content over one of the editing roots of the editor.

package/dist/clipboardpipeline.d.ts

@@ -133,6 +133,10 @@ export interface ClipboardInputTransformationData {
      * the {@glink framework/deep-dive/clipboard clipboard deep-dive} guide.
      */
     content: ViewDocumentFragment;
+    /**
+     * Custom data stored by the `clipboardInput` event handlers. Content of this property is passed from the `clipboardInput` event.
+     */
+    extraContent?: unknown;
     /**
      * The data transfer instance.
      */

package/dist/index.js

@@ -9,6 +9,34 @@ import { mapValues, throttle } from 'es-toolkit/compat';
 import { Widget, isWidget } from '@ckeditor/ckeditor5-widget/dist/index.js';
 import { View } from '@ckeditor/ckeditor5-ui/dist/index.js';
 
+/**
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */ /**
+ * @module clipboard/utils/plaintexttohtml
+ */ /**
+ * Converts plain text to its HTML-ized version.
+ *
+ * @param text The plain text to convert.
+ * @returns HTML generated from the plain text.
+ */ function plainTextToHtml(text) {
+    text = text// Encode &.
+    .replace(/&/g, '&amp;')// Encode <>.
+    .replace(/</g, '&lt;').replace(/>/g, '&gt;')// Creates a paragraph for each double line break.
+    .replace(/\r?\n\r?\n/g, '</p><p>')// Creates a line break for each single line break.
+    .replace(/\r?\n/g, '<br>')// Replace tabs with four spaces.
+    .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')// Preserve trailing spaces (only the first and last one – the rest is handled below).
+    .replace(/^\s/, '&nbsp;').replace(/\s$/, '&nbsp;')// Preserve other subsequent spaces now.
+    .replace(/\s\s/g, ' &nbsp;');
+    if (text.includes('</p><p>') || text.includes('<br>')) {
+        // If we created paragraphs above, add the trailing ones.
+        text = `<p>${text}</p>`;
+    }
+    // TODO:
+    // * What about '\nfoo' vs ' foo'?
+    return text;
+}
+
 /**
  * Clipboard events observer.
  *
@@ -60,9 +88,17 @@ import { View } from '@ckeditor/ckeditor5-ui/dist/index.js';
                 const targetRanges = data.dropRange ? [
                     data.dropRange
                 ] : null;
+                const dataTransfer = data.dataTransfer;
                 const eventInfo = new EventInfo(viewDocument, type);
+                let content = '';
+                if (dataTransfer.getData('text/html')) {
+                    content = dataTransfer.getData('text/html');
+                } else if (dataTransfer.getData('text/plain')) {
+                    content = plainTextToHtml(dataTransfer.getData('text/plain'));
+                }
                 viewDocument.fire(eventInfo, {
-                    dataTransfer: data.dataTransfer,
+                    dataTransfer,
+                    content,
                     method: evt.name,
                     targetRanges,
                     target: data.target,
@@ -93,34 +129,6 @@ import { View } from '@ckeditor/ckeditor5-ui/dist/index.js';
     }
 }
 
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */ /**
- * @module clipboard/utils/plaintexttohtml
- */ /**
- * Converts plain text to its HTML-ized version.
- *
- * @param text The plain text to convert.
- * @returns HTML generated from the plain text.
- */ function plainTextToHtml(text) {
-    text = text// Encode &.
-    .replace(/&/g, '&amp;')// Encode <>.
-    .replace(/</g, '&lt;').replace(/>/g, '&gt;')// Creates a paragraph for each double line break.
-    .replace(/\r?\n\r?\n/g, '</p><p>')// Creates a line break for each single line break.
-    .replace(/\r?\n/g, '<br>')// Replace tabs with four spaces.
-    .replace(/\t/g, '&nbsp;&nbsp;&nbsp;&nbsp;')// Preserve trailing spaces (only the first and last one – the rest is handled below).
-    .replace(/^\s/, '&nbsp;').replace(/\s$/, '&nbsp;')// Preserve other subsequent spaces now.
-    .replace(/\s\s/g, ' &nbsp;');
-    if (text.includes('</p><p>') || text.includes('<br>')) {
-        // If we created paragraphs above, add the trailing ones.
-        text = `<p>${text}</p>`;
-    }
-    // TODO:
-    // * What about '\nfoo' vs ' foo'?
-    return text;
-}
-
 /**
  * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
@@ -175,7 +183,7 @@ const listElements = [
         return viewItem.getAttribute('alt');
     }
     if (viewItem.is('element', 'br')) {
-        return '\n'; // Convert soft breaks to single line break (#8045).
+        return '\n'; // Convert soft breaks to single line break (https://github.com/ckeditor/ckeditor5/issues/8045).
     }
     /**
 	 * Item is a document fragment, attribute element or container element. It doesn't
@@ -880,25 +888,15 @@ const listElements = [
         });
         this.listenTo(viewDocument, 'clipboardInput', (evt, data)=>{
             const dataTransfer = data.dataTransfer;
-            let content;
-            // Some feature could already inject content in the higher priority event handler (i.e., codeBlock).
-            if (data.content) {
-                content = data.content;
-            } else {
-                let contentData = '';
-                if (dataTransfer.getData('text/html')) {
-                    contentData = normalizeClipboardData(dataTransfer.getData('text/html'));
-                } else if (dataTransfer.getData('text/plain')) {
-                    contentData = plainTextToHtml(dataTransfer.getData('text/plain'));
-                }
-                content = this.editor.data.htmlProcessor.toView(contentData);
-            }
             const eventInfo = new EventInfo(this, 'inputTransformation');
             const sourceEditorId = dataTransfer.getData('application/ckeditor5-editor-id') || null;
+            // Some feature could already inject content in the higher priority event handler (i.e., codeBlock, paste from office).
+            const content = typeof data.content == 'string' ? this.editor.data.htmlProcessor.toView(normalizeClipboardData(data.content)) : data.content;
             this.fire(eventInfo, {
                 content,
                 dataTransfer,
                 sourceEditorId,
+                extraContent: data.extraContent,
                 targetRanges: data.targetRanges,
                 method: data.method
             });