feat(engine): 开放workbench自定义

mazhaobo · mazhaobo · commit fb6bdb4520a5 · 2024-10-16T17:06:15.000+08:00
init参数增加WorkSpaceWorkbench和Workspace，以替换内置的框架结构
diff --git a/packages/engine/src/engine-core.ts b/packages/engine/src/engine-core.ts
@@ -30,7 +30,11 @@ import {
   PluginPreference,
   IDesigner,
 } from '@felce/lowcode-designer';
-import { Skeleton as InnerSkeleton, registerDefaults } from '@felce/lowcode-editor-skeleton';
+import {
+  Skeleton as InnerSkeleton,
+  registerDefaults,
+  ISkeleton,
+} from '@felce/lowcode-editor-skeleton';
 import {
   Workspace as InnerWorkspace,
   Workbench as WorkSpaceWorkbench,
@@ -108,10 +112,10 @@ globalContext.register(innerWorkspace, 'workspace');
 
 const engineContext: Partial<ILowCodePluginContextPrivate> = {};
 
-const innerSkeleton = new InnerSkeleton(editor);
+const innerSkeleton: ISkeleton = new InnerSkeleton(editor);
 editor.set('skeleton' as any, innerSkeleton);
 
-const designer = new Designer({ editor, shellModelFactory });
+const designer: IDesigner = new Designer({ editor, shellModelFactory });
 editor.set('designer' as any, designer);
 
 const { project: innerProject } = designer;
@@ -248,7 +252,7 @@ export async function init(
     const disposeFun = await pluginPromise;
     disposeFun && disposeFun();
     render(
-      createElement(WorkSpaceWorkbench, {
+      createElement(options?.WorkSpaceWorkbench || WorkSpaceWorkbench, {
         workspace: innerWorkspace,
         // skeleton: workspace.skeleton,
         className: 'engine-main',
@@ -267,7 +271,7 @@ export async function init(
   await plugins.init(pluginPreference as any);
 
   render(
-    createElement(Workbench, {
+    createElement(options?.Workbench || Workbench, {
       skeleton: innerSkeleton,
       className: 'engine-main',
       topAreaItemClassName: 'engine-actionitem',
diff --git a/packages/shell/src/api/common.tsx b/packages/shell/src/api/common.tsx
@@ -59,6 +59,7 @@ import {
   Workbench as InnerWorkbench,
   SettingsPrimaryPane as InnerSettingsPrimaryPane,
   registerDefaults as InnerRegisterDefaults,
+  ISkeleton,
 } from '@felce/lowcode-editor-skeleton';
 import {
   Editor,
@@ -180,11 +181,11 @@ class DesignerCabin implements IPublicApiCommonDesignerCabin {
 }
 
 class SkeletonCabin implements IPublicApiCommonSkeletonCabin {
-  private readonly [skeletonSymbol]: InnerSkeleton;
+  private readonly [skeletonSymbol]: ISkeleton;
 
   readonly [skeletonCabinSymbol]: any;
 
-  constructor(skeleton: InnerSkeleton) {
+  constructor(skeleton: ISkeleton) {
     this[skeletonSymbol] = skeleton;
     this[skeletonCabinSymbol] = {
       Workbench: InnerWorkbench,
@@ -430,7 +431,7 @@ export class Common implements IPublicApiCommon {
   private readonly __editorCabin: any;
   private readonly __utils: Utils;
 
-  constructor(editor: Editor, skeleton: InnerSkeleton) {
+  constructor(editor: Editor, skeleton: ISkeleton) {
     this.__designerCabin = new DesignerCabin(editor);
     this.__skeletonCabin = new SkeletonCabin(skeleton);
     this.__editorCabin = new EditorCabin(editor);
diff --git a/packages/types/src/shell/type/engine-options.ts b/packages/types/src/shell/type/engine-options.ts
@@ -1,8 +1,7 @@
 import { RequestHandlersMap } from '@alilc/lowcode-datasource-types';
-import { ComponentType } from 'react';
+import { ComponentType, ReactNode } from 'react';
 
 export interface IPublicTypeEngineOptions {
-
   /**
    * 是否开启 condition 的能力，默认在设计器中不管 condition 是啥都正常展示
    * when this is true, node that configured as conditional not renderring
@@ -75,7 +74,10 @@ export interface IPublicTypeEngineOptions {
   /**
    * 定制画布中点击被忽略的 selectors，默认值：undefined
    */
-  customizeIgnoreSelectors?: (defaultIgnoreSelectors: string[], e: MouseEvent) => string[];
+  customizeIgnoreSelectors?: (
+    defaultIgnoreSelectors: string[],
+    e: MouseEvent,
+  ) => string[];
 
   /**
    * 禁止默认的设置面板，默认值：false
@@ -137,7 +139,6 @@ export interface IPublicTypeEngineOptions {
    * 与 react-renderer 的 appHelper 一致，https://lowcode-engine.cn/site/docs/guide/expand/runtime/renderer#apphelper
    */
   appHelper?: {
-
     /** 全局公共函数 */
     utils?: Record<string, any>;
 
@@ -189,11 +190,19 @@ export interface IPublicTypeEngineOptions {
    * 隐藏设计器辅助层
    */
   hideComponentAction?: boolean;
+
+  /**
+   * 自定义的 WorkSpaceWorkbench
+   */
+  WorkSpaceWorkbench?: ReactNode;
+
+  /**
+   * 自定义的 Workbench
+   */
+  Workbench?: ReactNode;
 }
 
 /**
  * @deprecated use IPublicTypeEngineOptions instead
  */
-export interface EngineOptions {
-
-}
+export interface EngineOptions {}
