@gct-paas/core-web 0.1.4-dev.9 → 0.1.5-dev.0

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;
+}

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

@@ -0,0 +1,23 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单分页容器
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormTab
+ * @extends {IFormContainer}
+ */
+export interface IFormTabPane extends IFormContainer {
+    type: 'tab-pane';
+    /**
+     * 是否是容器
+     */
+    isContainer: true;
+    /**
+     * 分页标题
+     * @author lingxiaoming
+     * @date 2024-07-14 01:43:06
+     * @type {string}
+     */
+    title: string;
+}

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

@@ -0,0 +1,25 @@
+import { IFormContainer } from './i-form-container';
+import { IFormTabPane } from './i-form-tab-pane';
+/**
+ * 表单分页容器
+ * @author lingxiaoming
+ * @date 2024-07-14 01:38:20
+ * @export
+ * @interface IFormTab
+ * @extends {IFormContainer}
+ */
+export interface IFormTab extends IFormContainer {
+    type: 'tab';
+    /**
+     * 是否是容器
+     */
+    isContainer: true;
+    children?: IFormTabPane[];
+    /**
+     * 导航位置
+     * @author lingxiaoming
+     * @date 2024-07-15 01:19:44
+     * @type {('center' | 'left' | 'right')}
+     */
+    navPosition?: 'center' | 'left' | 'right';
+}

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

@@ -0,0 +1,93 @@
+import { IFormContainer } from './i-form-container';
+/**
+ * 表单
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 20:03:14
+ * @export
+ * @interface IForm
+ */
+export interface IForm {
+    /**
+     * 表单类型
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:21
+     * @type {('edit' | 'search')} 编辑表单 | 搜索表单
+     */
+    type: 'edit' | 'search';
+    /**
+     * 表单布局方式
+     *
+     * @author zhanghanrui
+     * @date 2024-04-08 13:04:59
+     * @type {('horizontal' | 'vertical' | 'inline')}
+     */
+    layout?: 'horizontal' | 'vertical' | 'inline';
+    /**
+     * 是否为信息表单，只读模式
+     *
+     * @author zhanghanrui
+     * @date 2024-04-08 14:04:13
+     * @type {boolean}
+     */
+    info?: boolean;
+    /**
+     * 空数据时是否显示提示文本
+     *
+     * @type {boolean}
+     */
+    isEmptyText?: boolean;
+    /**
+     * 表单呈现大小大小
+     *
+     * @type {('small' | 'medium' | 'large')}
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * 不显示[冒号]
+     *
+     * @description 默认显示冒号
+     * @default false
+     * @author zhanghanrui
+     * @date 2024-07-29 15:07:52
+     * @type {boolean}
+     */
+    noColon?: boolean;
+    /**
+     * 表单项标题默认宽度
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:44
+     * @type {string}
+     */
+    labelWidth?: string | number;
+    /**
+     * 表单所有字段
+     *
+     * @deprecated
+     * @author zhanghanrui
+     * @date 2024-03-27 15:03:18
+     * @type {string[]}
+     */
+    fields?: string[];
+    /**
+     * 表单项
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 20:03:39
+     * @type {IFormContainer[]}
+     */
+    children: IFormContainer[];
+    /**
+     * 加载数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:27
+     * @param {{ id: string }} params
+     * @return {*}  {Promise<IData>}
+     */
+    loadRequest?(params: {
+        id: string;
+    }): Promise<IData>;
+}

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

@@ -0,0 +1,14 @@
+export type { IFormCollapsePane } from './i-form-collapse-pane';
+export type { IFormCollapse } from './i-form-collapse';
+export type { IEditForm } from './i-edit-form';
+export type { IFormContainer } from './i-form-container';
+export type { IFormEditItem } from './i-form-edit-item';
+export type { IFormGroupContainer } from './i-form-group-container';
+export type { IFormGroup } from './i-form-group';
+export type { IFormTab } from './i-form-tab';
+export type { IFormTabPane } from './i-form-tab-pane';
+export type { IFormHiddenItem } from './i-form-hidden-item';
+export type { IFormItemBasic } from './i-form-item-basic';
+export type { IFormItem } from './i-form-item';
+export type { IFormLine } from './i-form-line';
+export type { IForm } from './i-form';

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

