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

package/es/modules/gct-form/hooks/use-gct-form-value/use-gct-form-value.d.ts

@@ -0,0 +1,22 @@
+import { WritableComputedRef } from 'vue';
+/**
+ * 获取编辑器双向数据绑定值对象，自动发送更新事件
+ *
+ * @export
+ * @template T
+ * @param {string} [key] 可以指定字段字段名(指定后直接改 form)，默认取 props 中的 value
+ * @returns {*}  {WritableComputedRef<T>}
+ */
+export declare function useGctFormValue<T = any>(key?: string): WritableComputedRef<T>;
+/**
+ * 获取编辑器双向数据绑定值对象，自动发送更新事件（纯字符串）
+ *
+ * @author zhanghanrui
+ * @date 2024-04-03 13:04:25
+ * @export
+ * @template T
+ * @param {string} [prefix]
+ * @param {string} [suffix]
+ * @return {*}  {WritableComputedRef<T>}
+ */
+export declare function useGctFormValueByText(prefix?: string, suffix?: string): WritableComputedRef<string>;

package/es/modules/gct-form/hooks/use-gct-form-value/use-gct-form-value.mjs

@@ -0,0 +1,89 @@
+import { computed, getCurrentInstance } from 'vue';
+import { useForm } from '../use-form/use-form.mjs';
+
+function useGctFormValue(key) {
+  let val = null;
+  if (key) {
+    const form = useForm();
+    const formItem = form.item[key];
+    if (formItem) {
+      val = computed({
+        get() {
+          return formItem.value;
+        },
+        set(v) {
+          if (typeof v === "string") {
+            v = v.trim();
+          }
+          if (typeof v != "object" && formItem.value == v) {
+            return;
+          }
+          formItem.value = v;
+        }
+      });
+    }
+  } else {
+    let vue = getCurrentInstance().proxy;
+    const props = vue.$props;
+    const emit = vue.$emit;
+    val = computed({
+      get: () => {
+        return props.value;
+      },
+      set: (newVal) => {
+        if (typeof newVal === "string") {
+          newVal = newVal.trim();
+        }
+        if (typeof newVal != "object" && props.value == newVal) {
+          return;
+        }
+        emit("update:value", newVal);
+      }
+    });
+    vue = null;
+  }
+  return val;
+}
+function useGctFormValueByText(prefix, suffix) {
+  let vue = getCurrentInstance().proxy;
+  const props = vue.$props;
+  const emit = vue.$emit;
+  const prefixSize = prefix ? prefix.length : 0;
+  const suffixSize = suffix ? suffix.length : 0;
+  const val = computed({
+    get: () => {
+      if (!props.value) {
+        return "";
+      }
+      let value = props.value;
+      if (prefixSize > 0 && value.startsWith(prefix)) {
+        value = value.substring(prefixSize);
+      }
+      if (suffixSize > 0 && value.endsWith(suffix)) {
+        value = value.substring(0, value.length - suffixSize);
+      }
+      return value;
+    },
+    set: (newVal) => {
+      if (props.value === newVal) {
+        return;
+      }
+      if (newVal == "") {
+        emit("update:value", "");
+        return;
+      }
+      let value = newVal;
+      if (prefixSize > 0) {
+        value = prefix + value;
+      }
+      if (suffixSize > 0) {
+        value = value + suffix;
+      }
+      emit("update:value", value);
+    }
+  });
+  vue = null;
+  return val;
+}
+
+export { useGctFormValue, useGctFormValueByText };

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

@@ -0,0 +1,12 @@
+import { App } from 'vue';
+export * from './constants';
+export * from './controller';
+export * from './hooks';
+export type * from './interface';
+export * from './props';
+export * from './register';
+export * from './state';
+declare const _default: {
+    install(app: App): void;
+};
+export default _default;

package/es/modules/gct-form/index.mjs

@@ -0,0 +1,16 @@
+import 'vue';
+import 'qx-util';
+import 'lodash-es';
+import AllEditor from './editor/index.mjs';
+import GctEditForm from './widgets/gct-edit-form/index.mjs';
+import GctForm$1 from './widgets/gct-form/index.mjs';
+
+const GctForm = {
+  install(app) {
+    app.use(AllEditor);
+    app.use(GctEditForm);
+    app.use(GctForm$1);
+  }
+};
+
+export { GctForm as default };

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

@@ -0,0 +1,20 @@
+import { IFormController } from '../form/form.controller';
+/**
+ * 编辑表单控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 18:04:24
+ * @export
+ * @interface IEditFormController
+ * @extends {IFormController}
+ */
+export interface IEditFormController extends IFormController {
+    /**
+     * 保存表单数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 20:04:25
+     * @return {*}  {Promise<IData>}
+     */
+    save(): Promise<IData>;
+}

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

@@ -0,0 +1,27 @@
+import { IEditorBasic } from '../../i-editor';
+/**
+ * 编辑器控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 13:04:35
+ * @export
+ * @interface IEditorController
+ */
+export interface IEditorController<M extends IEditorBasic = IEditorBasic> {
+    /**
+     * 编辑器模型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 13:04:51
+     * @type {IEditorBasic}
+     */
+    readonly model: M;
+    /**
+     * 编辑器数据字典
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 13:04:22
+     * @type {IObject[]}
+     */
+    options: IObject[];
+}

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

@@ -0,0 +1,121 @@
+import { QXEvent } from 'qx-util';
+import { IFormItemProvider } from '../../i-provider';
+import { IFormState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+import { IFormEvent } from '../../i-events';
+/**
+ * 表单控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 13:04:48
+ * @export
+ * @interface IFormController
+ */
+export interface IFormController {
+    /**
+     * 表单内部事件
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 13:04:51
+     * @type {QXEvent<IFormEvent>}
+     */
+    readonly evt: QXEvent<IFormEvent>;
+    /**
+     * 表单状态
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:51
+     * @type {IFormState}
+     */
+    state: IFormState;
+    /**
+     * 表单项控制器实例
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:17
+     * @type {Record<string, IFormItemBasicController>}
+     */
+    readonly item: Record<string, IFormItemBasicController>;
+    /**
+     * 表单项适配器实例
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 19:04:31
+     * @type {Record<string, IFormItemProvider>}
+     */
+    readonly provider: Record<string, IFormItemProvider>;
+    /**
+     * 表单上下文
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 14:04:57
+     * @type {IParams}
+     */
+    readonly context: IParams;
+    /**
+     * 表单参数
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 14:04:10
+     * @type {IParams}
+     */
+    readonly params: IParams;
+    /**
+     * 获取表单数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:32
+     * @return {*}  {IData}
+     */
+    getData(): IData;
+    /**
+     * 重置表单数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 13:04:52
+     */
+    resetData(): void;
+    /**
+     * 加载表单数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 20:04:29
+     * @return {*}  {Promise<IData>}
+     */
+    load(): Promise<IData>;
+    /**
+     * 数据加载完毕
+     *
+     * @author zhanghanrui
+     * @date 2024-08-01 11:08:42
+     */
+    loaded(): void;
+    /**
+     * 组件销毁调用
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:26
+     */
+    destroy(): void;
+    /**
+     * 校验表单
+     * @author lingxiaoming
+     * @date 2024-07-19 04:07:54
+     * @return {*}  {Promise<boolean>}
+     */
+    validate(): Promise<boolean>;
+    /**
+     * 触发指定表单项值规则校验
+     *
+     * @param {string} key
+     * @returns {*}  {Promise<boolean>}
+     */
+    validateItem(key: string): Promise<boolean>;
+    /**
+     * 组件初始化完毕
+     *
+     * @author zhanghanrui
+     * @date 2024-08-01 11:08:18
+     */
+    mounted(): void;
+}

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

@@ -0,0 +1,23 @@
+import { IFormCollapse } from '../../i-form';
+import { IFormCollapseState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单折叠面板
+ * @author lingxiaoming
+ * @date 2024-07-14 01:53:49
+ * @export
+ * @interface IFormCollapseController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormCollapseController<M extends IFormCollapse = IFormCollapse, S extends IFormCollapseState = IFormCollapseState> extends IFormItemBasicController<M, S> {
+    /**
+     * 折叠面板类型
+     *
+     * @author lingxiaoming
+     * @date 2024-07-14 01:56:56
+     * @type {'collapse'}
+     */
+    type: 'collapse';
+}

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

@@ -0,0 +1,23 @@
+import { IFormCollapsePane } from '../../i-form';
+import { IFormCollapsePaneState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单折叠面板项
+ * @author lingxiaoming
+ * @date 2024-07-14 01:53:49
+ * @export
+ * @interface IFormCollapsePaneController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormCollapsePaneController<M extends IFormCollapsePane = IFormCollapsePane, S extends IFormCollapsePaneState = IFormCollapsePaneState> extends IFormItemBasicController<M, S> {
+    /**
+     * 折叠面板项类型
+     *
+     * @author lingxiaoming
+     * @date 2024-07-14 01:56:56
+     * @type {'collapse-pane'}
+     */
+    type: 'collapse-pane';
+}

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

@@ -0,0 +1,59 @@
+import { IFormEditItem } from '../../i-form';
+import { IFormEditItemState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单编辑项控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-02 20:04:55
+ * @export
+ * @interface IFormEditItemController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormEditItemController<M extends IFormEditItem = IFormEditItem, S extends IFormEditItemState = IFormEditItemState> extends IFormItemBasicController<M, S> {
+    /**
+     * 获取值
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 09:04:18
+     * @return {*}  {*}
+     */
+    value: any;
+    /**
+     * 编辑器使用的值(兼容多值处理)
+     *
+     * @author lingxiaoming
+     * @date 2024-07-18 10:37:37
+     * @type {*}
+     */
+    editorValue: any;
+    /**
+     * 项数据键
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 11:04:21
+     * @type {string}
+     */
+    key: string;
+    /**
+     * 重置表单项值
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 20:04:15
+     */
+    reset(): void;
+    /**
+     * 设置默认值
+     *
+     * @author zhanghanrui
+     * @date 2024-08-06 10:08:15
+     */
+    defaultValue(): void;
+    /**
+     * 失焦
+     *
+     */
+    blur(): void;
+}

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

@@ -0,0 +1,24 @@
+import { IFormGroup } from '../../i-form';
+import { IFormGroupState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单分组
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:04
+ * @export
+ * @interface IFormGroupController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormGroupController<M extends IFormGroup = IFormGroup, S extends IFormGroupState = IFormGroupState> extends IFormItemBasicController<M, S> {
+    /**
+     * 分组类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:50
+     * @type {'group'}
+     */
+    type: 'group';
+}

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

@@ -0,0 +1,24 @@
+import { IFormHiddenItem } from '../../i-form';
+import { IFormHiddenItemState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 隐藏表单项控制器，只存在逻辑，不会渲染元素
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:24
+ * @export
+ * @interface IFormHiddenItemController
+ * @extends {IFormEditItemController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormHiddenItemController<M extends IFormHiddenItem = IFormHiddenItem, S extends IFormHiddenItemState = IFormHiddenItemState> extends IFormItemBasicController<M, S> {
+    /**
+     * 隐藏表单项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:46
+     * @type {'hidden'}
+     */
+    type: 'hidden';
+}

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

@@ -0,0 +1,40 @@
+import { IFormItem } from '../../i-form';
+import { IDictionaryItem } from '@gct-paas/core';
+import { IFormItemState } from '../../i-state';
+import { IFormEditItemController } from '../form-edit-item/form-edit-item.controller';
+/**
+ * 表单项控制器
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:21
+ * @export
+ * @interface IFormItemController
+ * @extends {IFormEditItemController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormItemController<M extends IFormItem = IFormItem, S extends IFormItemState = IFormItemState> extends IFormEditItemController<M, S> {
+    /**
+     * 项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:59
+     * @type {'item'}
+     */
+    type: 'item';
+    /**
+     * 加载动态代码表
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 21:04:02
+     * @return {*}  {Promise<IDictionaryItem[]>}
+     */
+    loadDictionary(params?: IParams, force?: boolean): Promise<IDictionaryItem[]>;
+    /**
+     * 清空现有代码表
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 14:04:05
+     */
+    clearDictionary(): void;
+}

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

@@ -0,0 +1,51 @@
+import { IFormItemBasic } from '../../i-form';
+import { IFormItemBasicState } from '../../i-state';
+/**
+ * 表单项基础接口
+ *
+ * @author zhanghanrui
+ * @date 2024-04-01 14:04:46
+ * @export
+ * @interface IFormItemBasicController
+ */
+export interface IFormItemBasicController<M extends IFormItemBasic = IFormItemBasic, S extends IFormItemBasicState = IFormItemBasicState> {
+    /**
+     * 表单项类型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:54
+     * @type {string} 表单项类型具体子实现定义
+     */
+    type: string;
+    /**
+     * 表单数据
+     *
+     * @author zhanghanrui
+     * @date 2024-04-02 10:04:48
+     * @type {IData}
+     */
+    readonly data: IData;
+    /**
+     * 表单项模型
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:42
+     * @type {IFormItemBasic}
+     */
+    readonly model: M;
+    /**
+     * 表单项状态
+     *
+     * @author zhanghanrui
+     * @date 2024-04-01 14:04:15
+     * @type {IFormItemBasicState}
+     */
+    state: S;
+    /**
+     * 表单销毁调用
+     *
+     * @author zhanghanrui
+     * @date 2024-04-03 16:04:32
+     */
+    destroy(): void;
+}

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

@@ -0,0 +1,20 @@
+import { IFormLine } from '../../i-form';
+import { IFormLineState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单分组
+ *
+ * @export
+ * @interface IFormLineController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormLineController<M extends IFormLine = IFormLine, S extends IFormLineState = IFormLineState> extends IFormItemBasicController<M, S> {
+    /**
+     * 分组类型
+     *
+     * @type {'line'}
+     */
+    type: 'line';
+}

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

@@ -0,0 +1,23 @@
+import { IFormTab } from '../../i-form';
+import { IFormTabState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单分页
+ * @author lingxiaoming
+ * @date 2024-07-14 01:53:49
+ * @export
+ * @interface IFormTabController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormTabController<M extends IFormTab = IFormTab, S extends IFormTabState = IFormTabState> extends IFormItemBasicController<M, S> {
+    /**
+     * 分页类型
+     *
+     * @author lingxiaoming
+     * @date 2024-07-14 01:56:56
+     * @type {'tab'}
+     */
+    type: 'tab';
+}

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

@@ -0,0 +1,23 @@
+import { IFormTabPane } from '../../i-form';
+import { IFormTabPaneState } from '../../i-state';
+import { IFormItemBasicController } from '../form-item-basic/form-item-basic.controller';
+/**
+ * 表单分页
+ * @author lingxiaoming
+ * @date 2024-07-14 01:53:49
+ * @export
+ * @interface IFormTabPaneController
+ * @extends {IFormItemBasicController<M, S>}
+ * @template M
+ * @template S
+ */
+export interface IFormTabPaneController<M extends IFormTabPane = IFormTabPane, S extends IFormTabPaneState = IFormTabPaneState> extends IFormItemBasicController<M, S> {
+    /**
+     * 分页pane类型
+     *
+     * @author lingxiaoming
+     * @date 2024-07-14 01:56:56
+     * @type {'tab-pane'}
+     */
+    type: 'tab-pane';
+}

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

@@ -0,0 +1,13 @@
+export type { IEditFormController } from './edit-form/edit-form.controller';
+export type { IEditorController } from './editor-item/editor-item.controller';
+export type { IFormController } from './form/form.controller';
+export type { IFormCollapsePaneController } from './form-collapse-pane/form-collapse-pane.controller';
+export type { IFormCollapseController } from './form-collapse/form-collapse.controller';
+export type { IFormEditItemController } from './form-edit-item/form-edit-item.controller';
+export type { IFormGroupController } from './form-group/form-group.controller';
+export type { IFormTabController } from './form-tab/form-tab.controller';
+export type { IFormTabPaneController } from './form-tab-pane/form-tab-pane.controller';
+export type { IFormHiddenItemController } from './form-hidden-item/form-hidden-item.controller';
+export type { IFormItemController } from './form-item/form-item.controller';
+export type { IFormItemBasicController } from './form-item-basic/form-item-basic.controller';
+export type { IFormLineController } from './form-line/form-line.controller';

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

@@ -0,0 +1,23 @@
+import { IEditorBasic } from './i-editor-basic';
+import { EditorType } from '../../constants';
+import { IFormController, IFormEditItemController } from '../i-controller';
+export interface IActionEditor extends IEditorBasic {
+    readonly type: EditorType.ACTION;
+    /**
+     * 按钮名称
+     *
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 按钮图标
+     *
+     * @type {string}
+     */
+    icon?: string;
+    /**
+     * 按钮点击
+     *
+     */
+    click?: (e: MouseEvent, from: IFormController, item: IFormEditItemController, data: IData) => void;
+}