@gct-paas/core-web 0.1.4-dev.1 → 0.1.4-dev.11

package/es/modules/gct-form/interface/i-editor/i-text-editor.d.ts

@@ -0,0 +1,46 @@
+import { IEditorBasic } from './i-editor-basic';
+import { EditorType } from '../../constants';
+/**
+ * 文本编辑器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 11:04:04
+ * @export
+ * @interface ITextEditor
+ * @extends {IEditorBasic}
+ */
+export interface ITextEditor extends IEditorBasic {
+    readonly type: EditorType.TEXT | string;
+    /**
+     * 前缀
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 11:04:39
+     * @type {string}
+     */
+    prefix?: string;
+    /**
+     * 后缀
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 11:04:42
+     * @type {string}
+     */
+    suffix?: string;
+    /**
+     * 前置标签
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 11:04:16
+     * @type {string}
+     */
+    addonBefore?: string;
+    /**
+     * 后置标签
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 11:04:20
+     * @type {string}
+     */
+    addonAfter?: string;
+}

package/es/modules/gct-form/interface/i-editor/i-textarea-editor.d.ts

@@ -0,0 +1,25 @@
+import { EditorType } from '../../constants';
+import { IEditorBasic } from './i-editor-basic';
+/**
+ * 多行文本域编辑器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 11:04:33
+ * @export
+ * @interface ITextareaEditor
+ * @extends {IEditorBasic}
+ */
+export interface ITextareaEditor extends IEditorBasic {
+    readonly type: EditorType.TEXTAREA;
+    /**
+     * 多行文本行数
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 16:04:18
+     * @type {(boolean | { minRows: number; maxRows: number })}
+     */
+    autoSize?: boolean | {
+        minRows: number;
+        maxRows: number;
+    };
+}

package/es/modules/gct-form/interface/i-editor/index.d.ts

@@ -0,0 +1,23 @@
+export type { IActionEditor } from './i-action-editor';
+export type { IDateFormatSelectEditor } from './i-date-format-select-editor';
+export type { ILengthUnitEditor } from './i-length-unit-editor';
+export type { IColorEditor } from './i-color-editor';
+export type { IEditorBasic } from './i-editor-basic';
+export type { IFormulaEditor } from './i-formula-editor';
+export type { IIconSelectEditor } from './i-icon-select-editor';
+export type { IInfoEditor } from './i-info-editor';
+export type { II18nEditor } from './i-i18n-editor';
+export type { IModelFieldSelectEditor } from './i-model-field-select-editor';
+export type { IMPickerEditor } from './i-mpicker-editor';
+export type { INumberEditor } from './i-number-editor';
+export type { IPickerEditor } from './i-picker-editor';
+export type { ISelectEditor } from './i-select-editor';
+export type { ISpanEditor } from './i-span-editor';
+export type { ITextEditor } from './i-text-editor';
+export type { ISelectTableEditor } from './i-select-table-editor';
+export type { ITableEditor } from './i-table-editor';
+export type { ITextareaEditor } from './i-textarea-editor';
+export type { ISwitchEditor } from './i-switch-editor';
+export type { ICheckSwitchEditor } from './i-check-switch';
+export type { IRadioEditor } from './i-radio-editor';
+export type { ICheckboxEditor } from './i-checkbox-editor';

package/es/modules/gct-form/interface/i-events/form/i-form.event.d.ts

@@ -0,0 +1,14 @@
+import { IFormItemBasicController } from '../../i-controller';
+/**
+ * 表单事件
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 13:04:57
+ * @export
+ * @interface IFormEvent
+ */
+export interface IFormEvent {
+    changeState(key: string, item: IFormItemBasicController): void;
+    change(key: string, value: any, oldValue: any): void;
+    blur(key: string, value: any): void;
+}

package/es/modules/gct-form/interface/i-events/index.d.ts

@@ -0,0 +1 @@
+export type { IFormEvent } from './form/i-form.event';

package/es/modules/gct-form/interface/i-form/i-edit-form.d.ts

