fix(type): add key name declaration for custom toolbar

Added some usage notes
Tencent · Sep 29, 2024 · 78364a8 · 78364a8
1 parent 1193729
commit 78364a8
Showing 1 changed file with 19 additions and 2 deletions.
diff --git a/types/cherry.d.ts b/types/cherry.d.ts
@@ -3,11 +3,27 @@ import SyntaxBase from '../src/core/SyntaxBase';
 import { FormulaMenu } from '@/toolbars/BubbleFormula';
 
 export interface CherryExternalsOptions {
-  [key: symbol]: any;
+  [key: string]: any;
 }
 
+/**
+* 自定义toolbar键名[key]
+*/
+export interface CustomMenuType {
+  [key: string]: any;
+}
+
+
+/**
+* 自定义按钮功能
+* example:
+* `customMenu:{
+*    customMenu_fileUpload: any,
+* }`
+* 其中`customMenu`是自定按钮的固定属性，`customMenu_fileUpload`是自定义按钮的键名
+*/
 type CherryToolbarsCustomType = {
-  CustomMenuType: CherryExternalsOptions
+  CustomMenuType: CustomMenuType
 }
 
 type CherryCustomOptions = {
@@ -532,6 +548,7 @@ export interface CherryToolbarsOptions<F extends CherryToolbarsCustomType = Cher
   toolbar?:
   | (CherryDefaultBubbleToolbar |
     CherryDefaultToolbar |
+    keyof Partial<F['CustomMenuType']> |
   { [K in (keyof Partial<F['CustomMenuType']>) | CherryDefaultToolbar]?: (keyof F['CustomMenuType'] | CherryDefaultToolbar)[] })[]
   | false;
   toolbarRight?: