@gopowerteam/form-render 0.0.94 → 1.0.0

package/dist/cjs/config/provide.config.d.ts

@@ -1,6 +1,5 @@
 import { InjectionKey, Ref } from 'vue';
 import { DataRecord } from '../interfaces';
-
 export declare const provides: {
     id: InjectionKey<Ref<string>>;
     source: InjectionKey<Ref<DataRecord>>;

package/dist/cjs/defines/define-form.d.ts

@@ -1,4 +1,3 @@
 import { DataRecord, FormItemsOptions, FormItemsStringKeyOptions, FormItemsTypeKeyOptions } from '../interfaces';
-
 export declare function defineForm<T = DataRecord>(form: FormItemsTypeKeyOptions<T>): FormItemsOptions<T>;
 export declare function defineForm<T = DataRecord>(form: FormItemsStringKeyOptions<T>): FormItemsOptions<T>;

package/dist/cjs/form-items/cascader/index.d.ts

@@ -1,7 +1,6 @@
 import { CascaderOption, TriggerProps } from '@arco-design/web-vue';
 import { Ref } from 'vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderCascaderItem<T = DataRecord>(options: RenderCascaderItemOptions): FormItemRenderReturn<T>;
 export type SelectOptions = CascaderOption[];
 export interface RenderCascaderItemOptions {

package/dist/cjs/form-items/currency/index.d.ts

@@ -1,5 +1,4 @@
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderCurrencyItem<T = DataRecord>(options?: RenderCurrencyOptions): FormItemRenderReturn<T>;
 export interface RenderCurrencyOptions {
     placeholder?: string;

package/dist/cjs/form-items/date/index.d.ts

@@ -1,6 +1,5 @@
 import { ShortcutType } from '@arco-design/web-vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 /**
  * 日期节点表单渲染
  * @param options 日期节点配置选项

package/dist/cjs/form-items/date-range/index.d.ts

@@ -1,6 +1,5 @@
 import { ShortcutType } from '@arco-design/web-vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 /**
  * 日期节点表单渲染
  * @param options 日期节点配置选项

package/dist/cjs/form-items/input/index.d.ts

@@ -1,5 +1,4 @@
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderInputItem<T = DataRecord>(options?: RenderInputItemOptions): FormItemRenderReturn<T>;
 export interface RenderInputItemOptions {
     placeholder?: string;

package/dist/cjs/form-items/radio/index.d.ts

@@ -1,6 +1,5 @@
 import { Ref } from 'vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderRadioItem<T = DataRecord>(options: RenderRadioItemOptions): FormItemRenderReturn<T>;
 export type RadioOptions = Map<string | number, string>;
 export interface RenderRadioItemOptions {

package/dist/cjs/form-items/render/index.d.ts

@@ -1,5 +1,4 @@
 import { DataRecord, FormItemOptions, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderRenderItem<T = DataRecord>(renderer: RenderInputItemOptions<T>): FormItemRenderReturn<T>;
 export interface RenderInputItemOptions<T> {
     (record: T, form?: FormItemOptions<T>): JSX.Element;

package/dist/cjs/form-items/select/index.d.ts

@@ -1,6 +1,5 @@
 import { Ref } from 'vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderSelectItem<T = DataRecord>(options: RenderSelectItemOptions): FormItemRenderReturn<T>;
 export type SelectOptions = Map<string | number | boolean | Record<string, any> | (string | number | boolean | Record<string, any>)[], string>;
 export interface RenderSelectItemOptions {

package/dist/cjs/form-items/switch/index.d.ts

@@ -1,5 +1,4 @@
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderSwitchItem<T = DataRecord>(options?: RenderSwitchItemOptions): FormItemRenderReturn<T>;
 export type SelectOptions = Map<string | number, string>;
 export interface RenderSwitchItemOptions {

package/dist/cjs/form-items/textarea/index.d.ts

@@ -1,5 +1,4 @@
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderTextareaItem<T = DataRecord>(options?: RenderTextareaItemOptions): FormItemRenderReturn<T>;
 export interface RenderTextareaItemOptions {
     placeholder?: string;

package/dist/cjs/form-items/tree-select/index.d.ts

@@ -1,8 +1,7 @@
 import { TreeFieldNames, TreeNodeData } from '@arco-design/web-vue';
-import { Ref } from 'vue';
 import { TreeProps } from '@arco-design/web-vue/es/tree/interface';
+import { Ref } from 'vue';
 import { DataRecord, FormItemRenderReturn } from '../../interfaces';
-
 export declare function renderTreeSelectItem<T = DataRecord>(options: RenderTreeSelectItemOptions): FormItemRenderReturn<T>;
 export type SelectOptions = TreeNodeData[];
 export interface RenderTreeSelectItemOptions {

package/dist/cjs/form-render/form-collapsed-dialog.d.ts

@@ -1,7 +1,6 @@
 import { PropType } from 'vue';
 import { FormItemsOptions } from '..';
-
-declare const _default: import('vue').DefineComponent<{
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
     form: {
         type: PropType<FormItemsOptions>;
         required: true;
@@ -13,7 +12,7 @@ declare const _default: import('vue').DefineComponent<{
         type: NumberConstructor;
         default: number;
     };
-}, {
+}>, {
     formItems: {
         collapsed: boolean;
         key: string;
@@ -35,10 +34,10 @@ declare const _default: import('vue').DefineComponent<{
         instance?: any;
         form: FormItemsOptions;
     }[];
-    activeTab: import('vue').Ref<string>;
+    activeTab: import('vue').Ref<string, string>;
     onSubmit: () => void;
     onReset: () => void;
-}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
     form: {
         type: PropType<FormItemsOptions>;
         required: true;
@@ -50,7 +49,7 @@ declare const _default: import('vue').DefineComponent<{
         type: NumberConstructor;
         default: number;
     };
-}>>, {
+}>> & Readonly<{}>, {
     columns: number;
-}, {}>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/cjs/form-render/form-item-render.d.ts

@@ -1,9 +1,9 @@
 import { DataRecord, FormItemOptions } from '../interfaces';
-
 /**
  * 创建表格列
- * @param options
- * @returns
+ * @param source 数据源
+ * @param options 表单项配置
+ * @returns 表单项VNode
  */
 export declare function renderFormItem(source: DataRecord, options: FormItemOptions): import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
     [key: string]: any;

package/dist/cjs/form-render/index.d.ts

@@ -1,8 +1,7 @@
-import { PropType } from 'vue';
 import { FieldRule } from '@arco-design/web-vue';
+import { PropType } from 'vue';
 import { DataRecord, FormItemsOptions } from '../interfaces';
-
-export declare const FormRender: import('vue').DefineComponent<{
+export declare const FormRender: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
     form: {
         type: PropType<FormItemsOptions<any>>;
         required: true;
@@ -84,11 +83,11 @@ export declare const FormRender: import('vue').DefineComponent<{
         required: false;
         default: number;
     };
-}, {
-    formId: import('vue').Ref<string>;
-    formName: import('vue').Ref<string>;
-    formSource: import('vue').Ref<DataRecord>;
-    formInstance: import('vue').Ref<import('vue').CreateComponentPublicInstance<Readonly<{
+}>, {
+    formId: import('vue').Ref<string, string>;
+    formName: import('vue').Ref<string, string>;
+    formSource: import('vue').Ref<DataRecord, DataRecord>;
+    formInstance: import('vue').Ref<import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
         model?: unknown;
         layout?: unknown;
         size?: unknown;
@@ -156,7 +155,22 @@ export declare const FormRender: import('vue').DefineComponent<{
             values: Record<string, any>;
             errors: Record<string, import('@arco-design/web-vue').ValidatedError>;
         }, ev: Event) => true;
-    }, import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & Readonly<{
+    }, import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, {
+        disabled: boolean;
+        layout: "inline" | "horizontal" | "vertical";
+        labelColProps: Record<string, any>;
+        wrapperColProps: Record<string, any>;
+        labelAlign: "left" | "right";
+        autoLabelWidth: boolean;
+        scrollToFirstError: boolean;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
         model?: unknown;
         layout?: unknown;
         size?: unknown;
@@ -196,6 +210,101 @@ export declare const FormRender: import('vue').DefineComponent<{
             errors: Record<string, import('@arco-design/web-vue').ValidatedError>;
         }, ev: Event) => any) | undefined;
     }, {
+        cls: import('vue').ComputedRef<(string | {
+            [x: string]: boolean;
+        })[]>;
+        formRef: import('vue').Ref<HTMLFormElement | undefined>;
+        handleSubmit: (e: Event) => void;
+        innerValidate: (callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined) => Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        innerValidateField: (field: string | string[], callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined) => Promise<Record<string, import('@arco-design/web-vue').ValidatedError> | undefined>;
+        innerResetFields: (field?: string | string[] | undefined) => void;
+        innerClearValidate: (field?: string | string[] | undefined) => void;
+        innerSetFields: (data: Record<string, import('@arco-design/web-vue/es/form/interface').FieldData>) => void;
+        innerScrollToField: (field: string, options?: import('scroll-into-view-if-needed').Options<any> | undefined) => void;
+    }, {}, {}, {
+        validate(callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined): Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        validateField(field: string | string[], callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined): Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        resetFields(field?: string | string[] | undefined): void;
+        clearValidate(field?: string | string[] | undefined): void;
+        setFields(data: Record<string, import('@arco-design/web-vue/es/form/interface').FieldData>): void;
+        scrollToField(field: string): void;
+    }, {
+        disabled: boolean;
+        layout: "inline" | "horizontal" | "vertical";
+        labelColProps: Record<string, any>;
+        wrapperColProps: Record<string, any>;
+        labelAlign: "left" | "right";
+        autoLabelWidth: boolean;
+        scrollToFirstError: boolean;
+    }> | undefined, import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        model?: unknown;
+        layout?: unknown;
+        size?: unknown;
+        labelColProps?: unknown;
+        wrapperColProps?: unknown;
+        labelColStyle?: unknown;
+        wrapperColStyle?: unknown;
+        labelAlign?: unknown;
+        disabled?: unknown;
+        rules?: unknown;
+        autoLabelWidth?: unknown;
+        id?: unknown;
+        scrollToFirstError?: unknown;
+    } & {
+        layout: "inline" | "horizontal" | "vertical";
+        model: Record<string, any>;
+        labelColProps: Record<string, any>;
+        wrapperColProps: Record<string, any>;
+        labelAlign: "left" | "right";
+        autoLabelWidth: boolean;
+        scrollToFirstError: boolean;
+    } & {
+        disabled?: boolean | undefined;
+        size?: "mini" | "medium" | "large" | "small" | undefined;
+        labelColStyle?: Record<string, any> | undefined;
+        wrapperColStyle?: Record<string, any> | undefined;
+        rules?: Record<string, FieldRule<any> | FieldRule<any>[]> | undefined;
+        id?: string | undefined;
+    }> & {
+        onSubmit?: ((data: {
+            values: Record<string, any>;
+            errors: Record<string, import('@arco-design/web-vue').ValidatedError> | undefined;
+        }, ev: Event) => any) | undefined;
+        onSubmitSuccess?: ((values: Record<string, any>, ev: Event) => any) | undefined;
+        onSubmitFailed?: ((data: {
+            values: Record<string, any>;
+            errors: Record<string, import('@arco-design/web-vue').ValidatedError>;
+        }, ev: Event) => any) | undefined;
+    }, {
+        cls: import('vue').ComputedRef<(string | {
+            [x: string]: boolean;
+        })[]>;
+        formRef: import('vue').Ref<HTMLFormElement | undefined>;
+        handleSubmit: (e: Event) => void;
+        innerValidate: (callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined) => Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        innerValidateField: (field: string | string[], callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined) => Promise<Record<string, import('@arco-design/web-vue').ValidatedError> | undefined>;
+        innerResetFields: (field?: string | string[] | undefined) => void;
+        innerClearValidate: (field?: string | string[] | undefined) => void;
+        innerSetFields: (data: Record<string, import('@arco-design/web-vue/es/form/interface').FieldData>) => void;
+        innerScrollToField: (field: string, options?: import('scroll-into-view-if-needed').Options<any> | undefined) => void;
+    }, unknown, {}, {
+        validate(callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined): Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        validateField(field: string | string[], callback?: ((errors: undefined | Record<string, import('@arco-design/web-vue').ValidatedError>) => void) | undefined): Promise<undefined | Record<string, import('@arco-design/web-vue').ValidatedError>>;
+        resetFields(field?: string | string[] | undefined): void;
+        clearValidate(field?: string | string[] | undefined): void;
+        setFields(data: Record<string, import('@arco-design/web-vue/es/form/interface').FieldData>): void;
+        scrollToField(field: string): void;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        submit: (data: {
+            values: Record<string, any>;
+            errors: Record<string, import('@arco-design/web-vue').ValidatedError> | undefined;
+        }, ev: Event) => true;
+        submitSuccess: (values: Record<string, any>, ev: Event) => true;
+        submitFailed: (data: {
+            values: Record<string, any>;
+            errors: Record<string, import('@arco-design/web-vue').ValidatedError>;
+        }, ev: Event) => true;
+    }, import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, {
         disabled: boolean;
         layout: "inline" | "horizontal" | "vertical";
         labelColProps: Record<string, any>;
@@ -203,7 +312,7 @@ export declare const FormRender: import('vue').DefineComponent<{
         labelAlign: "left" | "right";
         autoLabelWidth: boolean;
         scrollToFirstError: boolean;
-    }, true, {}, {}, {
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};
         D: {};
@@ -277,9 +386,9 @@ export declare const FormRender: import('vue').DefineComponent<{
         autoLabelWidth: boolean;
         scrollToFirstError: boolean;
     }> | undefined>;
-    formColumns: import('vue').Ref<number>;
+    formColumns: import('vue').Ref<number, number>;
     formRules: import('vue').ComputedRef<Record<string, FieldRule<any> | FieldRule<any>[]>>;
-    formCollspased: import('vue').Ref<boolean>;
+    formCollspased: import('vue').Ref<boolean, boolean>;
     formActiosSpan: import('vue').ComputedRef<number>;
     formItems: import('vue').ComputedRef<import('..').FormItemOptions<any>[]>;
     toggleFormCollapsed: () => boolean;
@@ -291,8 +400,8 @@ export declare const FormRender: import('vue').DefineComponent<{
     validate: () => Promise<Record<string, import('@arco-design/web-vue').ValidatedError> | undefined> | undefined;
     onSubmitSuccess: () => void;
     openCollapsedDialog: () => void;
-    modalInstance: import('vue').Ref<any>;
-}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("submit" | "cancel" | "update:model-value")[], "submit" | "cancel" | "update:model-value", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    modalInstance: import('vue').Ref<any, any>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("submit" | "cancel" | "update:model-value")[], "submit" | "cancel" | "update:model-value", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
     form: {
         type: PropType<FormItemsOptions<any>>;
         required: true;
@@ -374,11 +483,11 @@ export declare const FormRender: import('vue').DefineComponent<{
         required: false;
         default: number;
     };
-}>> & {
+}>> & Readonly<{
     onSubmit?: ((...args: any[]) => any) | undefined;
     onCancel?: ((...args: any[]) => any) | undefined;
     "onUpdate:model-value"?: ((...args: any[]) => any) | undefined;
-}, {
+}>, {
     footer: boolean;
     layout: "horizontal" | "vertical";
     minWidth: number;
@@ -390,5 +499,5 @@ export declare const FormRender: import('vue').DefineComponent<{
     resetable: boolean;
     rowGap: number;
     colGap: number;
-}, {}>;
+}, {}, {}, {}, "formSource" | "updateFormField" | "updateFormSource" | "reset" | "validate", import('vue').ComponentProvideOptions, true, {}, any>;
 export type FormRenderInstance = InstanceType<typeof FormRender>;

package/dist/cjs/hooks/use-form.d.ts

@@ -1,13 +1,12 @@
 import { ComponentPublicInstance, Ref } from 'vue';
 import { FormRenderInstance } from '../form-render';
-
 type FormRenderExpose = {
     -readonly [K in keyof Omit<FormRenderInstance, keyof ComponentPublicInstance>]: FormRenderInstance[K];
 };
 /**
  * 获取TableRender实例
- * @param key
- * @returns
+ * @param key ref标识
+ * @returns FormRender实例的只读响应式引用
  */
 export declare function useForm(key: string): Readonly<Ref<FormRenderExpose>>;
 export {};