docs: update MentionOption interface (#16)

opentiny · Aug 24, 2024 · 6b465ec · 6b465ec
1 parent b6b72c2
commit 6b465ec
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 15 deletions.
diff --git a/packages/docs/fluent-editor/docs/mention.md b/packages/docs/fluent-editor/docs/mention.md
@@ -5,10 +5,24 @@
 `mention` 模块配置项：
 
 ```typescript
-interface IMentionOptions {
-  itemKey: string,
-  searchKey: string,
-  search: (term: string) => object[]
+interface MentionOption {
+  containerClass?: string;
+  dataAttributes?: string[];
+  defaultLink?: string;
+  itemActiveClass?: string;
+  itemKey: string;
+  itemClass?: string;
+  listClass?: string;
+  listHideClass?: string;
+  maxHeight?: number;
+  mentionChar?: string;
+  remove?: (data: any) => void;
+  renderMentionItem?: (data: any) => HTMLElement;
+  renderMentionText?: (data: any) => HTMLElement | string;
+  search?: (term: string) => Promise<any[]>;
+  searchKey: string;
+  select?: (data: any) => void;
+  target?: string;
 }
 ```
 

diff --git a/packages/fluent-editor/src/mention/Mention.ts b/packages/fluent-editor/src/mention/Mention.ts
@@ -7,23 +7,23 @@ const { Scope } = Quill.imports['parchment'];
 const Delta = Quill.imports['delta'];
 
 interface MentionOption {
-  remove?: (data: any) => void;
+  containerClass?: string;
+  dataAttributes?: string[];
   defaultLink?: string;
-  target?: string;
-  mentionChar?: string;
+  itemActiveClass?: string;
+  itemKey: string;
+  itemClass?: string;
+  listClass?: string;
+  listHideClass?: string;
   maxHeight?: number;
-  search?: (term: string) => Promise<any[]>;
+  mentionChar?: string;
+  remove?: (data: any) => void;
   renderMentionItem?: (data: any) => HTMLElement;
   renderMentionText?: (data: any) => HTMLElement | string;
-  containerClass?: string;
-  listClass?: string;
-  listHideClass?: string;
+  search?: (term: string) => Promise<any[]>;
   searchKey: string;
-  itemKey: string;
-  itemClass?: string;
-  itemActiveClass?: string;
-  dataAttributes?: string[];
   select?: (data: any) => void;
+  target?: string;
 }
 
 // @dynamic