@tmagic/form 1.0.0-beta.6 → 1.0.0-rc.2

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

@@ -1,6 +1,6 @@
-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 { 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 {
@@ -42,7 +42,7 @@ declare const _default: DefineComponent<{
         default: () => number;
     };
     size: {
-        type: StringConstructor;
+        type: PropType<"small" | "default" | "large">;
     };
     inline: {
         type: BooleanConstructor;
@@ -56,6 +56,9 @@ declare const _default: DefineComponent<{
         type: StringConstructor;
         default: string;
     };
+    popperClass: {
+        type: StringConstructor;
+    };
 }, {
     initialized: Ref<boolean>;
     values: Ref<{
@@ -66,49 +69,36 @@ declare const _default: DefineComponent<{
         $: ComponentInternalInstance;
         $data: {};
         $props: Partial<{
+            size: BuildPropType<StringConstructor, "" | "small" | "default" | "large", unknown>;
             disabled: boolean;
-            inline: boolean;
-            labelWidth: string | number;
+            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;
-            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<"small" | "default" | "large">;
-            disabled: BooleanConstructor;
-            validateOnRuleChange: {
-                type: BooleanConstructor;
-                default: boolean;
-            };
-            hideRequiredAsterisk: {
-                type: BooleanConstructor;
-                default: boolean;
-            };
-            scrollToError: BooleanConstructor;
+            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?: ((...args: any[]) => any) | undefined;
-        } & VNodeProps & AllowedComponentProps & ComponentCustomProps, "labelWidth" | "disabled" | "inline" | "labelSuffix" | "inlineMessage" | "statusIcon" | "showMessage" | "validateOnRuleChange" | "hideRequiredAsterisk" | "scrollToError">;
+            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;
         };
@@ -120,57 +110,93 @@ declare const _default: DefineComponent<{
         }>;
         $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;
+        $emit: (event: "validate", prop: FormItemProp, isValid: boolean, message: string) => 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<"small" | "default" | "large">;
-            disabled: BooleanConstructor;
-            validateOnRuleChange: {
-                type: BooleanConstructor;
-                default: boolean;
-            };
-            hideRequiredAsterisk: {
-                type: BooleanConstructor;
-                default: boolean;
-            };
-            scrollToError: BooleanConstructor;
+            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?: ((...args: any[]) => any) | undefined;
+            onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => 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, {
+            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;
+                };
+                cssVar: (object: Record<string, string>) => Record<string, string>;
+                cssVarName: (name: string) => string;
+                cssVarBlock: (object: Record<string, string>) => Record<string, string>;
+                cssVarBlockName: (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;
-            inline: boolean;
-            labelWidth: string | number;
+            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;
-            showMessage: boolean;
-            validateOnRuleChange: boolean;
-            hideRequiredAsterisk: boolean;
             scrollToError: boolean;
         }> & {
             beforeCreate?: ((() => void) | (() => void)[]) | undefined;
@@ -193,44 +219,76 @@ declare const _default: DefineComponent<{
         $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<"small" | "default" | "large">;
-        disabled: BooleanConstructor;
-        validateOnRuleChange: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        hideRequiredAsterisk: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        scrollToError: BooleanConstructor;
+        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?: ((...args: any[]) => any) | undefined;
+        onValidate?: ((prop: FormItemProp, isValid: boolean, message: string) => 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;
+        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;
+            };
+            cssVar: (object: Record<string, string>) => Record<string, string>;
+            cssVarName: (name: string) => string;
+            cssVarBlock: (object: Record<string, string>) => Record<string, string>;
+            cssVarBlockName: (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;
@@ -268,7 +326,7 @@ declare const _default: DefineComponent<{
         default: () => number;
     };
     size: {
-        type: StringConstructor;
+        type: PropType<"small" | "default" | "large">;
     };
     inline: {
         type: BooleanConstructor;
@@ -282,6 +340,9 @@ declare const _default: DefineComponent<{
         type: StringConstructor;
         default: string;
     };
+    popperClass: {
+        type: StringConstructor;
+    };
 }>> & {
     onChange?: ((...args: any[]) => any) | undefined;
     "onField-input"?: ((...args: any[]) => any) | undefined;