@@ -0,0 +1,48 @@
+import { IFormController } from '../i-controller';
+import { IForm } from './i-form';
+/**
+ * 编辑表单
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 18:04:17
+ * @export
+ * @interface IEditForm
+ * @extends {IForm}
+ */
+export interface IEditForm extends IForm {
+    readonly type: 'edit';
+    /**
+     * 默认隐藏所有表单项的异常展示高度空间
+     *
+     * @type {boolean}
+     */
+    hiddenError?: boolean;
+    /**
+     * 监控表单项值变更
+     *
+     * @author zhanghanrui
+     * @date 2024-06-11 17:06:55
+     */
+    watch?: Record<string, (form: IFormController, val: any, oldValue: any) => void>;
+    /**
+     * 新建请求
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:31
+     * @param {IData} data
+     * @return {*}  {Promise<IData>}
+     */
+    newRequest?(data: IData): Promise<IData>;
+    /**
+     * 更新请求
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:34
+     * @param {{ id: string }} params
+     * @param {IData} data
+     * @return {*}  {Promise<IData>}
+     */
+    updateRequest?(params: {
+        id: string;
+    }, data: IData): Promise<IData>;
+}

package/es/modules/gct-form/interface/i-form/i-form-collapse-pane.d.ts

@@ -0,0 +1,30 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单折叠面板项
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormCollapsePane
+ * @extends {IFormContainer}
+ */
+export interface IFormCollapsePane extends IFormContainer {
+    type: 'collapse-pane';
+    /**
+     * 是否是容器
+     */
+    isContainer: true;
+    /**
+     * 面板头部标题
+     * @author lingxiaoming
+     * @date 2024-07-15 11:02:21
+     * @type {string}
+     */
+    title: string;
+    /**
+     * 是否可以折叠(默认可折叠)
+     * @author lingxiaoming
+     * @date 2024-07-15 11:02:37
+     * @type {boolean}
+     */
+    collapsible?: boolean;
+}

package/es/modules/gct-form/interface/i-form/i-form-collapse.d.ts

@@ -0,0 +1,39 @@
+import { IFormCollapsePane } from './i-form-collapse-pane';
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单折叠面板
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormCollapse
+ * @extends {IFormContainer}
+ */
+export interface IFormCollapse extends IFormContainer {
+    type: 'collapse';
+    /**
+     * 是否是容器
+     */
+    isContainer: true;
+    /**
+     * 手风琴模式(开启后同时只能展开一个面板)
+     * @author lingxiaoming
+     * @date 2024-07-15 11:00:57
+     * @type {boolean}
+     */
+    accordion?: boolean;
+    /**
+     * 折叠图标位置
+     * @author lingxiaoming
+     * @date 2024-07-15 11:28:29
+     * @type {('left' | 'right')}
+     */
+    expandIconPosition?: 'left' | 'right';
+    /**
+     * 折叠图标呈现样式(第一个是展开的状态,第二个是折叠的状态)
+     * @author lingxiaoming
+     * @date 2024-07-15 02:50:01
+     * @type {('down-right' | 'up-down')}
+     */
+    expandIconStyle?: 'down-right' | 'up-down';
+    children?: IFormCollapsePane[];
+}

package/es/modules/gct-form/interface/i-form/i-form-container.d.ts

@@ -0,0 +1,53 @@
+import { IFlexContainer, IGridContainer } from '../i-layout';
+import { IFormItemBasic } from './i-form-item-basic';
+/**
+ * 表单容器类型基础
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:35
+ * @export
+ * @interface IFormContainer
+ * @extends {IFormItemBasic}
+ */
+export interface IFormContainer extends IFormItemBasic {
+    /**
+     * 表单容器
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 15:04:25
+     * @type {'container'}
+     */
+    type: 'container' | string;
+    /**
+     * 布局模式
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:31
+     * @type {('flex' | 'grid')}
+     */
+    layout: 'flex' | 'grid';
+    /**
+     * flex box 流式布局
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:25
+     * @type {IFlexContainer}
+     */
+    flex?: IFlexContainer;
+    /**
+     * 栅格布局
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:22
+     * @type {IGridContainer}
+     */
+    grid?: IGridContainer;
+    /**
+     * 子元素
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 15:04:57
+     * @type {IFormItemBasic[]}
+     */
+    children?: IFormItemBasic[];
+}

package/es/modules/gct-form/interface/i-form/i-form-edit-item.d.ts

