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

package/es/interface/design/i-design-tree-item.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 设计树项
+ *
+ * @author zhanghanrui
+ * @date 2024-08-20 10:08:36
+ * @export
+ * @interface IDesignTreeItem
+ */
+export interface IDesignTreeItem {
+    /**
+     * 标识
+     *
+     * @author zhanghanrui
+     * @date 2024-08-20 10:08:48
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 子项
+     *
+     * @author zhanghanrui
+     * @date 2024-08-20 10:08:56
+     * @type {IDesignTreeItem[]}
+     */
+    children?: IDesignTreeItem[];
+}

package/es/interface/design/i-model-field-node-data/i-model-field-node-data.d.ts

@@ -0,0 +1,158 @@
+import { IDesignNodeData } from '../i-design-node-data';
+import { IFieldCodeChain, IFont, TagTypeEnum } from '@gct-paas/core';
+/**
+ * 卡片字段设计节点数据接口
+ *
+ * @author chitanda
+ * @date 2025-06-18 17:06:52
+ * @export
+ * @interface IModelFieldNodeData
+ * @extends {IDesignNodeData}
+ */
+export interface IModelFieldNodeData extends IDesignNodeData {
+    /**
+     * 模型标识
+     *
+     * @author chitanda
+     * @date 2025-07-02 09:07:02
+     * @type {string}
+     */
+    modelKey: string;
+    /**
+     * 模型分类
+     *
+     * @author chitanda
+     * @date 2025-07-02 09:07:07
+     * @type {string}
+     */
+    modelCategory: string;
+    /**
+     * 字段标识
+     *
+     * @author chitanda
+     * @date 2025-06-18 19:06:47
+     * @type {string}
+     */
+    key: string;
+    /**
+     * 字段类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:03
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 字段映射类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:33
+     * @type {string}
+     */
+    mapping_type?: string;
+    /**
+     * 字段代码链，表示字段的完整路径。根据字段的层级关系进行拼接
+     *
+     * @author chitanda
+     * @date 2025-06-22 14:06:03
+     * @type {IFieldCodeChain}
+     */
+    fieldCodeChain?: IFieldCodeChain;
+    /**
+     * 用户自定义的显示名称，未定义则使用字段的名称
+     *
+     * @author chitanda
+     * @date 2025-06-19 10:06:23
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 字段名称
+     *
+     * @author chitanda
+     * @date 2025-06-30 11:06:27
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 是否显示标签
+     *
+     * @default true
+     * @author chitanda
+     * @date 2025-06-22 11:06:43
+     * @type {boolean}
+     */
+    show_label?: boolean;
+    /**
+     * 编辑器类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:37
+     * @type {string}
+     */
+    editor_type?: string;
+    /**
+     * 币种：根据编辑器类型显示
+     *
+     * @author chitanda
+     * @date 2025-06-24 14:06:00
+     * @type {string}
+     */
+    currency?: string;
+    /**
+     * 时间类型：根据编辑器类型显示
+     *
+     * @author chitanda
+     * @date 2025-06-24 14:06:58
+     * @type {string}
+     */
+    time_type?: string;
+    /**
+     * 格式化分割符存储的配置项
+     *
+     * @author chitanda
+     * @date 2025-06-23 19:06:21
+     * @type {string}
+     */
+    separator?: string;
+    /**
+     * 字段格式化方式
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:55
+     * @type {string}
+     */
+    format?: string;
+    /**
+     * 标签字体样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:36
+     * @type {IFont}
+     */
+    label_font?: IFont;
+    /**
+     * 内容字体样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:38
+     * @type {IFont}
+     */
+    content_font?: IFont;
+    /**
+     * 标签样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:01
+     * @type {{
+     *     check: boolean;
+     *     color: string;
+     *     mode: TagTypeEnum;
+     *   }}
+     */
+    tag_style?: {
+        check: boolean;
+        color: string;
+        mode: TagTypeEnum;
+    };
+}

package/es/interface/design/index.d.ts

