feat: add plugin interface

Hufe921 · Jun 25, 2023 · ad0bb32 · ad0bb32
1 parent ca28454
commit ad0bb32
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/src/editor/core/plugin/Plugin.ts b/src/editor/core/plugin/Plugin.ts
@@ -0,0 +1,16 @@
+import Editor from '../..'
+import { PluginFunction } from '../../interface/Plugin'
+
+export class Plugin {
+
+  private editor: Editor
+
+  constructor(editor: Editor) {
+    this.editor = editor
+  }
+
+  public use<Options>(pluginFunction: PluginFunction<Options>, options?: Options) {
+    pluginFunction(this.editor, options)
+  }
+
+}
diff --git a/src/editor/index.ts b/src/editor/index.ts
@@ -45,13 +45,16 @@ import { ListStyle, ListType } from './dataset/enum/List'
 import { ICatalog, ICatalogItem } from './interface/Catalog'
 import { IPlaceholder } from './interface/Placeholder'
 import { defaultPlaceholderOption } from './dataset/constant/Placeholder'
+import { Plugin } from './core/plugin/Plugin'
+import { UsePlugin } from './interface/Plugin'
 
 export default class Editor {
 
   public command: Command
   public listener: Listener
   public register: Register
-  public destroy: Function
+  public destroy: () => void
+  public use: UsePlugin
 
   constructor(container: HTMLDivElement, data: IEditorData | IElement[], options: IEditorOption = {}) {
     const headerOptions: Required<IHeader> = {
@@ -185,6 +188,9 @@ export default class Editor {
       shortcut.removeEvent()
       contextMenu.removeEvent()
     }
+    // 插件
+    const plugin = new Plugin(this)
+    this.use = plugin.use.bind(plugin)
   }
 
 }

diff --git a/src/editor/interface/Plugin.ts b/src/editor/interface/Plugin.ts
@@ -0,0 +1,5 @@
+import Editor from '..'
+
+export type PluginFunction<Options> = (editor: Editor, options?: Options) => any;
+
+export type UsePlugin = <Options>(pluginFunction: PluginFunction<Options>, options?: Options) => void;