feat: #714 增加粘贴的回调

Tencent · Mar 13, 2024 · e9154f6 · e9154f6
1 parent 0570a6d
commit e9154f6
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git a/examples/scripts/preview-demo.js b/examples/scripts/preview-demo.js
@@ -62,6 +62,11 @@ var cherryConfig = {
   },
   toolbars: {
     toolbar: false,
+    // 配置目录
+    toc: {
+      updateLocationHash: false, // 要不要更新URL的hash
+      defaultModel: 'full', // pure: 精简模式/缩略模式，只有一排小点； full: 完整模式，会展示所有标题
+    },
   },
   editor: {
     defaultModel: 'previewOnly',

diff --git a/src/Cherry.config.js b/src/Cherry.config.js
@@ -56,6 +56,16 @@ const callbacks = {
   afterInit: (text, html) => {},
   beforeImageMounted: (srcProp, src) => ({ srcProp, src }),
   onClickPreview: (event) => {},
+  /**
+   * 粘贴时触发
+   * @param {ClipboardEvent['clipboardData']} clipboardData
+   * @returns
+   *    false: 走cherry粘贴的默认逻辑
+   *    string: 直接粘贴的内容
+   */
+  onPaste: (clipboardData) => {
+    return false;
+  },
   onCopyCode: (event, code) => {
     // 阻止默认的粘贴事件
     // return false;
@@ -346,6 +356,14 @@ const defaultConfig = {
     onCopyCode: callbacks.onCopyCode,
     // 把中文变成拼音的回调，当然也可以把中文变成英文、英文变成中文
     changeString2Pinyin: callbacks.changeString2Pinyin,
+    /**
+     * 粘贴时触发
+     * @param {ClipboardEvent['clipboardData']} clipboardData
+     * @returns
+     *    false: 走cherry粘贴的默认逻辑
+     *    string: 直接粘贴的内容
+     */
+    onPaste: callbacks.onPaste,
   },
   previewer: {
     dom: false,

diff --git a/src/Editor.js b/src/Editor.js
@@ -265,6 +265,12 @@ export default class Editor {
    * @returns {boolean | void}
    */
   handlePaste(event, clipboardData, codemirror) {
+    const onPasteRet = this.$cherry.options.callback.onPaste(clipboardData);
+    if (onPasteRet !== false && typeof onPasteRet === 'string') {
+      event.preventDefault();
+      codemirror.replaceSelection(onPasteRet);
+      return;
+    }
     let html = clipboardData.getData('Text/Html');
     const { items } = clipboardData;
     // 清空注释

diff --git a/types/cherry.d.ts b/types/cherry.d.ts
@@ -43,6 +43,7 @@ export interface CherryOptions {
     onClickPreview: (e: MouseEvent) => void;
     onCopyCode: (e: ClipboardEvent, code: string) => string|false;
     changeString2Pinyin: (str: string) => string;
+    onPaste: (clipboardData: ClipboardEvent['clipboardData']) => string|boolean;
   };
   /** 预览区域配置 */
   previewer: CherryPreviewerOptions;