@@ -0,0 +1,75 @@
+import { ILayoutContainerBasis } from '../i-layout-basis/i-layout-container-basis';
+/**
+ * flex 布局容器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-27 11:03:48
+ * @export
+ * @interface IFlexContainer
+ * @extends {ILayoutContainerBasis}
+ */
+export interface IFlexContainer extends ILayoutContainerBasis {
+    /**
+     * 主轴方向
+     * row（默认值）：主轴为水平方向，起点在左端。
+     * row-reverse：主轴为水平方向，起点在右端。
+     * column：主轴为垂直方向，起点在上沿。
+     * column-reverse：主轴为垂直方向，起点在下沿。
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:47
+     * @type {('row' | 'row-reverse' | 'column' | 'column-reverse')}
+     */
+    flexDirection?: 'row' | 'row-reverse' | 'column' | 'column-reverse';
+    /**
+     * 换行模式
+     * nowrap（默认）：不换行
+     * wrap：换行，第一行在上方
+     * wrap-reverse：换行，第一行在下方
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:09
+     * @type {('nowrap' | 'wrap' | 'wrap-reverse')}
+     */
+    flexWrap?: 'nowrap' | 'wrap' | 'wrap-reverse';
+    /**
+     * 主轴对齐方式
+     * flex-start（默认值）：左对齐
+     * flex-end：右对齐
+     * center： 居中
+     * space-between：两端对齐，项目之间的间隔都相等
+     * space-around：每个项目两侧的间隔相等。所以，项目之间的间隔比项目与边框的间隔大一倍
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:38
+     * @type {('flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around')}
+     */
+    justifyContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
+    /**
+     * 交叉轴对齐方式
+     * flex-start：交叉轴的起点对齐
+     * flex-end：交叉轴的终点对齐
+     * center：交叉轴的中点对齐
+     * baseline: 项目的第一行文字的基线对齐
+     * stretch（默认值）：如果项目未设置高度或设为auto，将占满整个容器的高度
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:26
+     * @type {('flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch')}
+     */
+    alignItems?: 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch';
+    /**
+     * 多根轴线的对齐方式
+     * flex-start：与交叉轴的起点对齐
+     * flex-end：与交叉轴的终点对齐
+     * center：与交叉轴的中点对齐
+     * space-between：与交叉轴两端对齐，轴线之间的间隔平均分布
+     * space-around：每根轴线两侧的间隔都相等。所以，轴线之间的间隔比轴线与边框的间隔大一倍
+     * stretch（默认值）：轴线占满整个交叉轴
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:20
+     * @type {('flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'stretch')}
+     */
+    alignContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around' | 'stretch';
+}

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

@@ -0,0 +1,51 @@
+/**
+ * flex 布局项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 19:03:07
+ * @export
+ * @interface IFlexItem
+ */
+export interface IFlexItem {
+    /**
+     * order属性定义项目的排列顺序。数值越小，排列越靠前，默认为0
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:48
+     * @type {number}
+     */
+    order?: number;
+    /**
+     * flex-grow属性定义项目的放大比例，默认为0，即如果存在剩余空间，也不放大
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:21
+     * @type {number}
+     */
+    flexGrow?: number;
+    /**
+     * flex-shrink属性定义了项目的缩小比例，默认为1，即如果空间不足，该项目将缩小
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:42
+     * @type {number}
+     */
+    flexShrink?: number;
+    /**
+     * flex-basis属性定义了在分配多余空间之前，项目占据的主轴空间（main size）。浏览器根据这个属性，计算主轴是否有多余空间。它的默认值为auto，即项目的本来大小
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:03
+     * @type {(number | 'auto')}
+     */
+    flexBasis?: number | 'auto';
+    /**
+     * align-self属性允许单个项目有与其他项目不一样的对齐方式，可覆盖align-items属性
+     * 该属性可能取6个值，除了auto，其他都与align-items属性完全一致
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:30
+     * @type {('auto' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch')}
+     */
+    alignSelf?: 'auto' | 'flex-start' | 'flex-end' | 'center' | 'baseline' | 'stretch';
+}

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

@@ -0,0 +1,29 @@
+import { ILayoutContainerBasis } from '../i-layout-basis/i-layout-container-basis';
+/**
+ * 栅格布局容器
+ *
+ * @author zhanghanrui
+ * @date 2024-03-27 11:03:05
+ * @export
+ * @interface IGridContainer
+ * @extends {ILayoutContainerBasis}
+ */
+export interface IGridContainer extends ILayoutContainerBasis {
+    /**
+     * 栅格布局模式，24栅格或12栅格
+     *
+     * @default 24
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:16
+     * @type {(12 | 24)}
+     */
+    mode: 12 | 24;
+    /**
+     * 栅格间隔
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 11:03:38
+     * @type {(number | Object | number[])}
+     */
+    gutter?: number | object | number[];
+}

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