@@ -0,0 +1,154 @@
+import { RuleObject } from 'ant-design-vue/lib/form';
+import { IEditorBasic } from '../i-editor/i-editor-basic';
+import { IFormItemBasic } from './i-form-item-basic';
+import { IDictionary } from '@gct-paas/core';
+/**
+ * 表单编辑项
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 20:04:09
+ * @export
+ * @interface IFormEditItem
+ * @extends {IFormItemBasic}
+ */
+export interface IFormEditItem extends IFormItemBasic {
+    /**
+     * 项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:44
+     * @type {'item'}
+     */
+    type: 'item' | 'hidden';
+    /**
+     * 表单项标识
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:25
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 是否隐藏错误信息的高度空间
+     *
+     * @type {boolean}
+     */
+    hiddenError?: boolean;
+    /**
+     * 表单项映射字段（用于提交数据，未指定时取 name）
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 10:04:17
+     * @type {string}
+     */
+    field?: string;
+    /**
+     * 默认值
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 20:04:11
+     * @type {*}
+     */
+    defaultValue?: any;
+    /**
+     * 编辑器
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:57
+     * @type {IEditorBasic}
+     */
+    editor: IEditorBasic;
+    /**
+     * 标题
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:50
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 标题后面加个问号的tooltip
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:50
+     * @type {string}
+     */
+    labelTooltip?: string;
+    /**
+     * 标题提示宽度
+     *
+     * @author chitanda
+     * @date 2025-07-04 16:07:57
+     * @type {string}
+     */
+    labelTipWidth?: string;
+    /**
+     * 标题宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:52
+     * @type {string}
+     */
+    labelWidth?: string;
+    /**
+     * 标题位置
+     * @author lingxiaoming
+     * @date 2024-07-18 11:36:31
+     * @type {('left' | 'top')}
+     */
+    labelPosition?: 'left' | 'top';
+    /**
+     * 开启后label不显示冒号
+     * @author lingxiaoming
+     * @date 2024-07-18 03:55:12
+     * @type {boolean}
+     */
+    noColon?: boolean;
+    /**
+     * label文字的对齐方式,默认right
+     * @author lingxiaoming
+     * @date 2024-07-18 03:56:31
+     * @type {('left' | 'right')}
+     */
+    labelAlign?: 'left' | 'right';
+    /**
+     * 编辑器的对齐方式,默认left
+     * @author lingxiaoming
+     * @date 2024-07-18 03:56:31
+     * @type {('left' | 'right')}
+     */
+    editorAlign?: 'left' | 'right';
+    /**
+     * 属性项
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 14:03:29
+     * @type {string[]}
+     */
+    fields?: string[];
+    /**
+     * 表单项规则
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 19:04:48
+     * @type {RuleObject[]}
+     */
+    rules?: RuleObject[];
+    /**
+     * 代码表标识
+     *
+     * @description 用于从全局获取代码表的标识
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:06
+     * @type {string}
+     */
+    dictionaryTag?: string;
+    /**
+     * 代码表（数据字典），优先级高于 codeTag
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:58
+     * @type {IDictionary}
+     */
+    dictionary?: IDictionary;
+}

package/es/modules/gct-form/interface/i-form/i-form-group-container.d.ts

@@ -0,0 +1,24 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分组容器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-28 15:03:32
+ * @export
+ * @interface IFormGroupContainer
+ * @extends {IFormContainer}
+ */
+export interface IFormGroupContainer extends IFormContainer {
+    /**
+     * 分组类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:44
+     * @type {'group'}
+     */
+    type: 'group';
+    /**
+     * 分组标题
+     */
+    title: string;
+}

package/es/modules/gct-form/interface/i-form/i-form-group.d.ts

@@ -0,0 +1,35 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分组容器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:06
+ * @export
+ * @interface IFormGroup
+ * @extends {IFormContainer}
+ */
+export interface IFormGroup extends IFormContainer {
+    /**
+     * 分组标题
+     */
+    title?: string;
+    /**
+     * 是否显示标题
+     *
+     * @description 当值为 false 时，title 配置不生效。若不指定，title 有值时显示标题，否则不显示标题
+     * @author zhanghanrui
+     * @date 2024-04-01 18:04:57
+     * @type {boolean}
+     */
+    showHeader?: boolean;
+    /**
+     * 是否可折叠
+     *
+     * @description 当值为 true 时，showHeader 配置不生效
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-04-01 18:04:12
+     * @type {boolean}
+     */
+    isCollapse?: boolean;
+}

package/es/modules/gct-form/interface/i-form/i-form-hidden-item.d.ts

@@ -0,0 +1,11 @@
+import { IFormItemBasic } from './i-form-item-basic';
+/**
+ * 隐藏表单项
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:13
+ * @export
+ * @interface IFormHiddenItem
+ * @extends {IFormItemBasic}
+ */
+export type IFormHiddenItem = IFormItemBasic;

