feat: #743 增加联想、全角符号提示的配置能力

Tencent · Apr 14, 2024 · 5f43a52 · 5f43a52
1 parent 92987ab
commit 5f43a52
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 0 deletions.
diff --git a/examples/scripts/index-demo.js b/examples/scripts/index-demo.js
@@ -100,6 +100,7 @@ var basicConfig = {
     syntax: {
       codeBlock: {
         theme: 'twilight',
+        lineNumber: true, // 默认显示行号
       },
       table: {
         enableChart: false,
@@ -218,6 +219,8 @@ var basicConfig = {
     name: 'cherry-text',
     autoSave2Textarea: true,
     defaultModel: 'edit&preview',
+    showFullWidthMark: true, // 是否高亮全角符号 ·|￥|、|：|“|”|【|】|（|）|《|》
+    showSuggestList: true, // 是否显示联想框
   },
   // cherry初始化后是否检查 location.hash 尝试滚动到对应位置
   autoScrollByHashAfterInit: true,

diff --git a/src/Cherry.config.js b/src/Cherry.config.js
@@ -271,6 +271,8 @@ const defaultConfig = {
     },
     writingStyle: 'normal', // 书写风格，normal 普通 | typewriter 打字机 | focus 专注，默认normal
     keepDocumentScrollAfterInit: false, // 在初始化后是否保持网页的滚动，true：保持滚动；false：网页自动滚动到cherry初始化的位置
+    showFullWidthMark: true, // 是否高亮全角符号 ·|￥|、|：|“|”|【|】|（|）|《|》
+    showSuggestList: true, // 是否显示联想框
   },
   toolbars: {
     theme: 'dark', // light or dark

diff --git a/src/Editor.js b/src/Editor.js
@@ -66,6 +66,8 @@ export default class Editor {
       wrapperDom: null,
       autoScrollByCursor: true,
       convertWhenPaste: true,
+      showFullWidthMark: true,
+      showSuggestList: true,
       codemirror: {
         lineNumbers: false, // 显示行数
         cursorHeight: 0.85, // 光标高度，0.85好看一些
@@ -163,6 +165,9 @@ export default class Editor {
    * full width翻译为全角
    */
   formatFullWidthMark() {
+    if (!this.options.showFullWidthMark) {
+      return;
+    }
     const { editor } = this;
     const regex = /[·￥、：“”【】（）《》]/; // 此处以仅匹配单个全角符号
     const searcher = editor.getSearchCursor(regex);

diff --git a/src/core/hooks/Suggester.js b/src/core/hooks/Suggester.js
@@ -248,6 +248,9 @@ class SuggesterPanel {
   }
 
   bindEvent() {
+    if (!this.editor.options.showSuggestList) {
+      return;
+    }
     let keyAction = false;
     this.editor.editor.on('change', (codemirror, evt) => {
       keyAction = true;

diff --git a/types/cherry.d.ts b/types/cherry.d.ts
@@ -153,6 +153,10 @@ export interface CherryEditorOptions {
   editor?: CodeMirror.Editor;
   /** 在初始化后是否保持网页的滚动，true：保持滚动；false：网页自动滚动到cherry初始化的位置 */
   keepDocumentScrollAfterInit?: boolean;
+  /** 是否高亮全角符号 ·|￥|、|：|“|”|【|】|（|）|《|》 */
+  showFullWidthMark?: boolean;
+  /** 是否显示联想框 */
+  showSuggestList?: boolean;
 }
 
 export type CherryLifecycle = (text: string, html: string) => void;

diff --git a/types/editor.d.ts b/types/editor.d.ts
@@ -47,6 +47,10 @@ export type EditorConfiguration = {
   value?: string;
   convertWhenPaste?: boolean;
   keepDocumentScrollAfterInit?: boolean;
+  /** 是否高亮全角符号 ·|￥|、|：|“|”|【|】|（|）|《|》 */
+  showFullWidthMark?: boolean;
+  /** 是否显示联想框 */
+  showSuggestList?: boolean;
   codemirror: CodeMirror.EditorConfiguration;
   onKeydown: EditorEventCallback<EditorEventMap['onKeydown']>;
   onFocus: EditorEventCallback<EditorEventMap['onFocus']>;