@gct-paas/design 0.1.4-dev.7 → 0.1.4-dev.9

package/es/interface/i-design-view-options/i-design-view-options.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 设计视图配置参数
+ *
+ * @author zhanghanrui
+ * @date 2024-08-19 17:08:18
+ * @export
+ * @interface IDesignViewOptions
+ */
+export interface IDesignViewOptions {
+    /**
+     * 页面标题
+     *
+     * @author zhanghanrui
+     * @date 2024-08-19 17:08:33
+     * @type {string}
+     */
+    title?: string;
+    /**
+     * 设计视图前缀
+     *
+     * @author zhanghanrui
+     * @date 2024-08-19 17:08:27
+     * @type {string}
+     */
+    prefix?: string;
+    /**
+     * 是否有触发预览按钮，默认有
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-08-19 17:08:44
+     * @type {boolean}
+     */
+    isPreview?: boolean;
+    /**
+     * 是否支持回溯，撤销重做功能。默认支持
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-08-20 09:08:51
+     * @type {boolean}
+     */
+    isBacktrack?: boolean;
+    /**
+     * 是否显示素材区，默认显示
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-08-19 17:08:28
+     * @type {boolean}
+     */
+    isMaterial?: boolean;
+    /**
+     * 是否为移动端设计视图，默认是
+     *
+     * @default true
+     * @type {boolean}
+     */
+    isMobile?: boolean;
+    /**
+     * 是否显示移动端标题栏，默认显示
+     *
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-08-19 17:08:14
+     * @type {boolean}
+     */
+    showMobileTitleBar?: boolean;
+}

package/es/interface/i-drag-collect/i-drag-collect.d.ts

@@ -1,6 +1,8 @@
 /**
  * 拖拽状态收集器
  *
+ * @author zhanghanrui
+ * @date 2024-07-05 15:07:01
  * @export
  * @interface IDragCollect
  */