package/es/modules/gct-form/interface/i-form/i-form-item-basic.d.ts

@@ -0,0 +1,131 @@
+import { ClassValue, StyleValue } from 'vue';
+import { IFlexItem, IGridItem } from '../i-layout';
+import { IFormItemProvider } from '../i-provider';
+import { IFormController, IFormEditItemController } from '../i-controller';
+/**
+ * 表单项基础
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:37
+ * @export
+ * @interface IFormItemBasic
+ */
+export interface IFormItemBasic {
+    /**
+     * 项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:30
+     * @type {string} 具体类型由子类定义
+     */
+    type: string;
+    /**
+     * 表单项名称
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:43
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 表单项高度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 15:04:02
+     * @type {string}
+     */
+    height?: string;
+    /**
+     * 表单项宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 15:04:24
+     * @type {string}
+     */
+    width?: string;
+    /**
+     * 内间距
+     *
+     * @author zhanghanrui
+     * @date 2024-06-06 17:06:30
+     * @type {string}
+     */
+    padding?: string;
+    /**
+     * 外间距
+     *
+     * @author zhanghanrui
+     * @date 2024-06-06 17:06:16
+     * @type {string}
+     */
+    margin?: string;
+    /**
+     * 容器作为 flex 布局子元素的参数
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:35
+     * @type {IFlexItem}
+     */
+    flexItem?: IFlexItem;
+    /**
+     * 容器作为栅格布局子元素的参数
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:56
+     * @type {IGridItem}
+     */
+    gridItem?: IGridItem;
+    /**
+     * 额外的类名
+     * @author lingxiaoming
+     * @date 2024-07-18 01:05:19
+     * @type {*}
+     */
+    class?: ClassValue;
+    /**
+     * 额外行内的样式
+     * @author lingxiaoming
+     * @date 2024-07-18 01:05:33
+     * @type {StyleValue}
+     */
+    style?: StyleValue;
+    /**
+     * 独立适配器
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 13:04:21
+     */
+    provider?: (...args: any[]) => IFormItemProvider;
+    /**
+     * 表单项隐藏计算
+     *
+     * @author zhanghanrui
+     * @date 2024-08-01 11:08:16
+     * @param {IFormController} form 表单控制器实例
+     * @param {IFormEditItemController} item 当前表单项控制器实例
+     * @param {IData} data 表单数据
+     * @return {*}  {boolean}
+     */
+    hidden?(form: IFormController, item: IFormEditItemController, data: IData): boolean;
+    /**
+     * 表单项值变更
+     *
+     * @author zhanghanrui
+     * @date 2024-08-02 16:08:41
+     * @param {IFormController} form 表单控制器实例
+     * @param {IFormEditItemController} item 当前表单项控制器实例
+     * @param {*} [val] 变更后的值
+     * @param {*} [oldVal] 变更前的值
+     */
+    watch?(form: IFormController, item: IFormEditItemController, val?: any, oldVal?: any): void;
+    /**
+     * 表单项值变更回调
+     *
+     * @author zhanghanrui
+     * @date 2024-08-02 16:08:41
+     * @param {IFormController} form 表单控制器实例
+     * @param {IFormEditItemController} item 当前表单项控制器实例
+     * @param {IData} data 表单数据
+     */
+    change?(form: IFormController, item: IFormEditItemController, data: IData): void;
+}

package/es/modules/gct-form/interface/i-form/i-form-item.d.ts

@@ -0,0 +1,11 @@
+import { IFormEditItem } from './i-form-edit-item';
+/**
+ * 表单项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:57
+ * @export
+ * @interface IFormItem
+ * @extends {IFormEditItem}
+ */
+export type IFormItem = IFormEditItem;

package/es/modules/gct-form/interface/i-form/i-form-line.d.ts

@@ -0,0 +1,24 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分组容器
+ *
+ * @export
+ * @interface IFormLine
+ * @extends {IFormContainer}
+ */
+export interface IFormLine extends IFormContainer {
+    /**
+     * 分割线上间距
+     *
+     * @default 8px
+     * @type {string}
+     */
+    paddingTop?: string;
+    /**
+     * 分割线下间距
+     *
+     * @default 8px
+     * @type {string}
+     */
+    paddingBottom?: string;
+}