@@ -0,0 +1,9 @@
+export type { IModelFieldNodeData } from './i-model-field-node-data/i-model-field-node-data';
+export type { IDesignContainerNode } from './i-design-container-node';
+export type { IDesignPageNodeData } from './i-design-page-node-data';
+export type { IDesignData } from './i-design-data';
+export type { IDesignEditorData } from './i-design-editor-data';
+export type { IDesignEditorNode } from './i-design-editor-node';
+export type { IDesignNodeData } from './i-design-node-data';
+export type { IDesignNode } from './i-design-node';
+export type { IDesignTreeItem } from './i-design-tree-item';

package/es/interface/designer/i-designer-hooks.d.ts

@@ -0,0 +1,26 @@
+import { SyncSeriesHook } from 'qx-util';
+import { LowCodeWidget } from '@gct-paas/schema';
+/**
+ * 设计界面钩子接口
+ *
+ * @export
+ * @interface IDesignerHooks
+ */
+export interface IDesignerHooks {
+    /**
+     * 触发执行设计容器扩容展示
+     */
+    expansion: SyncSeriesHook<[], LowCodeWidget.BasicSchema[]>;
+    /**
+     * 触发选中项重选
+     */
+    selectHighlightChange: SyncSeriesHook<[]>;
+    /**
+     * 触发悬浮项重选
+     */
+    hoverHighlightChange: SyncSeriesHook<[]>;
+    /**
+     * 设置选中项
+     */
+    setSelect: SyncSeriesHook<[key: string]>;
+}

package/es/interface/designer/i-designer-provider.d.ts

@@ -0,0 +1,20 @@
+import { Component } from 'vue';
+import { IWidgetInfoItem } from '@gct-paas/schema';
+/**
+ * 设计界面项
+ *
+ * @author zhanghanrui
+ * @date 2024-05-24 13:05:47
+ * @export
+ * @interface IDesignerProvider
+ */
+export interface IDesignerProvider extends IWidgetInfoItem {
+    /**
+     * render 绘制组件，目前只支持异步组件
+     *
+     * @author zhanghanrui
+     * @date 2024-05-24 17:05:17
+     * @type {Component}
+     */
+    component: Component;
+}

package/es/interface/designer/i-designer-state.d.ts

@@ -0,0 +1,41 @@
+import { LowCodeWidget } from '@gct-paas/schema';
+/**
+ * 设计器状态接口
+ *
+ * @author zhanghanrui
+ * @date 2024-05-09 14:05:44
+ * @export
+ * @interface IDesignerState
+ */
+export interface IDesignerState {
+    /**
+     * 设计页面是否正在拖拽中
+     */
+    isDragging: boolean;
+    /**
+     * 当前正在拖拽中的数据(旧拖拽)
+     *
+     * @deprecated
+     * @type {IData | null}
+     */
+    draggingData: IData | null;
+    /**
+     * 当前鼠标容器悬浮元素(旧拖拽)
+     *
+     * @deprecated
+     * @type {(HTMLDivElement | null)}
+     */
+    hoverEL: HTMLDivElement | null;
+    /**
+     * 拖拽放置目标容器
+     */
+    dropContainer: LowCodeWidget.BasicSchema | null;
+    /**
+     * 需要扩张的容器列表
+     */
+    expansionContainerList: LowCodeWidget.BasicSchema[];
+    /**
+     * 数据变更次数，主要用于复杂结构下，数据变更后的设计界面重绘
+     */
+    count: number;
+}

package/es/interface/designer/i-designer.controller.d.ts