@@ -8,12 +10,16 @@ export interface IDragCollect {
     /**
      * 是否可以拖拽
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:20
      * @type {boolean}
      */
     canDrag: boolean;
     /**
      * 是否正在拖拽
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:26
      * @type {boolean}
      */
     isDragging: boolean;

package/es/interface/i-drag-data-item/i-drag-data-item.d.ts

@@ -1,4 +1,3 @@
-import { LowCodeWidget } from '@gct-paas/core';
 /**
  * 拖拽数据项
  *
@@ -6,7 +5,19 @@ import { LowCodeWidget } from '@gct-paas/core';
  * @interface IDragDataItem
  * @template O
  */
-export interface IDragDataItem<O = LowCodeWidget.BasicSchema> {
+export interface IDragDataItem<O = IObject> {
+    /**
+     * 拖拽组别类型
+     *
+     * @type {string}
+     */
+    dragType?: string;
+    /**
+     * 额外数据（兼容老旧写法）
+     *
+     * @type {O}
+     */
+    item?: O;
     /**
      * 当前数据标识，如果是新数据则主键为空
      *

package/es/interface/i-drag-item/i-drag-item.d.ts

@@ -1,6 +1,9 @@
+import { IDesignNode } from '../design';
 /**
  * 拖拽项
  *
+ * @author zhanghanrui
+ * @date 2024-07-05 14:07:56
  * @export
  * @interface IDragItem
  */
@@ -8,25 +11,33 @@ export interface IDragItem {
     /**
      * 下标
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:04
      * @type {number}
      */
     index: number;
     /**
      * 标识
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:08
      * @type {string}
      */
     id: string;
     /**
      * 类型
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:12
      * @type {string}
      */
     type: string;
     /**
      * 拖拽数据
      *
-     * @type {IObject}
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:20
+     * @type {IDesignNode}
      */
-    data: IObject;
+    data: IDesignNode;
 }

package/es/interface/i-drop-collect/i-drop-collect.d.ts

@@ -1,6 +1,8 @@
 /**
  * 放置状态收集器
  *
+ * @author zhanghanrui
+ * @date 2024-07-05 15:07:13
  * @export
  * @interface IDropCollect
  */
@@ -8,18 +10,24 @@ export interface IDropCollect {
     /**
      * 拖拽元素标识
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:30
      * @type {string}
      */
     handlerId: string;
     /**
      * 是否可以放置
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:36
      * @type {boolean}
      */
     canDrop: boolean;
     /**
      * 是否只在单一元素放置
      *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:47
      * @type {boolean}
      */
     isShallowOver: boolean;

package/es/interface/i-drop-result/i-drop-result.d.ts

@@ -21,6 +21,8 @@ export interface IDropResultData {
 /**
  * 拖拽操作返回值
  *
+ * @author zhanghanrui
+ * @date 2024-07-08 19:07:51
  * @export
  * @interface IDropResult
  */

package/es/interface/i-material-data/i-material-data.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 素材项
+ *
+ * @author zhanghanrui
+ * @date 2024-07-09 11:07:07
+ * @export
+ * @interface IMaterialData
+ */
+export interface IMaterialData {
+    /**
+     * 分组
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 11:07:16
+     * @type {string}
+     */
+    group: string;
+    /**
+     * 节点类型
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 11:07:28
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 节点名称
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 11:07:34
+     * @type {string}
+     */
+    label: string;
+    /**
+     * 节点图标
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 11:07:40
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 素材项顺序
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 13:07:55
+     * @type {number}
+     */
+    order: number;
+}

package/es/interface/i-material-group/i-material-group.d.ts

@@ -0,0 +1,51 @@
+import { IMaterialData } from '../i-material-data/i-material-data';
+/**
+ * 素材分组
+ *
+ * @author zhanghanrui
+ * @date 2024-07-09 13:07:41
+ * @export
+ * @interface IMaterialGroup
+ */
+export interface IMaterialGroup {
+    /**
+     * 分组标识
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 13:07:26
+     * @type {string}
+     */
+    tag: string;
+    /**
+     * 分组标题
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 13:07:33
+     * @type {string}
+     */
+    label: string;
+    /**
+     * 分组图标
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 16:07:13
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 分组排序
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 13:07:55
+     * @type {number}
+     */
+    order: number;
+    /**
+     * 分组项
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 15:07:37
+     * @type {IMaterialData[]}
+     */
+    children?: IMaterialData[];
+}

package/es/interface/i-view-step/i-view-step.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 设计视图步骤接口
+ *
+ * @export
+ * @interface IViewStep
+ */
+export interface IViewStep {
+    /**
+     * 步骤标识符
+     *
+     * @type {string}
+     */
+    tag: string;
+    /**
+     * 步骤名称
+     *
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 步骤图标（只支持 svg）
+     *
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 步骤描述
+     *
+     * @type {string}
+     */
+    description?: string;
+}

package/es/interface/i-vue3-dnd-item-options/i-vue3-dnd-item-options.d.ts

@@ -0,0 +1,323 @@
+import { ConnectDragPreview, ConnectDragSource, DragPreviewOptions, DragSourceOptions, DropTargetOptions } from 'vue3-dnd';
+import { LowCodeWidget } from '@gct-paas/schema';
+/**
+ * 拖拽绘制项参数
+ *
+ * @export
+ * @interface IRenderOptions
+ * @template O
+ */
+export interface IRenderOptions<O = LowCodeWidget.BasicSchema> {
+    /**
+     * 节点数据
+     *
+     * @type {O}
+     */
+    item: O;
+    /**
+     * 位置
+     *
+     * @type {number}
+     */
+    index: number;
+    /**
+     * 是否正在拖拽
+     *
+     * @type {boolean}
+     */
+    isDragging: boolean;
+    /**
+     * 是否悬浮于当前元素内，并且只有当前元素。多层悬浮时，以最底层触发此参数
+     *
+     * @type {boolean}
+     */
+    isShallowOver: boolean;
+    /**
+     * 是否在此元素上
+     *
+     * @type {boolean}
+     */
+    isOver: boolean;
+    /**
+     * 是否悬浮于此元素后半段（需要根据拖拽线方向，判断是上下还是左右）
+     *
+     * @type {boolean}
+     */
+    isBeforeHover: boolean;
+    /**
+     * 是否悬浮于此元素后半段（需要根据拖拽线方向，判断是上下还是左右）
+     *
+     * @type {boolean}
+     */
+    isAfterHover: boolean;
+    /**
+     * 放置线方向
+     *
+     * @type {('vertical' | 'horizontal')}
+     */
+    direction: 'vertical' | 'horizontal';
+    /**
+     * 自定义拖拽 handle 元素
+     *
+     * @type {ConnectDragSource<DragSourceOptions>}
+     */
+    drag?: ConnectDragSource<DragSourceOptions>;
+    /**
+     * 自定义拖拽预览
+     *
+     * @type {ConnectDragPreview<DragPreviewOptions>}
+     */
+    preview?: ConnectDragPreview<DragPreviewOptions>;
+}
+/**
+ * 绘制参数
+ *
+ * @export
+ * @interface IRenderContentOptions
+ * @template O
+ */
+export interface IRenderContentOptions<O = LowCodeWidget.BasicSchema> {
+    /**
+     * 父部件
+     *
+     * @type {O}
+     */
+    parentWidget?: O;
+    /**
+     * 部件清单
+     *
+     * @type {O[]}
+     */
+    children: O[];
+    /**
+     * 特殊情况下绘制项和子项不一致，为了确保引用关系修改数据实时生效，children 将用于数据修改，renderChildren 将用于绘制
+     *
+     * @type {O[]}
+     */
+    renderChildren?: O[];
+    /**
+     * 容器绘制额外参数
+     *
+     * @type {*}
+     */
+    props?: IParams;
+    /**
+     * 额外配置信息
+     *
+     * @type {IVue3DndItemOptions}
+     */
+    config?: IVue3DndItemOptions;
+    /**
+     * 子绘制内容，可选项，只有单独插槽时有用
+     *
+     * @type {*}
+     */
+    content?: any;
+    /**
+     * 容器中子项单一项内容绘制
+     *
+     */
+    itemContent?: (data: {
+        element: O;
+        index: number;
+    }) => any;
+    /**
+     * 容器子项前额外绘制
+     *
+     */
+    renderItemBefore?: (data: {
+        element: O;
+        index: number;
+    }) => any;
+    /**
+     * 容器中子项后额外绘制
+     *
+     */
+    renderItemAfter?: (data: {
+        element: O;
+        index: number;
+    }) => any;
+}
+/**
+ * 容器绘制选项
+ *
+ * @export
+ * @interface IRenderContainerOptions
+ * @extends {IRenderContentOptions<O>}
+ * @template O
+ */
+export interface IRenderContainerOptions<O = LowCodeWidget.BasicSchema> extends IRenderContentOptions<O> {
+    /**
+     * 放置分组标识
+     *
+     * @type {string}
+     */
+    groupId?: string;
+    /**
+     * 子项绘制额外参数
+     *
+     * @type {*}
+     */
+    itemProps?: IParams;
+}
+/**
+ * 项绘制参数
+ *
+ * @export
+ * @interface IRenderContentItemOptions
+ * @extends {IRenderContentOptions<O>}
+ * @template O
+ */
+export interface IRenderContentItemOptions<O = LowCodeWidget.BasicSchema> extends IRenderContentOptions<O> {
+    /**
+     * 部件数据
+     *
+     * @type {O}
+     */
+    widget: O;
+    /**
+     * 部件索引
+     *
+     * @type {number}
+     */
+    index: number;
+}
+/**
+ * 拖拽配置
+ *
+ * @interface IVue3DndItemOptions
+ * @template O
+ * @template R
+ */
+export interface IVue3DndItemOptions<O = LowCodeWidget.BasicSchema> {
+    /**
+     * 数据处理模式
+     *
+     * @type {('create' | 'move')} 新建 | 移动
+     */
+    mode: 'create' | 'move';
+    /**
+     * 额外指定类型
+     *
+     * @type {string}
+     */
+    type?: string;
+    /**
+     * 放置线方向
+     *
+     * @default 'vertical'
+     * @type {('vertical' | 'horizontal')} 垂直方向 | 水平方向
+     */
+    direction?: 'vertical' | 'horizontal';
+    /**
+     * 放置线偏移量
+     *
+     * @type {number}
+     */
+    offset?: number;
+    /**
+     * 是否自定义放置
+     *
+     * @default false
+     * @type {boolean}
+     */
+    isCustomDrop?: boolean;
+    /**
+     * 是否自定义预览
+     *
+     * @default false
+     * @type {boolean}
+     */
+    isCustomPreview?: boolean;
+    /**
+     * 是否允许拖拽
+     *
+     * @default true
+     * @type {boolean}
+     */
+    isDrag?: boolean;
+    /**
+     * 是否允许放置
+     *
+     * @default true
+     * @type {boolean}
+     */
+    isDrop?: boolean;
+    /**
+     * 是否允许删除
+     *
+     * @default true
+     * @type {boolean}
+     */
+    isDelete?: boolean;
+    /**
+     * 特殊情况下，例如表格将表格元素自己复制了好几份，需要指定实际呈现元素在 querySelectorAll 中的位置
+     *
+     * @type {number}
+     */
+    selectorIndex?: number;
+    /**
+     * 预览配置
+     *
+     * @type {DragPreviewOptions}
+     */
+    previewOptions?: DragPreviewOptions;
+    /**
+     * 拖拽配置
+     *
+     * @type {DragSourceOptions}
+     */
+    dragOptions?: DragSourceOptions;
+    /**
+     * 放置配置
+     *
+     * @type {DropTargetOptions}
+     */
+    dropOptions?: DropTargetOptions;
+    /**
+     * 放置事件回调
+     *
+     */
+    onDrop?: (item: IDropItem, widgets: O[]) => void;
+    /**
+     * 是否允许拖拽回调函数
+     *
+     * @author chitanda
+     * @date 2025-09-12 17:09:54
+     */
+    canDrag?: (data: O) => boolean;
+}
+/**
+ * 放置参数项
+ *
+ * @export
+ * @interface IDropItem
+ * @template O
+ */
+export interface IDropItem<O = LowCodeWidget.BasicSchema> {
+    /**
+     * 放置模式
+     *
+     * @type {('move' | 'create')}
+     */
+    mode: 'move' | 'create';
+    /**
+     * 放置下标
+     *
+     * @type {number}
+     */
+    index: number;
+    /**
+     * 原位置下标，新建模式下无效
+     *
+     * @default -1
+     * @type {number}
+     */
+    oldIndex: number;
+    /**
+     * 拖拽数据
+     *
+     * @type {O}
+     */
+    data: O;
+}

package/es/interface/index.d.ts

@@ -1,11 +1,35 @@
-export type { IDesignDragController } from './controller/i-design-drag.controller';
-export type { IDesignViewController } from './controller/i-design-view.controller';
-export type { IDragCollect } from './i-drag-collect/i-drag-collect';
+export type { IDesignViewActions } from './actions/i-design-view.actions';
+export type { IDesignViewState } from './state/i-design-view.state';
+export type { IDesignViewOptions } from './i-design-view-options/i-design-view-options';
+export type * from './design';
+export type * from './designer';
 export type { IDragDataItem } from './i-drag-data-item/i-drag-data-item';
 export type { IDragItem } from './i-drag-item/i-drag-item';
+export type { IDragCollect } from './i-drag-collect/i-drag-collect';
 export type { IDropCollect } from './i-drop-collect/i-drop-collect';
 export type { IDropResult, IDropResultData, } from './i-drop-result/i-drop-result';
-export type { ExportMethod, History, LoDataObject, PageJson, RuntimeModal, RuntimePageJson, VariableInterface, } from './design-page/design-page';
-export * from './props';
-export type { IDesignDragState } from './state/i-design-drag.state';
-export type { IDesignViewState } from './state/i-design-view.state';
+export type { IMaterialData } from './i-material-data/i-material-data';
+export type { IMaterialGroup } from './i-material-group/i-material-group';
+export type { IViewStep } from './i-view-step/i-view-step';
+export type { IDesignViewController } from './controller/i-design-view.controller';
+export type * from './i-vue3-dnd-item-options/i-vue3-dnd-item-options';
+export type { NewEvent, ToolkitWidgetGroup } from './page-designer/toolkit';
+export type { INodeProvider } from './provider/i-node-provider';
+export type { IDesignItemAction } from './i-design-item-action/i-design-item-action';
+export * from './editor';
+/**
+ * 偏移矩形参数
+ *
+ * @export
+ * @interface IHalfRect
+ */
+export interface IHalfRect {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+export interface IPosRect extends IHalfRect {
+    width: number;
+    height: number;
+}