@tmagic/form 1.0.0-beta.13 → 1.0.0-beta.14

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

@@ -0,0 +1,354 @@
+import type { LooseRequired } from '@vue/shared';
+import type { FormItemRule, FormItemProp, FormItemContext, FormValidateCallback, FormValidationResult } from 'element-plus';
+import type { BuildPropType, Arrayable, BuildPropReturn, PropWrapper } from 'element-plus/es/utils';
+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: PropType<"small" | "default" | "large">;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    labelPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    keyProp: {
+        type: StringConstructor;
+        default: string;
+    };
+    popperClass: {
+        type: StringConstructor;
+    };
+}, {
+    initialized: Ref<boolean>;
+    values: Ref<{
+        [x: string]: any;
+        [x: number]: any;
+    }>;
+    elForm: Ref<({
+        $: ComponentInternalInstance;
+        $data: {};
+        $props: Partial<{
+            size: BuildPropType<StringConstructor, "" | "small" | "default" | "large", unknown>;
+            disabled: boolean;
+            rules: Partial<Record<string, Arrayable<FormItemRule>>>;
+            labelWidth: BuildPropType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
+            labelSuffix: string;
+            showMessage: BuildPropType<BooleanConstructor, unknown, unknown>;
+            validateOnRuleChange: BuildPropType<BooleanConstructor, unknown, unknown>;
+            hideRequiredAsterisk: BuildPropType<BooleanConstructor, unknown, unknown>;
+            inline: boolean;
+            inlineMessage: boolean;
+            statusIcon: boolean;
+            scrollToError: boolean;
+        }> & Omit<Readonly<ExtractPropTypes<{
+            readonly model: ObjectConstructor;
+            readonly rules: BuildPropReturn<PropWrapper<Partial<Record<string, Arrayable<FormItemRule>>>>, unknown, unknown, unknown, unknown>;
+            readonly labelPosition: StringConstructor;
+            readonly labelWidth: BuildPropReturn<readonly [StringConstructor, NumberConstructor], "", unknown, unknown, unknown>;
+            readonly labelSuffix: BuildPropReturn<StringConstructor, "", unknown, unknown, unknown>;
+            readonly inline: BooleanConstructor;
+            readonly inlineMessage: BooleanConstructor;
+            readonly statusIcon: BooleanConstructor;
+            readonly showMessage: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly size: BuildPropReturn<StringConstructor, unknown, unknown, "" | "small" | "default" | "large", unknown>;
+            readonly disabled: BooleanConstructor;
+            readonly validateOnRuleChange: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly hideRequiredAsterisk: BuildPropReturn<BooleanConstructor, false, unknown, unknown, unknown>;
+            readonly scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
+        } & VNodeProps & AllowedComponentProps & ComponentCustomProps, "labelWidth" | "disabled" | "size" | "inline" | "rules" | "labelSuffix" | "inlineMessage" | "statusIcon" | "showMessage" | "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", prop: FormItemProp, isValid: boolean, message: string) => void;
+        $el: any;
+        $options: ComponentOptionsBase<Readonly<ExtractPropTypes<{
+            readonly model: ObjectConstructor;
+            readonly rules: BuildPropReturn<PropWrapper<Partial<Record<string, Arrayable<FormItemRule>>>>, unknown, unknown, unknown, unknown>;
+            readonly labelPosition: StringConstructor;
+            readonly labelWidth: BuildPropReturn<readonly [StringConstructor, NumberConstructor], "", unknown, unknown, unknown>;
+            readonly labelSuffix: BuildPropReturn<StringConstructor, "", unknown, unknown, unknown>;
+            readonly inline: BooleanConstructor;
+            readonly inlineMessage: BooleanConstructor;
+            readonly statusIcon: BooleanConstructor;
+            readonly showMessage: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly size: BuildPropReturn<StringConstructor, unknown, unknown, "" | "small" | "default" | "large", unknown>;
+            readonly disabled: BooleanConstructor;
+            readonly validateOnRuleChange: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly hideRequiredAsterisk: BuildPropReturn<BooleanConstructor, false, unknown, unknown, unknown>;
+            readonly scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
+        }, {
+            COMPONENT_NAME: string;
+            props: Readonly<LooseRequired<Readonly<ExtractPropTypes<{
+                readonly model: ObjectConstructor;
+                readonly rules: BuildPropReturn<PropWrapper<Partial<Record<string, Arrayable<FormItemRule>>>>, unknown, unknown, unknown, unknown>;
+                readonly labelPosition: StringConstructor;
+                readonly labelWidth: BuildPropReturn<readonly [StringConstructor, NumberConstructor], "", unknown, unknown, unknown>;
+                readonly labelSuffix: BuildPropReturn<StringConstructor, "", unknown, unknown, unknown>;
+                readonly inline: BooleanConstructor;
+                readonly inlineMessage: BooleanConstructor;
+                readonly statusIcon: BooleanConstructor;
+                readonly showMessage: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+                readonly size: BuildPropReturn<StringConstructor, unknown, unknown, "" | "small" | "default" | "large", unknown>;
+                readonly disabled: BooleanConstructor;
+                readonly validateOnRuleChange: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+                readonly hideRequiredAsterisk: BuildPropReturn<BooleanConstructor, false, unknown, unknown, unknown>;
+                readonly scrollToError: BooleanConstructor;
+            }>> & {
+                onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
+            }>>;
+            emit: (event: "validate", prop: FormItemProp, isValid: boolean, message: string) => void;
+            fields: FormItemContext[];
+            formSize: ComputedRef<"" | "small" | "default" | "large">;
+            ns: {
+                namespace: ComputedRef<string>;
+                b: (blockSuffix?: string | undefined) => string;
+                e: (element?: string | undefined) => string;
+                m: (modifier?: string | undefined) => string;
+                be: (blockSuffix?: string | undefined, element?: string | undefined) => string;
+                em: (element?: string | undefined, modifier?: string | undefined) => string;
+                bm: (blockSuffix?: string | undefined, modifier?: string | undefined) => string;
+                bem: (blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined) => string;
+                is: {
+                    (name: string, state: boolean | undefined): string;
+                    (name: string): string;
+                };
+            };
+            formClasses: ComputedRef<(string | {
+                [x: string]: string | boolean | undefined;
+            })[]>;
+            addField: (field: FormItemContext) => void;
+            removeField: (field: FormItemContext) => void;
+            resetFields: (props?: Arrayable<FormItemProp> | undefined) => void;
+            clearValidate: (props?: Arrayable<FormItemProp> | undefined) => void;
+            isValidatable: ComputedRef<boolean>;
+            obtainValidateFields: (props: Arrayable<FormItemProp>) => FormItemContext[];
+            validate: (callback?: FormValidateCallback | undefined) => FormValidationResult;
+            doValidateField: (props?: Arrayable<FormItemProp> | undefined) => Promise<boolean>;
+            validateField: (props?: Arrayable<FormItemProp> | undefined, callback?: FormValidateCallback | undefined) => FormValidationResult;
+            scrollToField: (prop: FormItemProp) => void;
+        }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+            validate: (prop: FormItemProp, isValid: boolean, message: string) => boolean;
+        }, string, {
+            size: BuildPropType<StringConstructor, "" | "small" | "default" | "large", unknown>;
+            disabled: boolean;
+            rules: Partial<Record<string, Arrayable<FormItemRule>>>;
+            labelWidth: BuildPropType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
+            labelSuffix: string;
+            showMessage: BuildPropType<BooleanConstructor, unknown, unknown>;
+            validateOnRuleChange: BuildPropType<BooleanConstructor, unknown, unknown>;
+            hideRequiredAsterisk: BuildPropType<BooleanConstructor, unknown, unknown>;
+            inline: boolean;
+            inlineMessage: boolean;
+            statusIcon: 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<{
+        readonly model: ObjectConstructor;
+        readonly rules: BuildPropReturn<PropWrapper<Partial<Record<string, Arrayable<FormItemRule>>>>, unknown, unknown, unknown, unknown>;
+        readonly labelPosition: StringConstructor;
+        readonly labelWidth: BuildPropReturn<readonly [StringConstructor, NumberConstructor], "", unknown, unknown, unknown>;
+        readonly labelSuffix: BuildPropReturn<StringConstructor, "", unknown, unknown, unknown>;
+        readonly inline: BooleanConstructor;
+        readonly inlineMessage: BooleanConstructor;
+        readonly statusIcon: BooleanConstructor;
+        readonly showMessage: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+        readonly size: BuildPropReturn<StringConstructor, unknown, unknown, "" | "small" | "default" | "large", unknown>;
+        readonly disabled: BooleanConstructor;
+        readonly validateOnRuleChange: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+        readonly hideRequiredAsterisk: BuildPropReturn<BooleanConstructor, false, unknown, unknown, unknown>;
+        readonly scrollToError: BooleanConstructor;
+    }>> & {
+        onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
+    } & ShallowUnwrapRef<{
+        COMPONENT_NAME: string;
+        props: Readonly<LooseRequired<Readonly<ExtractPropTypes<{
+            readonly model: ObjectConstructor;
+            readonly rules: BuildPropReturn<PropWrapper<Partial<Record<string, Arrayable<FormItemRule>>>>, unknown, unknown, unknown, unknown>;
+            readonly labelPosition: StringConstructor;
+            readonly labelWidth: BuildPropReturn<readonly [StringConstructor, NumberConstructor], "", unknown, unknown, unknown>;
+            readonly labelSuffix: BuildPropReturn<StringConstructor, "", unknown, unknown, unknown>;
+            readonly inline: BooleanConstructor;
+            readonly inlineMessage: BooleanConstructor;
+            readonly statusIcon: BooleanConstructor;
+            readonly showMessage: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly size: BuildPropReturn<StringConstructor, unknown, unknown, "" | "small" | "default" | "large", unknown>;
+            readonly disabled: BooleanConstructor;
+            readonly validateOnRuleChange: BuildPropReturn<BooleanConstructor, true, unknown, unknown, unknown>;
+            readonly hideRequiredAsterisk: BuildPropReturn<BooleanConstructor, false, unknown, unknown, unknown>;
+            readonly scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => any) | undefined;
+        }>>;
+        emit: (event: "validate", prop: FormItemProp, isValid: boolean, message: string) => void;
+        fields: FormItemContext[];
+        formSize: ComputedRef<"" | "small" | "default" | "large">;
+        ns: {
+            namespace: ComputedRef<string>;
+            b: (blockSuffix?: string | undefined) => string;
+            e: (element?: string | undefined) => string;
+            m: (modifier?: string | undefined) => string;
+            be: (blockSuffix?: string | undefined, element?: string | undefined) => string;
+            em: (element?: string | undefined, modifier?: string | undefined) => string;
+            bm: (blockSuffix?: string | undefined, modifier?: string | undefined) => string;
+            bem: (blockSuffix?: string | undefined, element?: string | undefined, modifier?: string | undefined) => string;
+            is: {
+                (name: string, state: boolean | undefined): string;
+                (name: string): string;
+            };
+        };
+        formClasses: ComputedRef<(string | {
+            [x: string]: string | boolean | undefined;
+        })[]>;
+        addField: (field: FormItemContext) => void;
+        removeField: (field: FormItemContext) => void;
+        resetFields: (props?: Arrayable<FormItemProp> | undefined) => void;
+        clearValidate: (props?: Arrayable<FormItemProp> | undefined) => void;
+        isValidatable: ComputedRef<boolean>;
+        obtainValidateFields: (props: Arrayable<FormItemProp>) => FormItemContext[];
+        validate: (callback?: FormValidateCallback | undefined) => FormValidationResult;
+        doValidateField: (props?: Arrayable<FormItemProp> | undefined) => Promise<boolean>;
+        validateField: (props?: Arrayable<FormItemProp> | undefined, callback?: FormValidateCallback | undefined) => FormValidationResult;
+        scrollToField: (prop: FormItemProp) => 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: PropType<"small" | "default" | "large">;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    labelPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+    keyProp: {
+        type: StringConstructor;
+        default: string;
+    };
+    popperClass: {
+        type: StringConstructor;
+    };
+}>> & {
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onField-input"?: ((...args: any[]) => any) | undefined;
+    "onField-change"?: ((...args: any[]) => any) | undefined;
+}, {
+    initValues: Record<string, any>;
+    parentValues: Record<string, any>;
+    config: FormConfig;
+    labelWidth: string;
+    disabled: boolean;
+    height: string;
+    stepActive: string | number;
+    inline: boolean;
+    labelPosition: string;
+    keyProp: string;
+}>;
+export default _default;