@tmagic/editor 1.2.0-beta.18 → 1.2.0-beta.19

package/types/type.d.ts

@@ -2,7 +2,7 @@ import type { Component } from 'vue';
 import type { FormConfig } from '@tmagic/form';
 import type { CodeBlockContent, CodeBlockDSL, Id, MApp, MContainer, MNode, MPage } from '@tmagic/schema';
 import type StageCore from '@tmagic/stage';
-import type { ContainerHighlightType, MoveableOptions } from '@tmagic/stage';
+import type { ContainerHighlightType, CustomizeMoveableOptionsCallbackConfig, MoveableOptions, UpdateDragEl } from '@tmagic/stage';
 import type { CodeBlockService } from './services/codeBlock';
 import type { ComponentListService } from './services/componentList';
 import type { EditorService } from './services/editor';
@@ -11,6 +11,7 @@ import type { HistoryService } from './services/history';
 import type { PropsService } from './services/props';
 import type { StorageService } from './services/storage';
 import type { UiService } from './services/ui';
+import type { UndoRedo } from './utils/undo-redo';
 export declare type BeforeAdd = (config: MNode, parent: MContainer) => Promise<MNode> | MNode;
 export declare type GetConfig = (config: FormConfig) => Promise<FormConfig> | FormConfig;
 export interface InstallOptions {
@@ -32,11 +33,11 @@ export interface StageOptions {
     containerHighlightClassName: string;
     containerHighlightDuration: number;
     containerHighlightType: ContainerHighlightType;
-    render: () => HTMLDivElement;
-    moveableOptions: MoveableOptions | ((core?: StageCore) => MoveableOptions);
+    render: (stage: StageCore) => HTMLDivElement | Promise<HTMLDivElement>;
+    moveableOptions: MoveableOptions | ((config?: CustomizeMoveableOptionsCallbackConfig) => MoveableOptions);
     canSelect: (el: HTMLElement) => boolean | Promise<boolean>;
     isContainer: (el: HTMLElement) => boolean | Promise<boolean>;
-    updateDragEl: (el: HTMLDivElement) => void;
+    updateDragEl: UpdateDragEl;
 }
 export interface StoreState {
     root: MApp | null;
@@ -128,18 +129,17 @@ export interface MenuButton {
      * 按钮类型
      * button: 只有文字不带边框的按钮
      * text: 纯文本
+     * divider: 分割线
      * dropdown: 下拉菜单
-     * divider: 分隔线
-     * zoom: 放大缩小
      */
-    type: 'button' | 'dropdown' | 'text' | 'divider' | 'zoom';
+    type: 'button' | 'text' | 'divider' | 'dropdown';
     /** 当type为divider时有效，分割线方向, 默认vertical */
     direction?: 'horizontal' | 'vertical';
     /** 展示的文案 */
     text?: string;
     /** 鼠标悬浮是显示的气泡中的文案 */
     tooltip?: string;
-    /** element-plus icon class */
+    /** Vue组件或url */
     icon?: string | Component<{}, {}, any>;
     /** 是否置灰，默认为false */
     disabled?: boolean | ((data?: Services) => boolean);
@@ -147,8 +147,8 @@ export interface MenuButton {
     display?: boolean | ((data?: Services) => boolean);
     /** type为button/dropdown时点击运行的方法 */
     handler?: (data: Services, event: MouseEvent) => Promise<any> | any;
-    /** type为dropdown时，下拉的菜单列表， 或者有子菜单时 */
     className?: string;
+    /** type为dropdown时，下拉的菜单列表， 或者有子菜单时 */
     items?: MenuButton[];
 }
 export interface MenuComponent {
@@ -170,10 +170,15 @@ export interface MenuComponent {
  * 'delete': 删除按钮
  * 'undo': 撤销按钮
  * 'redo': 恢复按钮
+ * 'zoom': 'zoom-in', 'zoom-out', 'scale-to-original', 'scale-to-fit' 的集合
  * 'zoom-in': 放大按钮
  * 'zoom-out': 缩小按钮
+ * 'guides': 显示隐藏参考线
+ * 'rule': 显示隐藏标尺
+ * 'scale-to-original': 缩放到实际大小
+ * 'scale-to-fit': 缩放以适应
  */
-export declare type MenuItem = '/' | 'delete' | 'undo' | 'redo' | 'zoom' | 'zoom-in' | 'zoom-out' | 'guides' | 'rule' | MenuButton | MenuComponent | string;
+export declare type MenuItem = '/' | 'delete' | 'undo' | 'redo' | 'zoom' | 'zoom-in' | 'zoom-out' | 'guides' | 'rule' | 'scale-to-original' | 'scale-to-fit' | MenuButton | MenuComponent | string;
 /** 工具栏 */
 export interface MenuBarData {
     /** 顶部工具栏左边项 */
@@ -186,12 +191,13 @@ export interface MenuBarData {
 export interface SideComponent extends MenuComponent {
     /** 显示文案 */
     text: string;
-    /** element-plus icon class */
+    /** vue组件或url */
     icon: Component<{}, {}, any>;
 }
 /**
  * component-list: 组件列表
  * layer: 已选组件树
+ * code-block: 代码块
  */
 export declare type SideItem = 'component-list' | 'layer' | 'code-block' | SideComponent;
 /** 工具栏 */
@@ -208,8 +214,9 @@ export interface ComponentItem {
     text: string;
     /** 组件类型 */
     type: string;
-    /** element-plus icon class */
-    icon?: string | Component;
+    /** Vue组件或url */
+    icon?: string | Component<{}, {}, any>;
+    /** 新增组件时需要透传到组价节点上的数据 */
     data?: {
         [key: string]: any;
     };
@@ -317,3 +324,14 @@ export interface CodeParamStatement {
     /** 参数类型 */
     type?: string;
 }
+export interface StepValue {
+    data: MPage;
+    modifiedNodeIds: Map<Id, Id>;
+    nodeId: Id;
+}
+export interface HistoryState {
+    pageId?: Id;
+    pageSteps: Record<Id, UndoRedo<StepValue>>;
+    canRedo: boolean;
+    canUndo: boolean;
+}