vft 0.0.142 → 0.0.145

package/es/components/super-form/types.d.ts

@@ -3,6 +3,7 @@ import type { FormItemProp, FormItemProps, FormProps } from 'vft/es/components/f
 import type { InternalRuleItem, RuleItem } from 'async-validator';
 import type { StyleValue, VNode } from 'vue';
 import { FormCompEnum } from './component-map';
+import type { Arrayable, Recordable } from '../types';
 export type ButtonOptions = Partial<ButtonProps> & {
     btnText?: string;
 };
@@ -21,6 +22,8 @@ export type Rule = {
 };
 type FormItemRule = Omit<RuleItem, 'validator'> & Rule & {
     validator?: (rule: InternalRuleItem, value: any, callback?: (error?: string | Error) => void) => Promise<any>;
+} & {
+    isNumber?: boolean;
 };
 export interface RenderCallbackParams {
     schema: FormSchema;
@@ -57,81 +60,117 @@ export interface SuperFormActionProps {
 }
 type FormInnerProps = FormProps & SuperFormActionProps;
 export interface SuperFormProps extends FormInnerProps {
+    /** 配置表单的 RowProps */
     rowProps?: RowProps;
+    /** 配置所有选子项的 ColProps */
     baseColProps?: Partial<ColProps>;
+    /** 根据 1/2/3...快速分列 */
     quickColSpan?: number;
+    /** 自动设置占位符 */
     autoSetPlaceHolder?: boolean;
+    /** 表单配置 */
     schemas?: FormSchema[];
+    /** 是否聚焦第一个输入框，只在第一个表单项为 input 的时候作用 */
     autoFocusFirstItem?: boolean;
+    /** 重置时是否提交表单 */
     submitOnReset?: boolean;
+    /** 额外传递到子组件的参数 values */
     mergeDynamicData?: Recordable;
+    /** 将表单内时间区域的值映射成 2 个字段 */
     fieldMapToTime?: FieldMapToTime;
+    /** 在input中输入时按回车自动提交 */
     autoSubmitOnEnter?: boolean;
+    /** 如果表单项有校验，会自动生成校验信息，该参数控制是否将字段中文名字拼接到自动生成的信息后方 */
     rulesMessageJoinLabel?: boolean;
-    autoAdvancedLine?: number;
-    alwaysShowLines?: number;
-    tableAction?: any;
+    /** 表单改变时触发提交 */
     submitOnChange?: boolean;
+    /** 是否显示操作按钮(重置/提交) */
     showActionButtonGroup?: boolean;
+    /** 自动清除报错信息 */
     autoCleanErrorMessage?: boolean;
+    /** 提交前置事件 */
     beforeSubmitFunc?: () => Promise<void>;
+    /** 提交 */
     submitFunc?: () => Promise<void>;
+    /** 监听数据是否发生改变 */
     watchDataIsChange?: boolean;
+    /** Form 下组件宽度是否撑满 */
     compFullWidth?: boolean;
+    /** 操作栏是否为行内 */
     actionInline?: boolean;
+    /** 自定义 reset 事件 */
+    resetFunc?: () => Promise<void>;
 }
 export interface FormSchema {
+    /** 字段 key */
     field: string;
-    changeEvent?: string;
-    valueField?: string;
+    /** 名称 label title 都可以 */
     label?: string | VNode;
     title?: string | VNode;
+    /** 值改变的触发事件 */
+    changeEvent?: string;
+    /** v-model 绑定的 value 值 */
+    valueField?: string;
+    /** 子 label */
     subLabel?: string;
+    /** 是否显示 label */
     showLabel?: boolean;
-    helpMessage?: string | string[] | ((renderCallbackParams: RenderCallbackParams) => string | string[]);
-    helpComponentProps?: Partial<HelpComponentProps>;
+    /** 标签宽度，如果通过，则 itemProps 配置的 labelCol 和 WrapperCol 将无效 */
     labelWidth?: string | number;
-    disabledLabelWidth?: boolean;
+    /** 渲染组件 */
     type?: FormCompEnum;
+    /** 组件内置参数 */
     componentProps?: ((opt: {
         schema: FormSchema;
-        tableAction?: any;
         formActionType: FormActionType;
         formModel: Recordable;
     }) => Recordable) | object;
+    /** 是否为必填项 */
     required?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
+    /** 组件后自定义内容 */
     suffix?: string | number | ((values: RenderCallbackParams) => string | number) | VNode | JSX.Element | (() => JSX.Element);
+    /** 组件前自定义内容 */
     prefix?: string | number | ((values: RenderCallbackParams) => string | number) | VNode | JSX.Element | (() => JSX.Element);
+    /** 前置内容父级样式 */
     prefixParentStyle?: StyleValue;
+    /** 自定义规则 */
     rules?: FormItemRule[] | FormItemRule;
+    /** 自定义报错规则是否添加自动添加 label */
     rulesMessageJoinLabel?: boolean;
+    /** 自动生成 placeholder */
     placeholderJoinLabel?: boolean;
-    itemProps?: Partial<FormItemProps>;
+    /** form-item 参数 */
+    itemProps?: Partial<FormItemProps & {
+        title: string;
+    }>;
+    /** col 参数 */
     colProps?: Partial<ColProps>;
+    /** 根据 1/2/3...快速分列 */
     quickColSpan?: number;
+    /** 默认值 */
     defaultValue?: any;
+    /** 是否自动处理与时间相关组件的默认值 */
     isHandleDateDefaultValue?: boolean;
-    isAdvanced?: boolean;
+    /** 栅格占据的列数 */
     span?: number;
+    /** 动态判断当前组件是否显示，js 控制，会删除 dom */
     ifShow?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
+    /** 动态判断当前组件是否显示，css 控制，不会删除 dom */
     show?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
+    /** 自定义渲染组件*/
     render?: (renderCallbackParams: RenderCallbackParams) => VNode | VNode[] | string;
+    /** 自定义渲染组件（需要自行包含 formItem）*/
     renderColContent?: (renderCallbackParams: RenderCallbackParams) => VNode | VNode[] | string;
+    /** 自定义渲染组内部的 slot */
     renderComponentContent?: ((renderCallbackParams: RenderCallbackParams) => any) | VNode | VNode[] | string;
+    /** 自定义 slot，渲染组件 */
     slot?: string;
+    /** 自定义 slot，渲染组件 （需要自行包含 formItem）*/
     colSlot?: string;
+    /** 动态判断当前组件是否禁用 */
     dynamicDisabled?: boolean | ((renderCallbackParams: RenderCallbackParams) => boolean);
-    dynamicRule?: (renderCallbackParams: RenderCallbackParams) => Rule | Rule[];
+    /** 动态判返当前组件你校验规则 */
+    dynamicRule?: (renderCallbackParams: RenderCallbackParams) => Arrayable<FormItemRule>;
     dynamicRuleAdd?: boolean;
 }
-export interface HelpComponentProps {
-    maxWidth: string;
-    showIndex: boolean;
-    text: any;
-    color: string;
-    fontSize: string;
-    icon: string;
-    absolute: boolean;
-    position: any;
-}
 export {};

package/es/components/super-form/use/helper.d.ts

@@ -1,3 +1,17 @@
 import { FormCompEnum } from '../component-map';
+/**
+ * @description 自动创建 placeholder
+ * @example
+ * @returns
+ * @param type 组件类型
+ * @param label
+ */
 export declare function createPlaceholderMessage(type: FormCompEnum, label?: string): string;
+/**
+ * @description 处理 input 输入为数值的 val
+ * @example
+ * @returns
+ * @param type
+ * @param val
+ */
 export declare function handleInputNumberValue(type?: FormCompEnum, val?: any): any;

package/es/components/super-form/use/use-auto-focus.d.ts

@@ -6,5 +6,6 @@ interface UseAutoFocusContext {
     isInitedDefault: Ref<boolean>;
     formElRef: Ref<FormActionType>;
 }
+/** 自动聚焦处理 */
 export declare function useAutoFocus({ getSchema, getProps, formElRef, isInitedDefault, }: UseAutoFocusContext): Promise<void>;
 export {};

package/es/components/super-form/use/use-form-context.d.ts

@@ -1,5 +1,5 @@
 export interface FormContextProps {
-    resetAction: () => Promise<void>;
+    resetAction: (props?: Record<string, any>) => Promise<void>;
     submitAction: () => Promise<void>;
 }
 export declare function createFormContext(context: FormContextProps): {

package/es/components/super-form/use/use-form-events.d.ts

@@ -1,4 +1,5 @@
 import type { ComputedRef, Ref } from 'vue';
+import type { Fn, Recordable } from '../../types';
 import type { FormActionType, FormSchema, SuperFormProps } from '../types';
 interface UseFormActionContext {
     emit: any;

package/es/components/super-form/use/use-form-events.js

@@ -1,7 +1,7 @@
-import { isFunction as B, formatToDate as U, isDef as z, isString as g, isObject as I, isArray as w, deepMerge as M, isNullOrUndefined as G, isEmpty as tt, isEmptyObject as nt } from "@vft/utils";
-import { cloneDeep as m, get as et, uniqBy as it, isEqual as ct, set as H } from "lodash";
-import { unref as c, nextTick as rt, toRaw as j } from "vue";
-import { isInput as st, FormCompEnum as x, isDatePicker as at } from "../component-map.js";
+import { isFunction as B, formatToDate as U, isDef as z, isString as g, isObject as I, isArray as w, deepMerge as tt, isNullOrUndefined as G, isEmpty as nt, isEmptyObject as et } from "@vft/utils";
+import { cloneDeep as m, get as it, uniqBy as ct, isEqual as st, set as J } from "lodash";
+import { unref as c, nextTick as H, toRaw as j } from "vue";
+import { isInput as rt, FormCompEnum as x, isDatePicker as at } from "../component-map.js";
 import { handleInputNumberValue as ut } from "./helper.js";
 function ot(p, F = {}) {
   const u = /^\[(.+)\]$/;
@@ -13,7 +13,7 @@ function ot(p, F = {}) {
         return;
       const f = [];
       return v.forEach((y, D) => {
-        H(f, D, F[y.trim()]);
+        J(f, D, F[y.trim()]);
       }), f.filter(Boolean).length ? f : void 0;
     }
   }
@@ -28,7 +28,7 @@ function ft(p, F = {}) {
         return;
       const f = {};
       return v.forEach((y) => {
-        H(f, y.trim(), F[y.trim()]);
+        J(f, y.trim(), F[y.trim()]);
       }), Object.values(f).filter(Boolean).length ? f : void 0;
     }
   }
@@ -42,37 +42,37 @@ function vt({
   formElRef: f,
   schemaRef: y,
   handleFormValues: D,
-  initValues: J
+  initValues: P
 }) {
-  async function P(t) {
+  async function Q(t) {
     const { resetFunc: n, submitOnReset: a } = c(F);
     n && B(n) && await n();
     const i = c(f);
     if (i) {
       if (t != null && t.length)
         return i.resetFields(t);
-      Object.keys(u).forEach((r) => {
-        const e = c(d).find((o) => o.field === r), s = m(v.value[r]);
-        u[r] = st(e == null ? void 0 : e.type) ? s || "" : s;
-      }), rt(() => O()), p("reset", j(u)), a && await q();
+      Object.keys(u).forEach((s) => {
+        const e = c(d).find((o) => o.field === s), r = m(v.value[s]);
+        u[s] = rt(e == null ? void 0 : e.type) ? r || "" : r;
+      }), H(() => O()), p("reset", j(u)), a && await q();
     }
   }
   async function S(t) {
     const n = c(d).map((e) => e.field).filter(Boolean), a = ".", i = n.filter(
       (e) => String(e).indexOf(a) >= 0
-    ), r = [];
+    ), s = [];
     n.forEach((e) => {
-      const s = c(d).find((l) => l.field === e);
-      let o = et(t, e);
+      const r = c(d).find((l) => l.field === e);
+      let o = it(t, e);
       const A = Reflect.has(t, e);
-      o = ut(s == null ? void 0 : s.type, o);
-      const { componentProps: N } = s || {};
+      o = ut(r == null ? void 0 : r.type, o);
+      const { componentProps: N } = r || {};
       let h = N;
       typeof N == "function" && (h = h({ formModel: c(u) }));
       const $ = ot(e, t) || ft(e, t);
       if (A || $) {
         const l = $ || o;
-        if (K(e))
+        if (R(e))
           if (Array.isArray(l)) {
             const E = [];
             for (const b of l)
@@ -82,46 +82,48 @@ function vt({
             c(u)[e] = l ? h != null && h.valueFormat ? l : U(l) : null;
         else
           c(u)[e] = l;
-        h != null && h.onChange && (h == null || h.onChange(l)), r.push(e);
+        h != null && h.onChange && (h == null || h.onChange(l)), s.push(e);
       } else
         i.forEach((l) => {
           try {
-            const E = l.split(".").reduce((b, k) => b[k], t);
-            z(E) && (c(u)[l] = c(E), r.push(l));
+            const E = l.split(".").reduce((b, M) => b[M], t);
+            z(E) && (c(u)[l] = c(E), s.push(l));
           } catch {
             z(v.value[l]) && (c(u)[l] = m(
               c(v.value[l])
             ));
           }
         });
-    }), await C(r).catch((e) => {
+    }), H(async () => {
+      await C(s).catch((e) => {
+      });
     });
   }
-  async function Q(t) {
+  async function W(t) {
     const n = m(c(d));
     if (!t)
       return;
     let a = g(t) ? [t] : t;
     g(t) && (a = [t]);
     for (const i of a)
-      W(i, n);
+      X(i, n);
     y.value = n;
   }
-  function W(t, n) {
+  function X(t, n) {
     if (g(t)) {
       const a = n.findIndex((i) => i.field === t);
       a !== -1 && (delete u[t], n.splice(a, 1));
     }
   }
-  async function X(t, n, a = !1) {
-    const i = m(c(d)), r = i.findIndex((s) => s.field === n), e = I(t) ? [t] : t;
-    if (!n || r === -1 || a) {
+  async function Y(t, n, a = !1) {
+    const i = m(c(d)), s = i.findIndex((r) => r.field === n), e = I(t) ? [t] : t;
+    if (!n || s === -1 || a) {
       a ? i.unshift(...e) : i.push(...e), y.value = i, V(t);
       return;
     }
-    r !== -1 && i.splice(r + 1, 0, ...e), V(t), y.value = i;
+    s !== -1 && i.splice(s + 1, 0, ...e), V(t), y.value = i;
   }
-  async function Y(t) {
+  async function Z(t) {
     let n = [];
     if (I(t) && n.push(t), w(t) && (n = [...t]), !n.every(
       (i) => i.type === x.DIVIDER || Reflect.has(i, "field") && i.field
@@ -133,7 +135,7 @@ function vt({
     }
     y.value = n;
   }
-  async function Z(t) {
+  async function _(t) {
     let n = [];
     if (I(t) && n.push(t), w(t) && (n = [...t]), !n.every(
       (e) => e.type === x.DIVIDER || Reflect.has(e, "field") && e.field
@@ -143,35 +145,35 @@ function vt({
       );
       return;
     }
-    const i = [], r = [];
+    const i = [], s = [];
     c(d).forEach((e) => {
-      let s;
+      let r;
       if (n.forEach((o) => {
-        e.field === o.field && (s = o), o.defaultValue && o.field && i.push(o.field);
-      }), s !== void 0 && e.field === s.field) {
-        const o = M(e, s);
-        r.push(o);
+        e.field === o.field && (r = o), o.defaultValue && o.field && i.push(o.field);
+      }), r !== void 0 && e.field === r.field) {
+        const o = tt(e, r);
+        s.push(o);
       } else
-        r.push(e);
-    }), V(r, i), y.value = it(r, "field");
+        s.push(e);
+    }), V(s, i), y.value = ct(s, "field");
   }
   function V(t, n) {
     if (w(n) && (n == null ? void 0 : n.length) === 0)
       return;
     let a = [];
     I(t) && a.push(t), w(t) && (a = [...t]);
-    const i = {}, r = T();
+    const i = {}, s = T();
     a.forEach((e) => {
-      e.type !== x.DIVIDER && Reflect.has(e, "field") && e.field && !G(e.defaultValue) && (!(e.field in r) || G(r[e.field]) || tt(r[e.field])) && (i[e.field] = e.defaultValue);
-    }), nt(i) || S(i);
+      e.type !== x.DIVIDER && Reflect.has(e, "field") && e.field && !G(e.defaultValue) && (!(e.field in s) || G(s[e.field]) || nt(s[e.field])) && (i[e.field] = e.defaultValue);
+    }), et(i) || S(i);
   }
   function T() {
     return c(f) ? D(j(c(u))) : {};
   }
-  function _(t) {
+  function K(t) {
     return c(f) ? j(c(u))[t] : {};
   }
-  function K(t) {
+  function R(t) {
     return c(d).some((n) => n.field === t ? at(n.type) : !1);
   }
   async function C(t) {
@@ -186,30 +188,30 @@ function vt({
     var n;
     await ((n = c(f)) == null ? void 0 : n.clearValidate(t));
   }
-  async function R(t, n) {
+  async function k(t, n) {
     var a;
     await ((a = c(f)) == null ? void 0 : a.scrollToField(t, n));
   }
   async function q(t) {
     const { autoCleanErrorMessage: n, watchDataIsChange: a } = c(F);
     t && t.preventDefault(), n && await O();
-    const { submitFunc: i, beforeSubmitFunc: r } = c(F);
-    if (r && B(r) && await r(), i && B(i)) {
+    const { submitFunc: i, beforeSubmitFunc: s } = c(F);
+    if (s && B(s) && await s(), i && B(i)) {
       await i();
       return;
     }
     if (c(f))
       try {
-        const s = await L(), o = D(s);
+        const r = await L(), o = D(r);
         if (a) {
-          const A = ct(J.value, o);
+          const A = st(P.value, o);
           p("submit", o, !A);
         } else
           p("submit", o);
-      } catch (s) {
-        if ((s == null ? void 0 : s.outOfDate) === !1 && (s != null && s.errorFields))
+      } catch (r) {
+        if ((r == null ? void 0 : r.outOfDate) === !1 && (r != null && r.errorFields))
           return;
-        throw new Error(s.message);
+        throw new Error(r.message);
       }
   }
   return {
@@ -218,14 +220,14 @@ function vt({
     validate: L,
     validateField: C,
     getFieldsValue: T,
-    updateSchema: Z,
-    resetSchema: Y,
-    appendSchemaByField: X,
-    removeSchemaByField: Q,
-    resetFields: P,
+    updateSchema: _,
+    resetSchema: Z,
+    appendSchemaByField: Y,
+    removeSchemaByField: W,
+    resetFields: Q,
     setFieldsValue: S,
-    scrollToField: R,
-    getFieldValue: _
+    scrollToField: k,
+    getFieldValue: K
   };
 }
 export {

package/es/components/super-form/use/use-form-values.d.ts

@@ -1,4 +1,5 @@
 import type { ComputedRef, Ref } from 'vue';
+import type { Recordable } from '../../types';
 import type { FormSchema, SuperFormProps } from '../types';
 interface UseFormValuesContext {
     defaultValueRef: Ref<any>;
@@ -7,7 +8,7 @@ interface UseFormValuesContext {
     formModel: Recordable;
 }
 export declare function useFormValues({ defaultValueRef, getSchema, formModel, getProps, }: UseFormValuesContext): {
-    handleFormValues: (values: Recordable) => Recordable<any>;
+    handleFormValues: (values: Recordable) => Recordable;
     initDefault: () => void;
 };
 export {};

package/es/components/super-form/use/use-form-values.js

@@ -1,80 +1,76 @@
-import { isObject as T, isArray as A, isFunction as O, isString as V, formatToDate as D, isNullOrUndefined as Y } from "@vft/utils";
-import { set as h, cloneDeep as E } from "lodash";
-import { unref as b } from "vue";
-function F(m, e, a) {
+import { isObject as p, isArray as F, isFunction as b, isString as j, formatToDate as l, isNullOrUndefined as O } from "@vft/utils";
+import { set as y, cloneDeep as V } from "lodash";
+import { unref as Y } from "vue";
+function g(f, i, m) {
   const c = /^\[(.+)\]$/;
-  if (c.test(m)) {
-    const o = m.match(c);
+  if (c.test(f)) {
+    const o = f.match(c);
     if (o && o[1]) {
-      const y = o[1].split(",");
-      return e = Array.isArray(e) ? e : [e], y.forEach((d, r) => {
-        h(a, d.trim(), e[r]);
+      const u = o[1].split(",");
+      return i = Array.isArray(i) ? i : [i], u.forEach((a, r) => {
+        y(m, a.trim(), i[r]);
       }), !0;
     }
   }
 }
-function M(m, e, a) {
+function E(f, i, m) {
   const c = /^\{(.+)\}$/;
-  if (c.test(m)) {
-    const o = m.match(c);
+  if (c.test(f)) {
+    const o = f.match(c);
     if (o && o[1]) {
-      const y = o[1].split(",");
-      return e = T(e) ? e : {}, y.forEach((d) => {
-        h(a, d.trim(), e[d.trim()]);
+      const u = o[1].split(",");
+      return i = p(i) ? i : {}, u.forEach((a) => {
+        y(m, a.trim(), i[a.trim()]);
       }), !0;
     }
   }
 }
-function $({
-  defaultValueRef: m,
-  getSchema: e,
-  formModel: a,
+function P({
+  defaultValueRef: f,
+  getSchema: i,
+  formModel: m,
   getProps: c
 }) {
   function o(r) {
-    var i, f;
-    if (!T(r))
+    if (!p(r))
       return {};
     const n = {};
-    for (const l of Object.entries(r)) {
-      let [, t] = l;
-      const [u] = l;
-      if (!u || A(t) && t.length === 0 || O(t))
-        continue;
-      const s = b(c).transformDateFunc;
-      T(t) && (t = s == null ? void 0 : s(t)), A(t) && ((i = t[0]) != null && i.format) && ((f = t[1]) != null && f.format) && (t = t.map((p) => s == null ? void 0 : s(p))), V(t) && (t === "" ? t = void 0 : t = t.trim()), !F(u, t, n) && !M(u, t, n) && h(n, u, t);
+    for (const e of Object.entries(r)) {
+      let [, t] = e;
+      const [s] = e;
+      !s || F(t) && t.length === 0 || b(t) || (j(t) && (t === "" ? t = void 0 : t = t.trim()), !g(s, t, n) && !E(s, t, n) && y(n, s, t));
     }
-    return y(n);
+    return u(n);
   }
-  function y(r) {
-    const n = b(c).fieldMapToTime;
+  function u(r) {
+    const n = Y(c).fieldMapToTime;
     if (!n || !Array.isArray(n))
       return r;
     for (const [
-      i,
-      [f, l],
-      t = "YYYY-MM-DD"
+      e,
+      [t, s],
+      d = "YYYY-MM-DD"
     ] of n) {
-      if (!i || !f || !l)
+      if (!e || !t || !s)
         continue;
-      if (!r[i]) {
-        Reflect.deleteProperty(r, i);
+      if (!r[e]) {
+        Reflect.deleteProperty(r, e);
         continue;
       }
-      const [u, s] = r[i], [p, j] = Array.isArray(t) ? t : [t, t];
-      r[f] = D(u, p), r[l] = D(s, j), Reflect.deleteProperty(r, i);
+      const [T, h] = r[e], [A, D] = Array.isArray(d) ? d : [d, d];
+      r[t] = l(T, A), r[s] = l(h, D), Reflect.deleteProperty(r, e);
     }
     return r;
   }
-  function d() {
-    const r = e.value, n = {};
-    r == null || r.forEach((i) => {
-      const { defaultValue: f } = i;
-      Y(f) || (n[i.field] = f, a[i.field] === void 0 && (a[i.field] = f));
-    }), m.value = E(n);
+  function a() {
+    const r = i.value, n = {};
+    r == null || r.forEach((e) => {
+      const { defaultValue: t } = e;
+      O(t) || (n[e.field] = t, m[e.field] === void 0 && (m[e.field] = t));
+    }), f.value = V(n);
   }
-  return { handleFormValues: o, initDefault: d };
+  return { handleFormValues: o, initDefault: a };
 }
 export {
-  $ as useFormValues
+  P as useFormValues
 };