@@ -0,0 +1,116 @@
+import { LowCodeWidget } from '@gct-paas/schema';
+import { IDesignerHooks } from './i-designer-hooks';
+import { IDesignerState } from './i-designer-state';
+/**
+ * 设计界面控制器接口
+ *
+ * @author zhanghanrui
+ * @date 2024-05-09 14:05:12
+ * @export
+ * @interface IDesignerController
+ */
+export interface IDesignerController {
+    /**
+     * 设计界面状态
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:19
+     */
+    readonly state: IDesignerState;
+    /**
+     * 设计界面钩子
+     *
+     * @type {IDesignerHooks}
+     */
+    readonly hooks: IDesignerHooks;
+    /**
+     * 鼠标悬浮元素清单
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 10:05:47
+     * @type {HTMLDivElement[]}
+     */
+    readonly hoverStack: HTMLDivElement[];
+    /**
+     * 拖拽设计区容器
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 13:05:46
+     * @type {HTMLDivElement}
+     */
+    stageContainer: HTMLDivElement;
+    /**
+     * 拖拽展开定时器
+     *
+     * @type {(number | null)}
+     */
+    expansionTimer: number | null;
+    /**
+     * 设置拖拽数据
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:31
+     * @param {(IData | null)} data
+     */
+    setDragData(data: IData | null): void;
+    /**
+     * 获取当前拖拽数据
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:49
+     * @return {*}  {(IData | null)}
+     */
+    getDragData(): IData | null;
+    /**
+     * 新增鼠标悬浮堆栈
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 10:05:02
+     * @param {HTMLDivElement} el
+     */
+    pushStack(el: HTMLDivElement): void;
+    /**
+     * 删除鼠标悬浮堆栈
+     *
+     * @author zhanghanrui
+     * @date 2024-05-08 11:05:53
+     * @param {HTMLDivElement} el
+     */
+    popStack(el: HTMLDivElement): void;
+    /**
+     * 重置悬浮缓存
+     *
+     * @author zhanghanrui
+     * @date 2024-05-15 11:05:51
+     */
+    resetStack(): void;
+    /**
+     * 添加展开容器
+     *
+     * @param {LowCodeWidget.BasicSchema[]} widgets
+     * @returns {*}  {void}
+     */
+    setExpansion(widgets: LowCodeWidget.BasicSchema[]): void;
+    /**
+     * 取消展开容器
+     */
+    cancelExpansion(): void;
+    /**
+     * 强制设计界面重绘
+     */
+    force(): void;
+    /**
+     * 重新计算选中高亮
+     */
+    changeSelectHighlight(): void;
+    /**
+     * 重新计算悬浮高亮
+     */
+    changeHoverHighlight(): void;
+    /**
+     * 设置选中
+     *
+     * @param {string} key
+     */
+    setSelect(key: string): void;
+}

package/es/interface/designer/index.d.ts

@@ -0,0 +1,4 @@
+export type { IDesignerHooks } from './i-designer-hooks';
+export type { IDesignerProvider } from './i-designer-provider';
+export type { IDesignerState } from './i-designer-state';
+export type { IDesignerController } from './i-designer.controller';

package/es/interface/editor/child-list-editor/child-list-editor.d.ts

