@vunk/form 0.0.0-alpha.8 → 0.0.0-alpha.9

package/packages/components/form/src/ctx.d.ts

@@ -0,0 +1,318 @@
+import { PropType } from 'vue';
+import { SetDataEvent } from '@vunk/form/shared/types';
+export declare const props: {
+    data: {
+        type: PropType<Record<string, any>>;
+        default: () => {};
+    };
+    formItems: {
+        type: PropType<any[]>;
+        default: () => any[];
+    };
+    elRef: {
+        type: PropType<(arg: {
+            $: import("vue").ComponentInternalInstance;
+            $data: {};
+            $props: Partial<{
+                readonly disabled: boolean;
+                readonly labelPosition: import("element-plus/es/utils").EpPropMergeType<StringConstructor, "left" | "right" | "top", unknown>;
+                readonly labelWidth: import("element-plus/es/utils").EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
+                readonly labelSuffix: string;
+                readonly showMessage: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly validateOnRuleChange: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly inline: boolean;
+                readonly inlineMessage: boolean;
+                readonly statusIcon: boolean;
+                readonly scrollToError: boolean;
+            }> & Omit<Readonly<import("vue").ExtractPropTypes<{
+                readonly model: ObjectConstructor;
+                readonly rules: {
+                    readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+                readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+                readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+                readonly inline: BooleanConstructor;
+                readonly inlineMessage: BooleanConstructor;
+                readonly statusIcon: BooleanConstructor;
+                readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly size: {
+                    readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly disabled: BooleanConstructor;
+                readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+                readonly scrollToError: BooleanConstructor;
+            }>> & {
+                onValidate?: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => any;
+            } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "labelPosition" | "labelWidth" | "labelSuffix" | "inline" | "inlineMessage" | "statusIcon" | "showMessage" | "disabled" | "validateOnRuleChange" | "hideRequiredAsterisk" | "scrollToError">;
+            $attrs: {
+                [x: string]: unknown;
+            };
+            $refs: {
+                [x: string]: unknown;
+            };
+            $slots: Readonly<{
+                [name: string]: import("vue").Slot;
+            }>;
+            $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
+            $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>;
+            $emit: (event: "validate", prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => void;
+            $el: any;
+            $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
+                readonly model: ObjectConstructor;
+                readonly rules: {
+                    readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+                readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+                readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+                readonly inline: BooleanConstructor;
+                readonly inlineMessage: BooleanConstructor;
+                readonly statusIcon: BooleanConstructor;
+                readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly size: {
+                    readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly disabled: BooleanConstructor;
+                readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+                readonly scrollToError: BooleanConstructor;
+            }>> & {
+                onValidate?: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => any;
+            }, {
+                COMPONENT_NAME: string;
+                props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
+                    readonly model: ObjectConstructor;
+                    readonly rules: {
+                        readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+                        readonly required: false;
+                        readonly validator: (val: unknown) => boolean;
+                        __epPropKey: true;
+                    };
+                    readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+                    readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+                    readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+                    readonly inline: BooleanConstructor;
+                    readonly inlineMessage: BooleanConstructor;
+                    readonly statusIcon: BooleanConstructor;
+                    readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                    readonly size: {
+                        readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+                        readonly required: false;
+                        readonly validator: (val: unknown) => boolean;
+                        __epPropKey: true;
+                    };
+                    readonly disabled: BooleanConstructor;
+                    readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                    readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+                    readonly scrollToError: BooleanConstructor;
+                }>> & {
+                    onValidate?: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => any;
+                }>>;
+                emit: (event: "validate", prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => void;
+                fields: import("element-plus").FormItemContext[];
+                formSize: import("vue").ComputedRef<"" | "small" | "default" | "large">;
+                ns: {
+                    namespace: import("vue").ComputedRef<string>;
+                    b: (blockSuffix?: string) => string;
+                    e: (element?: string) => string;
+                    m: (modifier?: string) => string;
+                    be: (blockSuffix?: string, element?: string) => string;
+                    em: (element?: string, modifier?: string) => string;
+                    bm: (blockSuffix?: string, modifier?: string) => string;
+                    bem: (blockSuffix?: string, element?: string, modifier?: string) => string;
+                    is: {
+                        (name: string, state: boolean): 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: import("vue").ComputedRef<(string | {
+                    [x: string]: boolean | import("element-plus/es/utils").EpPropMergeType<StringConstructor, "left" | "right" | "top", unknown>;
+                })[]>;
+                addField: (field: import("element-plus").FormItemContext) => void;
+                removeField: (field: import("element-plus").FormItemContext) => void;
+                resetFields: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => void;
+                clearValidate: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => void;
+                isValidatable: import("vue").ComputedRef<boolean>;
+                obtainValidateFields: (props: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => import("element-plus").FormItemContext[];
+                validate: (callback?: import("element-plus").FormValidateCallback) => import("element-plus").FormValidationResult;
+                doValidateField: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => Promise<boolean>;
+                validateField: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>, callback?: import("element-plus").FormValidateCallback) => import("element-plus").FormValidationResult;
+                scrollToField: (prop: import("element-plus").FormItemProp) => void;
+            }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+                validate: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => boolean;
+            }, string, {
+                readonly disabled: boolean;
+                readonly labelPosition: import("element-plus/es/utils").EpPropMergeType<StringConstructor, "left" | "right" | "top", unknown>;
+                readonly labelWidth: import("element-plus/es/utils").EpPropMergeType<readonly [StringConstructor, NumberConstructor], unknown, unknown>;
+                readonly labelSuffix: string;
+                readonly showMessage: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly validateOnRuleChange: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropMergeType<BooleanConstructor, unknown, unknown>;
+                readonly inline: boolean;
+                readonly inlineMessage: boolean;
+                readonly statusIcon: boolean;
+                readonly scrollToError: boolean;
+            }> & {
+                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, {}>>, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}>>, info: string) => boolean | void)[];
+            };
+            $forceUpdate: () => void;
+            $nextTick: typeof import("vue").nextTick;
+            $watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions<boolean>): import("vue").WatchStopHandle;
+        } & Readonly<import("vue").ExtractPropTypes<{
+            readonly model: ObjectConstructor;
+            readonly rules: {
+                readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+                readonly required: false;
+                readonly validator: (val: unknown) => boolean;
+                __epPropKey: true;
+            };
+            readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+            readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+            readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+            readonly inline: BooleanConstructor;
+            readonly inlineMessage: BooleanConstructor;
+            readonly statusIcon: BooleanConstructor;
+            readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly size: {
+                readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+                readonly required: false;
+                readonly validator: (val: unknown) => boolean;
+                __epPropKey: true;
+            };
+            readonly disabled: BooleanConstructor;
+            readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+            readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+            readonly scrollToError: BooleanConstructor;
+        }>> & {
+            onValidate?: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => any;
+        } & import("vue").ShallowUnwrapRef<{
+            COMPONENT_NAME: string;
+            props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
+                readonly model: ObjectConstructor;
+                readonly rules: {
+                    readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+                readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+                readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+                readonly inline: BooleanConstructor;
+                readonly inlineMessage: BooleanConstructor;
+                readonly statusIcon: BooleanConstructor;
+                readonly showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly size: {
+                    readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+                    readonly required: false;
+                    readonly validator: (val: unknown) => boolean;
+                    __epPropKey: true;
+                };
+                readonly disabled: BooleanConstructor;
+                readonly validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+                readonly hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+                readonly scrollToError: BooleanConstructor;
+            }>> & {
+                onValidate?: (prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => any;
+            }>>;
+            emit: (event: "validate", prop: import("element-plus").FormItemProp, isValid: boolean, message: string) => void;
+            fields: import("element-plus").FormItemContext[];
+            formSize: import("vue").ComputedRef<"" | "small" | "default" | "large">;
+            ns: {
+                namespace: import("vue").ComputedRef<string>;
+                b: (blockSuffix?: string) => string;
+                e: (element?: string) => string;
+                m: (modifier?: string) => string;
+                be: (blockSuffix?: string, element?: string) => string;
+                em: (element?: string, modifier?: string) => string;
+                bm: (blockSuffix?: string, modifier?: string) => string;
+                bem: (blockSuffix?: string, element?: string, modifier?: string) => string;
+                is: {
+                    (name: string, state: boolean): 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: import("vue").ComputedRef<(string | {
+                [x: string]: boolean | import("element-plus/es/utils").EpPropMergeType<StringConstructor, "left" | "right" | "top", unknown>;
+            })[]>;
+            addField: (field: import("element-plus").FormItemContext) => void;
+            removeField: (field: import("element-plus").FormItemContext) => void;
+            resetFields: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => void;
+            clearValidate: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => void;
+            isValidatable: import("vue").ComputedRef<boolean>;
+            obtainValidateFields: (props: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => import("element-plus").FormItemContext[];
+            validate: (callback?: import("element-plus").FormValidateCallback) => import("element-plus").FormValidationResult;
+            doValidateField: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>) => Promise<boolean>;
+            validateField: (props?: import("element-plus/es/utils").Arrayable<import("element-plus").FormItemProp>, callback?: import("element-plus").FormValidateCallback) => import("element-plus").FormValidationResult;
+            scrollToField: (prop: import("element-plus").FormItemProp) => void;
+        }> & {} & {} & import("vue").ComponentCustomProperties) => any>;
+        default: () => () => void;
+    };
+    model: ObjectConstructor;
+    rules: {
+        readonly type: PropType<Partial<Record<string, import("element-plus/es/utils").Arrayable<import("element-plus").FormItemRule>>>>;
+        readonly required: false;
+        readonly validator: (val: unknown) => boolean;
+        __epPropKey: true;
+    };
+    labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right" | "top", unknown, "right", boolean>;
+    labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+    labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
+    inline: BooleanConstructor;
+    inlineMessage: BooleanConstructor;
+    statusIcon: BooleanConstructor;
+    showMessage: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+    size: {
+        readonly type: PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", unknown>>;
+        readonly required: false;
+        readonly validator: (val: unknown) => boolean;
+        __epPropKey: true;
+    };
+    disabled: BooleanConstructor;
+    validateOnRuleChange: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
+    hideRequiredAsterisk: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, false, boolean>;
+    scrollToError: BooleanConstructor;
+};
+export declare const createBindProps: <T2 extends Record<string, any>, EX extends ("data" | "model" | "rules" | "labelPosition" | "labelWidth" | "labelSuffix" | "inline" | "inlineMessage" | "statusIcon" | "showMessage" | "size" | "disabled" | "validateOnRuleChange" | "hideRequiredAsterisk" | "scrollToError" | "formItems" | "elRef")[], K extends Extract<EX extends (infer V)[] ? Exclude<keyof T2, V> : keyof T2, "data" | "model" | "rules" | "labelPosition" | "labelWidth" | "labelSuffix" | "inline" | "inlineMessage" | "statusIcon" | "showMessage" | "size" | "disabled" | "validateOnRuleChange" | "hideRequiredAsterisk" | "scrollToError" | "formItems" | "elRef">>(propsArg: T2, excludes?: EX) => import("vue").ComputedRef<{ [k in K]: T2[k]; }>;
+export declare const emits: {
+    setData: (e: SetDataEvent) => SetDataEvent<any>;
+    validate: any;
+};
+export declare const createOnEmits: <T2 extends (...args: any) => any, EX extends ("validate" | "setData")[], K extends "validate" | "setData">(emit: T2, excludes?: EX) => { [k in K]: T2; };