@tmagic/form 1.0.0-beta.1

package/dist/types/src/Form.vue.d.ts

@@ -0,0 +1,304 @@
+import type { ValidateFieldCallback } from 'element-plus';
+import type { Callback } from 'element-plus/es/components/form/src/form.vue';
+import type { FormItemRule } from 'element-plus/es/components/form/src/form.type';
+import type { DefineComponent, Ref, ComponentInternalInstance, ExtractPropTypes, VNodeProps, AllowedComponentProps, ComponentCustomProps, Slot, ComponentPublicInstance, ComponentOptionsBase, ComputedRef, ComponentOptionsMixin, DebuggerEvent, nextTick, WatchOptions, WatchStopHandle, ShallowUnwrapRef, ComponentCustomProperties, PropType } from 'vue';
+import { FormConfig, FormState } from './schema';
+export interface ValidateError {
+    message: string;
+    field: string;
+}
+export interface FieldErrorList {
+    [field: string]: ValidateError[];
+}
+declare const _default: DefineComponent<{
+    initValues: {
+        type: ObjectConstructor;
+        required: true;
+        default: () => {};
+    };
+    parentValues: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    config: {
+        type: PropType<FormConfig>;
+        required: true;
+        default: () => never[];
+    };
+    labelWidth: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: () => boolean;
+    };
+    height: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    stepActive: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: () => number;
+    };
+    size: {
+        type: StringConstructor;
+        default: string;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    labelPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    keyProp: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {
+    initialized: Ref<boolean>;
+    values: Ref<{
+        [x: string]: any;
+        [x: number]: any;
+    }>;
+    elForm: Ref<({
+        $: ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{
+            disabled: boolean;
+            inline: boolean;
+            labelWidth: string | number;
+            labelSuffix: string;
+            inlineMessage: boolean;
+            statusIcon: boolean;
+            showMessage: boolean;
+            validateOnRuleChange: boolean;
+            hideRequiredAsterisk: boolean;
+            scrollToError: boolean;
+        }> & Omit<Readonly<ExtractPropTypes<{
+            model: ObjectConstructor;
+            rules: PropType<Partial<Record<string, FormItemRule | FormItemRule[]>>>;
+            labelPosition: StringConstructor;
+            labelWidth: {
+                type: (StringConstructor | NumberConstructor)[];
+                default: string;
+            };
+            labelSuffix: {
+                type: StringConstructor;
+                default: string;
+            };
+            inline: BooleanConstructor;
+            inlineMessage: BooleanConstructor;
+            statusIcon: BooleanConstructor;
+            showMessage: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            size: PropType<"default" | "small" | "large">;
+            disabled: BooleanConstructor;
+            validateOnRuleChange: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            hideRequiredAsterisk: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: ((...args: any[]) => any) | undefined;
+        } & VNodeProps & AllowedComponentProps & ComponentCustomProps, "labelWidth" | "labelSuffix" | "inline" | "inlineMessage" | "statusIcon" | "showMessage" | "disabled" | "validateOnRuleChange" | "hideRequiredAsterisk" | "scrollToError">;
+        $attrs: {
+            [x: string]: unknown;
+        };
+        $refs: {
+            [x: string]: unknown;
+        };
+        $slots: Readonly<{
+            [name: string]: Slot | undefined;
+        }>;
+        $root: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
+        $parent: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null;
+        $emit: (event: "validate", ...args: any[]) => void;
+        $el: any;
+        $options: ComponentOptionsBase<Readonly<ExtractPropTypes<{
+            model: ObjectConstructor;
+            rules: PropType<Partial<Record<string, FormItemRule | FormItemRule[]>>>;
+            labelPosition: StringConstructor;
+            labelWidth: {
+                type: (StringConstructor | NumberConstructor)[];
+                default: string;
+            };
+            labelSuffix: {
+                type: StringConstructor;
+                default: string;
+            };
+            inline: BooleanConstructor;
+            inlineMessage: BooleanConstructor;
+            statusIcon: BooleanConstructor;
+            showMessage: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            size: PropType<"default" | "small" | "large">;
+            disabled: BooleanConstructor;
+            validateOnRuleChange: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            hideRequiredAsterisk: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+            scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: ((...args: any[]) => any) | undefined;
+        }, {
+            formKls: ComputedRef<string[]>;
+            validate: (callback?: Callback | undefined) => Promise<boolean> | undefined;
+            resetFields: () => void;
+            clearValidate: (props?: string | string[] | undefined) => void;
+            validateField: (props: string | string[], cb: ValidateFieldCallback) => void;
+            scrollToField: (prop: string) => void;
+        }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, "validate"[], string, {
+            disabled: boolean;
+            inline: boolean;
+            labelWidth: string | number;
+            labelSuffix: string;
+            inlineMessage: boolean;
+            statusIcon: boolean;
+            showMessage: boolean;
+            validateOnRuleChange: boolean;
+            hideRequiredAsterisk: boolean;
+            scrollToError: boolean;
+        }> & {
+            beforeCreate?: ((() => void) | (() => void)[]) | undefined;
+            created?: ((() => void) | (() => void)[]) | undefined;
+            beforeMount?: ((() => void) | (() => void)[]) | undefined;
+            mounted?: ((() => void) | (() => void)[]) | undefined;
+            beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
+            updated?: ((() => void) | (() => void)[]) | undefined;
+            activated?: ((() => void) | (() => void)[]) | undefined;
+            deactivated?: ((() => void) | (() => void)[]) | undefined;
+            beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
+            beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
+            destroyed?: ((() => void) | (() => void)[]) | undefined;
+            unmounted?: ((() => void) | (() => void)[]) | undefined;
+            renderTracked?: (((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[]) | undefined;
+            renderTriggered?: (((e: DebuggerEvent) => void) | ((e: DebuggerEvent) => void)[]) | undefined;
+            errorCaptured?: (((err: unknown, instance: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>> | null, info: string) => boolean | void)[]) | undefined;
+        };
+        $forceUpdate: () => void;
+        $nextTick: typeof nextTick;
+        $watch(source: string | Function, cb: Function, options?: WatchOptions<boolean> | undefined): WatchStopHandle;
+    } & Readonly<ExtractPropTypes<{
+        model: ObjectConstructor;
+        rules: PropType<Partial<Record<string, FormItemRule | FormItemRule[]>>>;
+        labelPosition: StringConstructor;
+        labelWidth: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: string;
+        };
+        labelSuffix: {
+            type: StringConstructor;
+            default: string;
+        };
+        inline: BooleanConstructor;
+        inlineMessage: BooleanConstructor;
+        statusIcon: BooleanConstructor;
+        showMessage: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        size: PropType<"default" | "small" | "large">;
+        disabled: BooleanConstructor;
+        validateOnRuleChange: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        hideRequiredAsterisk: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        scrollToError: BooleanConstructor;
+    }>> & {
+        onValidate?: ((...args: any[]) => any) | undefined;
+    } & ShallowUnwrapRef<{
+        formKls: ComputedRef<string[]>;
+        validate: (callback?: Callback | undefined) => Promise<boolean> | undefined;
+        resetFields: () => void;
+        clearValidate: (props?: string | string[] | undefined) => void;
+        validateField: (props: string | string[], cb: ValidateFieldCallback) => void;
+        scrollToField: (prop: string) => void;
+    }> & {} & {} & ComponentCustomProperties) | undefined>;
+    formState: FormState;
+    changeHandler: () => void;
+    resetForm: () => void | undefined;
+    submitForm: (native?: boolean | undefined) => Promise<any>;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, ("change" | "field-input" | "field-change")[], "change" | "field-input" | "field-change", VNodeProps & AllowedComponentProps & ComponentCustomProps, Readonly<ExtractPropTypes<{
+    initValues: {
+        type: ObjectConstructor;
+        required: true;
+        default: () => {};
+    };
+    parentValues: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    config: {
+        type: PropType<FormConfig>;
+        required: true;
+        default: () => never[];
+    };
+    labelWidth: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: () => boolean;
+    };
+    height: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    stepActive: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: () => number;
+    };
+    size: {
+        type: StringConstructor;
+        default: string;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    labelPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    keyProp: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & {
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onField-input"?: ((...args: any[]) => any) | undefined;
+    "onField-change"?: ((...args: any[]) => any) | undefined;
+}, {
+    labelPosition: string;
+    labelWidth: string;
+    inline: boolean;
+    size: string;
+    disabled: boolean;
+    config: FormConfig;
+    stepActive: string | number;
+    initValues: Record<string, any>;
+    parentValues: Record<string, any>;
+    height: string;
+    keyProp: string;
+}>;
+export default _default;