@@ -0,0 +1,54 @@
+/**
+ * span 布局项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 19:03:40
+ * @export
+ * @interface IGridItemSpan
+ */
+export interface IGridItemSpan {
+    /**
+     * <576px
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:22
+     * @type {number}
+     */
+    sx?: number;
+    /**
+     * ≥576px
+     *
+     * @type {number}
+     */
+    sm?: number;
+    /**
+     * ≥768px
+     *
+     * @type {number}
+     */
+    md?: number;
+    /**
+     * ≥992px
+     *
+     * @type {number}
+     */
+    lg?: number;
+    /**
+     * ≥1200px
+     *
+     * @type {number}
+     */
+    xl?: number;
+    /**
+     * ≥1600px
+     *
+     * @type {number}
+     */
+    xxl?: number;
+    /**
+     * ≥1600px
+     *
+     * @type {number}
+     */
+    xxxl?: number;
+}

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

@@ -0,0 +1,37 @@
+import { IGridItemSpan } from './i-grid-item-span';
+type ColNumber = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24;
+/**
+ * 表格布局项
+ *
+ * @author zhanghanrui
+ * @date 2024-03-26 19:03:43
+ * @export
+ * @interface IGridItem
+ */
+export interface IGridItem {
+    /**
+     * 栅格占位格数
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:53
+     * @type {(ColNumber | IGridItemSpan)}
+     */
+    span?: ColNumber | IGridItemSpan;
+    /**
+     * 偏移量
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:55
+     * @type {ColNumber}
+     */
+    offset?: ColNumber;
+    /**
+     * 栅格顺序
+     *
+     * @author zhanghanrui
+     * @date 2024-03-26 19:03:17
+     * @type {number}
+     */
+    order?: number;
+}
+export {};

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

@@ -0,0 +1,11 @@
+/**
+ * 布局容器基础
+ *
+ * @author zhanghanrui
+ * @date 2024-03-27 11:03:29
+ * @export
+ * @interface ILayoutContainerBasis
+ */
+export interface ILayoutContainerBasis {
+    type?: string;
+}

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

@@ -0,0 +1,6 @@
+export type { IFlexContainer } from './i-flex-layout/i-flex-container';
+export type { IFlexItem } from './i-flex-layout/i-flex-item';
+export type { IGridContainer } from './i-grid-layout/i-grid-container';
+export type { IGridItem } from './i-grid-layout/i-grid-item';
+export type { IGridItemSpan } from './i-grid-layout/i-grid-item-span';
+export type { ILayoutContainerBasis } from './i-layout-basis/i-layout-container-basis';

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

@@ -0,0 +1,24 @@
+import { IProviderBasic } from '@gct-paas/core';
+import { IFormItem } from '../../i-form';
+/**
+ * 编辑器提供者
+ *
+ * @author zhanghanrui
+ * @date 2024-03-27 10:03:54
+ * @export
+ * @interface IEditorProvider
+ * @extends {IProviderBasic}
+ */
+export interface IEditorProvider extends IProviderBasic {
+    /**
+     * 直接特殊绘制
+     *
+     * @author zhanghanrui
+     * @date 2024-03-27 09:03:08
+     * @param {*} value 当前项的值
+     * @param {IData} data 当前表单数据
+     * @param {IFormItem} item 当前表单项模型
+     * @return {*}  {*}
+     */
+    render?(value: any, data: IData, item: IFormItem): any;
+}

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

@@ -0,0 +1,44 @@
+import { IProviderBasic } from '@gct-paas/core';
+import { IFormController, IFormItemBasicController } from '../../i-controller';
+import { IFormItemBasic } from '../../i-form';
+/**
+ * 表单项提供者
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 13:04:46
+ * @export
+ * @interface IFormItemProvider
+ * @extends {IProviderBasic}
+ */
+export interface IFormItemProvider extends IProviderBasic {
+    /**
+     * 表单项组件，可是组件名称或组件实例
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:45
+     * @type {*}
+     */
+    component: any;
+    /**
+     * 直接特殊绘制
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:52
+     * @param {IFormController} form 表单控制器
+     * @param {*} value 当前项的值
+     * @param {IData} data 当前表单数据
+     * @param {IFormItemBasic} item 当前表单项模型
+     * @return {*}  {*}
+     */
+    render?(form: IFormController, value: any, data: IData, item: IFormItemBasic): any;
+    /**
+     * 创建控制器实例
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 10:04:37
+     * @param {IFormController} form
+     * @param {IFormItemBasic} item
+     * @return {*}  {IFormItemBasicController}
+     */
+    createController(form: IFormController, item: IFormItemBasic): IFormItemBasicController;
+}

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

@@ -0,0 +1,2 @@
+export type { IEditorProvider } from './i-editor-provider/i-editor-provider';
+export type { IFormItemProvider } from './i-form-item-provider/i-form-item-provider';