@@ -0,0 +1,114 @@
+import { IEditorBasic } from '@gct-paas/core';
+import { DesignEditorType } from '../../../constant';
+/**
+ * 子项编辑器
+ *
+ * @author zhanghanrui
+ * @date 2024-07-29 14:07:55
+ * @export
+ * @interface IChildListEditor
+ * @extends {IEditorBasic}
+ */
+export interface IChildListEditor extends IEditorBasic {
+    readonly type: DesignEditorType.CHILD_LIST_EDITOR;
+    /**
+     * 标题
+     *
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:10
+     * @type {string}
+     */
+    title: string;
+    /**
+     * 默认激活的子数据标识
+     *
+     * @author zhanghanrui
+     * @date 2024-07-29 17:07:49
+     * @type {string}
+     */
+    defaultSelectChildKey?: string;
+    /**
+     * 编辑的子项，默认是 name
+     *
+     * @author zhanghanrui
+     * @date 2024-07-30 13:07:38
+     * @type {string}
+     */
+    childEditFieldKey?: string;
+    /**
+     * 是否可以新增
+     *
+     * @description 默认不可以新增
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-07-29 14:07:21
+     * @type {boolean}
+     */
+    add?: boolean;
+    /**
+     * 是否允许拖拽排序
+     *
+     * @description 默认不启用拖拽排序
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:20
+     * @type {boolean}
+     */
+    sort?: boolean;
+    /**
+     * 是否可以删除项
+     *
+     * @description 默认不启用删除
+     * @default true
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:19
+     * @type {boolean}
+     */
+    delete?: boolean;
+    /**
+     * 默认的编辑器
+     *
+     * @description 默认使用文本编辑器
+     * @default 'text'
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:31
+     * @type {('i18n' | 'text' | 'number')}
+     */
+    editorType?: 'i18n' | 'text' | 'number';
+    /**
+     * 编辑器属性
+     *
+     * @author zhanghanrui
+     * @date 2024-08-01 17:08:26
+     * @type {IParams}
+     */
+    editorProps?: IParams;
+    /**
+     * 是否允许选中项
+     *
+     * @description 默认不可以选择
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:57
+     * @type {boolean}
+     */
+    select?: boolean;
+    /**
+     * 显示标题
+     *
+     * @description 默认不显示标题
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-07-30 13:07:14
+     * @type {boolean}
+     */
+    showLabel?: boolean;
+    /**
+     * 子项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:00
+     * @type {string}
+     */
+    childDesignType: string;
+}

package/es/interface/editor/index.d.ts

@@ -0,0 +1,9 @@
+export type { IChildListEditor } from './child-list-editor/child-list-editor';
+export type { IStyleBorder } from './style-border/i-style-border';
+export type { IStyleBorderController } from './style-border/i-style-border.controller';
+export type { IStyleSpacing } from './style-spacing/i-style-spacing';
+export type { IStyleSpacingController } from './style-spacing/i-style-spacing.controller';
+export type { IStyleFont } from './style-font/i-style-font';
+export type { IStyleFontController } from './style-font/i-style-font.controller';
+export type { IStylePosition } from './style-position/i-style-position';
+export type { IStylePositionController } from './style-position/i-style-position.controller';

package/es/interface/editor/style-border/i-style-border.controller.d.ts

@@ -0,0 +1,11 @@
+import { IEditorController } from '@gct-paas/core';
+import { IStyleBorder } from './i-style-border';
+/**
+ * 边框编辑器控制器
+ * @author lingxiaoming
+ * @date 2024-07-17 04:35:50
+ * @export
+ * @interface IStyleBorderController
+ * @extends {IEditorController<IStyleBorder>}
+ */
+export type IStyleBorderController = IEditorController<IStyleBorder>;

package/es/interface/editor/style-border/i-style-border.d.ts

@@ -0,0 +1,22 @@
+import { IEditorBasic } from '@gct-paas/core';
+import { DesignEditorType } from '../../../constant';
+/**
+ * 边框编辑器模型
+ * @author lingxiaoming
+ * @date 2024-07-17 04:32:52
+ * @export
+ * @interface IStyleBorder
+ * @extends {IEditorBasic}
+ */
+export interface IStyleBorder extends IEditorBasic {
+    readonly type: DesignEditorType.STYLE_BORDER;
+    /**
+     * 显示编辑区域(默认全显示)
+     * - radius 圆角
+     * - basics 边框线
+     * @author lingxiaoming
+     * @date 2024-07-17 06:10:19
+     * @type {(Array<'radius' | 'basics'>)}
+     */
+    showArea?: ('radius' | 'basics')[];
+}

package/es/interface/editor/style-font/i-style-font.controller.d.ts

@@ -0,0 +1,11 @@
+import { IEditorController } from '@gct-paas/core';
+import { IStyleFont } from './i-style-font';
+/**
+ * 文本样式编辑器控制器
+ * @author lingxiaoming
+ * @date 2024-07-17 04:35:50
+ * @export
+ * @interface IStyleFontController
+ * @extends {IEditorController<IStyleFont>}
+ */
+export type IStyleFontController = IEditorController<IStyleFont>;

package/es/interface/editor/style-font/i-style-font.d.ts

