@wetspace/pro-components/dist/pro-table/src/hooks/use-form.d.ts

::: tip 基本介绍

import { WetProTablePropsType, WetProTableColumns } from '../types';
import { Ref } from 'vue';
import { WetSchemaItemType } from '../../../pro-form';

declare const _default: (props: WetProTablePropsType, columns: Ref<WetProTableColumns[]>) => {
    formState: Ref<{}, {}>;
    formPorps: import('vue').ComputedRef<false | {
        span: number;
        labelWidth: number;
        collapsed: boolean;
        collapseShowNum: number;
    }>;
    formIns: import('vue').ShallowRef<{
        $: import('vue').ComponentInternalInstance;
        $data: {};
        $props: Partial<{
            disabled: boolean;
            span: number;
            gutter: number;
            valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            isFormItem: boolean;
            notInitClearValidate: boolean;
        }> & Omit<{
            readonly disabled: boolean;
            readonly span: number;
            readonly gutter: number;
            readonly valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            readonly labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            readonly isFormItem: boolean;
            readonly notInitClearValidate: boolean;
            readonly colProps?: Partial<import('element-plus').ColProps>;
            readonly clearable?: import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>;
            readonly initialValues?: Record<string, any>;
            readonly modelValue?: Record<string, any>;
            readonly prop?: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>;
            readonly labelPosition?: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>;
            readonly onChange?: (key: string | string[], value: any) => any;
            readonly "onUpdate:modelValue"?: (value: any) => any;
        } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, "disabled" | "span" | "gutter" | "valueEmptyModel" | "labelWidth" | "isFormItem" | "notInitClearValidate">;
        $attrs: {
            [x: string]: unknown;
        };
        $refs: {
            [x: string]: unknown;
        };
        $slots: Readonly<{
            [name: string]: import('vue').Slot<any>;
        }>;
        $root: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>;
        $parent: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>;
        $host: Element;
        $emit: ((event: "change", key: string | string[], value: any) => void) & ((event: "update:modelValue", value: any) => void);
        $el: any;
        $options: import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
            colProps: {
                readonly type: import('vue').PropType<Partial<import('element-plus').ColProps>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            span: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            gutter: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            clearable: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            disabled: BooleanConstructor;
            initialValues: {
                readonly type: import('vue').PropType<Record<string, any>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            valueEmptyModel: import('element-plus/es/utils').EpPropFinalized<import('vue').PropType<"filter" | "null">, unknown, unknown, string, boolean>;
            labelWidth: import('element-plus/es/utils').EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
            isFormItem: BooleanConstructor;
            modelValue: ObjectConstructor;
            prop: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            notInitClearValidate: BooleanConstructor;
            labelPosition: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
        }>> & Readonly<{
            onChange?: (key: string | string[], value: any) => any;
            "onUpdate:modelValue"?: (value: any) => any;
        }>, {
            submit: () => Promise<any>;
            reset: (isClear?: boolean) => any;
            clear: () => any;
            validateField: (prop?: string | string[]) => void;
            clearValidate: (prop?: string | string[]) => void;
            getFieldsValue: (prop?: string | string[]) => any;
            setFieldsValue: (prop: string | string[], v: any) => void;
            scrollToField: (prop: string | string[]) => void;
            setValue: (value: any) => void;
        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
            change: (key: string | string[], value: any) => void;
            "update:modelValue": (value: any) => void;
        }, string, {
            disabled: boolean;
            span: number;
            gutter: number;
            valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            isFormItem: boolean;
            notInitClearValidate: boolean;
        }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & {
            beforeCreate?: (() => void) | (() => void)[];
            created?: (() => void) | (() => void)[];
            beforeMount?: (() => void) | (() => void)[];
            mounted?: (() => void) | (() => void)[];
            beforeUpdate?: (() => void) | (() => void)[];
            updated?: (() => void) | (() => void)[];
            activated?: (() => void) | (() => void)[];
            deactivated?: (() => void) | (() => void)[];
            beforeDestroy?: (() => void) | (() => void)[];
            beforeUnmount?: (() => void) | (() => void)[];
            destroyed?: (() => void) | (() => void)[];
            unmounted?: (() => void) | (() => void)[];
            renderTracked?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
            renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
            errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>, info: string) => boolean | void)[];
        };
        $forceUpdate: () => void;
        $nextTick: typeof import('vue').nextTick;
        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R, args_2: import('@vue/reactivity').OnCleanup) => any : (args_0: any, args_1: any, args_2: import('@vue/reactivity').OnCleanup) => any, options?: import('vue').WatchOptions<boolean>): import('vue').WatchStopHandle;
    } & Readonly<{
        disabled: boolean;
        span: number;
        gutter: number;
        valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
        labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
        isFormItem: boolean;
        notInitClearValidate: boolean;
    }> & Omit<Readonly<import('vue').ExtractPropTypes<{
        colProps: {
            readonly type: import('vue').PropType<Partial<import('element-plus').ColProps>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        span: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        gutter: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        clearable: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        disabled: BooleanConstructor;
        initialValues: {
            readonly type: import('vue').PropType<Record<string, any>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        valueEmptyModel: import('element-plus/es/utils').EpPropFinalized<import('vue').PropType<"filter" | "null">, unknown, unknown, string, boolean>;
        labelWidth: import('element-plus/es/utils').EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
        isFormItem: BooleanConstructor;
        modelValue: ObjectConstructor;
        prop: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        notInitClearValidate: BooleanConstructor;
        labelPosition: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
    }>> & Readonly<{
        onChange?: (key: string | string[], value: any) => any;
        "onUpdate:modelValue"?: (value: any) => any;
    }>, "reset" | "submit" | "clear" | "setFieldsValue" | "clearValidate" | "validateField" | "scrollToField" | "getFieldsValue" | "setValue" | ("disabled" | "span" | "gutter" | "valueEmptyModel" | "labelWidth" | "isFormItem" | "notInitClearValidate")> & import('vue').ShallowUnwrapRef<{
        submit: () => Promise<any>;
        reset: (isClear?: boolean) => any;
        clear: () => any;
        validateField: (prop?: string | string[]) => void;
        clearValidate: (prop?: string | string[]) => void;
        getFieldsValue: (prop?: string | string[]) => any;
        setFieldsValue: (prop: string | string[], v: any) => void;
        scrollToField: (prop: string | string[]) => void;
        setValue: (value: any) => void;
    }> & {} & import('vue').ComponentCustomProperties & {} & {
        $slots: {
            default?(_: {}): any;
            actions?(_: {
                submit: () => Promise<any>;
                reset: (isClear?: boolean) => any;
                clear: () => any;
            }): any;
        };
    }, {
        $: import('vue').ComponentInternalInstance;
        $data: {};
        $props: Partial<{
            disabled: boolean;
            span: number;
            gutter: number;
            valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            isFormItem: boolean;
            notInitClearValidate: boolean;
        }> & Omit<{
            readonly disabled: boolean;
            readonly span: number;
            readonly gutter: number;
            readonly valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            readonly labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            readonly isFormItem: boolean;
            readonly notInitClearValidate: boolean;
            readonly colProps?: Partial<import('element-plus').ColProps>;
            readonly clearable?: import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>;
            readonly initialValues?: Record<string, any>;
            readonly modelValue?: Record<string, any>;
            readonly prop?: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>;
            readonly labelPosition?: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>;
            readonly onChange?: (key: string | string[], value: any) => any;
            readonly "onUpdate:modelValue"?: (value: any) => any;
        } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, "disabled" | "span" | "gutter" | "valueEmptyModel" | "labelWidth" | "isFormItem" | "notInitClearValidate">;
        $attrs: {
            [x: string]: unknown;
        };
        $refs: {
            [x: string]: unknown;
        };
        $slots: Readonly<{
            [name: string]: import('vue').Slot<any>;
        }>;
        $root: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>;
        $parent: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>;
        $host: Element;
        $emit: ((event: "change", key: string | string[], value: any) => void) & ((event: "update:modelValue", value: any) => void);
        $el: any;
        $options: import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
            colProps: {
                readonly type: import('vue').PropType<Partial<import('element-plus').ColProps>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            span: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            gutter: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
            clearable: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            disabled: BooleanConstructor;
            initialValues: {
                readonly type: import('vue').PropType<Record<string, any>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            valueEmptyModel: import('element-plus/es/utils').EpPropFinalized<import('vue').PropType<"filter" | "null">, unknown, unknown, string, boolean>;
            labelWidth: import('element-plus/es/utils').EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
            isFormItem: BooleanConstructor;
            modelValue: ObjectConstructor;
            prop: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
            notInitClearValidate: BooleanConstructor;
            labelPosition: {
                readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>>;
                readonly required: false;
                readonly validator: (val: unknown) => boolean;
                __epPropKey: true;
            };
        }>> & Readonly<{
            onChange?: (key: string | string[], value: any) => any;
            "onUpdate:modelValue"?: (value: any) => any;
        }>, {
            submit: () => Promise<any>;
            reset: (isClear?: boolean) => any;
            clear: () => any;
            validateField: (prop?: string | string[]) => void;
            clearValidate: (prop?: string | string[]) => void;
            getFieldsValue: (prop?: string | string[]) => any;
            setFieldsValue: (prop: string | string[], v: any) => void;
            scrollToField: (prop: string | string[]) => void;
            setValue: (value: any) => void;
        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
            change: (key: string | string[], value: any) => void;
            "update:modelValue": (value: any) => void;
        }, string, {
            disabled: boolean;
            span: number;
            gutter: number;
            valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
            labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
            isFormItem: boolean;
            notInitClearValidate: boolean;
        }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & {
            beforeCreate?: (() => void) | (() => void)[];
            created?: (() => void) | (() => void)[];
            beforeMount?: (() => void) | (() => void)[];
            mounted?: (() => void) | (() => void)[];
            beforeUpdate?: (() => void) | (() => void)[];
            updated?: (() => void) | (() => void)[];
            activated?: (() => void) | (() => void)[];
            deactivated?: (() => void) | (() => void)[];
            beforeDestroy?: (() => void) | (() => void)[];
            beforeUnmount?: (() => void) | (() => void)[];
            destroyed?: (() => void) | (() => void)[];
            unmounted?: (() => void) | (() => void)[];
            renderTracked?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
            renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
            errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any>, info: string) => boolean | void)[];
        };
        $forceUpdate: () => void;
        $nextTick: typeof import('vue').nextTick;
        $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R, args_2: import('@vue/reactivity').OnCleanup) => any : (args_0: any, args_1: any, args_2: import('@vue/reactivity').OnCleanup) => any, options?: import('vue').WatchOptions<boolean>): import('vue').WatchStopHandle;
    } & Readonly<{
        disabled: boolean;
        span: number;
        gutter: number;
        valueEmptyModel: import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"filter" | "null">, unknown, unknown>;
        labelWidth: import('element-plus/es/utils').EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
        isFormItem: boolean;
        notInitClearValidate: boolean;
    }> & Omit<Readonly<import('vue').ExtractPropTypes<{
        colProps: {
            readonly type: import('vue').PropType<Partial<import('element-plus').ColProps>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        span: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        gutter: import('element-plus/es/utils').EpPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
        clearable: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<BooleanConstructor, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        disabled: BooleanConstructor;
        initialValues: {
            readonly type: import('vue').PropType<Record<string, any>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        valueEmptyModel: import('element-plus/es/utils').EpPropFinalized<import('vue').PropType<"filter" | "null">, unknown, unknown, string, boolean>;
        labelWidth: import('element-plus/es/utils').EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
        isFormItem: BooleanConstructor;
        modelValue: ObjectConstructor;
        prop: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<string | string[]>, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
        notInitClearValidate: BooleanConstructor;
        labelPosition: {
            readonly type: import('vue').PropType<import('element-plus/es/utils').EpPropMergeType<import('vue').PropType<"" | "top" | "right" | "left">, unknown, unknown>>;
            readonly required: false;
            readonly validator: (val: unknown) => boolean;
            __epPropKey: true;
        };
    }>> & Readonly<{
        onChange?: (key: string | string[], value: any) => any;
        "onUpdate:modelValue"?: (value: any) => any;
    }>, "reset" | "submit" | "clear" | "setFieldsValue" | "clearValidate" | "validateField" | "scrollToField" | "getFieldsValue" | "setValue" | ("disabled" | "span" | "gutter" | "valueEmptyModel" | "labelWidth" | "isFormItem" | "notInitClearValidate")> & import('vue').ShallowUnwrapRef<{
        submit: () => Promise<any>;
        reset: (isClear?: boolean) => any;
        clear: () => any;
        validateField: (prop?: string | string[]) => void;
        clearValidate: (prop?: string | string[]) => void;
        getFieldsValue: (prop?: string | string[]) => any;
        setFieldsValue: (prop: string | string[], v: any) => void;
        scrollToField: (prop: string | string[]) => void;
        setValue: (value: any) => void;
    }> & {} & import('vue').ComponentCustomProperties & {} & {
        $slots: {
            default?(_: {}): any;
            actions?(_: {
                submit: () => Promise<any>;
                reset: (isClear?: boolean) => any;
                clear: () => any;
            }): any;
        };
    }>;
    getSearchValue: () => Promise<void>;
    resetForm: () => void;
    properties: import('vue').ComputedRef<WetSchemaItemType[]>;
    collapsed: import('vue').ShallowRef<boolean, boolean>;
};
export default _default;