@@ -0,0 +1,13 @@
+import { IEditorBasic } from '@gct-paas/core';
+import { DesignEditorType } from '../../../constant';
+/**
+ * 文本样式编辑器模型
+ * @author lingxiaoming
+ * @date 2024-07-17 04:32:52
+ * @export
+ * @interface IStyleFont
+ * @extends {IEditorBasic}
+ */
+export interface IStyleFont extends IEditorBasic {
+    readonly type: DesignEditorType.STYLE_FONT;
+}

package/es/interface/editor/style-position/i-style-position.controller.d.ts

@@ -0,0 +1,11 @@
+import { IEditorController } from '@gct-paas/core';
+import { IStylePosition } from './i-style-position';
+/**
+ * 定位编辑器控制器
+ * @author lingxiaoming
+ * @date 2024-07-17 04:35:50
+ * @export
+ * @interface IStylePositionController
+ * @extends {IEditorController<IStylePosition>}
+ */
+export type IStylePositionController = IEditorController<IStylePosition>;

package/es/interface/editor/style-position/i-style-position.d.ts

@@ -0,0 +1,13 @@
+import { IEditorBasic } from '@gct-paas/core';
+import { DesignEditorType } from '../../../constant';
+/**
+ * 定位编辑器模型
+ * @author lingxiaoming
+ * @date 2024-07-17 04:32:52
+ * @export
+ * @interface IStylePosition
+ * @extends {IEditorBasic}
+ */
+export interface IStylePosition extends IEditorBasic {
+    readonly type: DesignEditorType.STYLE_POSITION;
+}

package/es/interface/editor/style-spacing/i-style-spacing.controller.d.ts

@@ -0,0 +1,11 @@
+import { IEditorController } from '@gct-paas/core';
+import { IStyleSpacing } from './i-style-spacing';
+/**
+ * 边距编辑器控制器
+ * @author lingxiaoming
+ * @date 2024-07-17 04:35:50
+ * @export
+ * @interface IStyleSpacingController
+ * @extends {IEditorController<IStyleSpacing>}
+ */
+export type IStyleSpacingController = IEditorController<IStyleSpacing>;

package/es/interface/editor/style-spacing/i-style-spacing.d.ts

@@ -0,0 +1,22 @@
+import { IEditorBasic } from '@gct-paas/core';
+import { DesignEditorType } from '../../../constant';
+/**
+ * 边距编辑器模型
+ * @author lingxiaoming
+ * @date 2024-07-17 04:32:52
+ * @export
+ * @interface IStyleSpacing
+ * @extends {IEditorBasic}
+ */
+export interface IStyleSpacing extends IEditorBasic {
+    readonly type: DesignEditorType.STYLE_SPACING;
+    /**
+     * 显示编辑区域(默认全显示)
+     * - padding 内边距
+     * - margin 外边距
+     * @author lingxiaoming
+     * @date 2024-07-17 06:10:19
+     * @type {(Array<'padding' | 'margin'>)}
+     */
+    showArea?: ('padding' | 'margin')[];
+}

package/es/interface/i-design-item-action/i-design-item-action.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 行为项
+ *
+ * @author zhanghanrui
+ * @date 2024-07-16 16:07:55
+ * @export
+ * @interface IDesignItemAction
+ */
+export interface IDesignItemAction {
+    /**
+     * 行为标识
+     *
+     * @author zhanghanrui
+     * @date 2024-07-16 16:07:00
+     * @type {string}
+     */
+    tag: string;
+    /**
+     * 文本
+     *
+     * @author zhanghanrui
+     * @date 2024-07-16 16:07:07
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 提示
+     *
+     * @author zhanghanrui
+     * @date 2024-07-16 16:07:11
+     * @type {string}
+     */
+    tooltip?: string;
+    /**
+     * 图标(目前只支持 iconfont)
+     *
+     * @author zhanghanrui
+     * @date 2024-07-16 16:07:15
+     * @type {string}
+     */
+    icon?: string;
+}