import type { PropType, ExtractPropTypes, HTMLAttributes, ComponentPublicInstance } from 'vue';
import FormItem from './FormItem';
import type { Options } from 'scroll-into-view-if-needed';
import type { VueNode } from '../_util/type';
import type { InternalNamePath, NamePath, ValidateErrorEntity, ValidateOptions } from './interface';
import type { SizeType } from '../config-provider';
import useForm from './useForm';
export declare type RequiredMark = boolean | 'optional';
export declare type FormLayout = 'horizontal' | 'inline' | 'vertical';
export declare type ValidationRule = {
/** validation error message */
message?: VueNode;
/** built-in validation type, available options: https://github.com/yiminghe/async-validator#type */
type?: string;
/** indicates whether field is required */
required?: boolean;
/** treat required fields that only contain whitespace as errors */
whitespace?: boolean;
/** validate the exact length of a field */
len?: number;
/** validate the min length of a field */
min?: number;
/** validate the max length of a field */
max?: number;
/** validate the value from a list of possible values */
enum?: string | string[];
/** validate from a regular expression */
pattern?: RegExp;
/** transform a value before validation */
transform?: (value: any) => any;
/** custom validate function (Note: callback must be called) */
validator?: (rule: any, value: any, callback: any, source?: any, options?: any) => any;
trigger?: string;
};
export declare const formProps: {
layout: import("vue-types").VueTypeDef<"inline" | "horizontal" | "vertical">;
labelCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
wrapperCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
colon: import("vue-types").VueTypeValidableDef;
labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
labelWrap: import("vue-types").VueTypeValidableDef;
prefixCls: import("vue-types").VueTypeValidableDef & {
default: string;
};
requiredMark: {
type: PropType<"" | RequiredMark>;
default: any;
};
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
hideRequiredMark: import("vue-types").VueTypeValidableDef;
model: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
rules: {
type: PropType<{
[k: string]: ValidationRule | ValidationRule[];
}>;
};
validateMessages: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
validateOnRuleChange: import("vue-types").VueTypeValidableDef;
scrollToFirstError: {
type: PropType>;
};
onSubmit: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
default: (...args: any[]) => any;
};
name: import("vue-types").VueTypeValidableDef & {
default: string;
};
validateTrigger: {
type: PropType;
};
size: {
type: PropType;
};
onValuesChange: {
type: PropType<(changedValues: any, values: any) => void>;
};
onFieldsChange: {
type: PropType<(changedFields: import("./interface").FieldData[], allFields: import("./interface").FieldData[]) => void>;
};
onFinish: {
type: PropType<(values: any) => void>;
};
onFinishFailed: {
type: PropType<(errorInfo: ValidateErrorEntity) => void>;
};
onValidate: {
type: PropType<(name: string | number | string[] | number[], status: boolean, errors: string[]) => void>;
};
};
export declare type FormProps = Partial>;
export declare type FormExpose = {
resetFields: (name?: NamePath) => void;
clearValidate: (name?: NamePath) => void;
validateFields: (nameList?: NamePath[] | string, options?: ValidateOptions) => Promise<{
[key: string]: any;
}>;
getFieldsValue: (nameList?: InternalNamePath[] | true) => {
[key: string]: any;
};
validate: (nameList?: NamePath[] | string, options?: ValidateOptions) => Promise<{
[key: string]: any;
}>;
scrollToField: (name: NamePath, options?: {}) => void;
};
export declare type FormInstance = ComponentPublicInstance;
declare const _default: {
new (...args: any[]): {
$: import("vue").ComponentInternalInstance;
$data: {};
$props: Partial<{
onSubmit: (...args: any[]) => any;
prefixCls: string;
name: string;
requiredMark: "" | RequiredMark;
model: {
[key: string]: any;
};
validateMessages: {
[key: string]: any;
};
}> & Omit;
labelCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
wrapperCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
colon: import("vue-types").VueTypeValidableDef;
labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
labelWrap: import("vue-types").VueTypeValidableDef;
prefixCls: import("vue-types").VueTypeValidableDef & {
default: string;
};
requiredMark: {
type: PropType<"" | RequiredMark>;
default: any;
};
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
hideRequiredMark: import("vue-types").VueTypeValidableDef;
model: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
rules: {
type: PropType<{
[k: string]: ValidationRule | ValidationRule[];
}>;
};
validateMessages: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
validateOnRuleChange: import("vue-types").VueTypeValidableDef;
scrollToFirstError: {
type: PropType>;
};
onSubmit: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
default: (...args: any[]) => any;
};
name: import("vue-types").VueTypeValidableDef & {
default: string;
};
validateTrigger: {
type: PropType;
};
size: {
type: PropType;
};
onValuesChange: {
type: PropType<(changedValues: any, values: any) => void>;
};
onFieldsChange: {
type: PropType<(changedFields: import("./interface").FieldData[], allFields: import("./interface").FieldData[]) => void>;
};
onFinish: {
type: PropType<(values: any) => void>;
};
onFinishFailed: {
type: PropType<(errorInfo: ValidateErrorEntity) => void>;
};
onValidate: {
type: PropType<(name: string | number | string[] | number[], status: boolean, errors: string[]) => void>;
};
}>> & {
onSubmit?: (...args: any[]) => any;
onValidate?: (...args: any[]) => any;
onFinish?: (...args: any[]) => any;
onFinishFailed?: (...args: any[]) => any;
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "onSubmit" | "prefixCls" | "name" | "requiredMark" | "model" | "validateMessages">;
$attrs: {
[x: string]: unknown;
};
$refs: {
[x: string]: unknown;
};
$slots: Readonly<{
[name: string]: import("vue").Slot;
}>;
$root: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase>;
$parent: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase>;
$emit: (event: "submit" | "finishFailed" | "finish" | "validate", ...args: any[]) => void;
$el: any;
$options: import("vue").ComponentOptionsBase;
labelCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
wrapperCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
colon: import("vue-types").VueTypeValidableDef;
labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
labelWrap: import("vue-types").VueTypeValidableDef;
prefixCls: import("vue-types").VueTypeValidableDef & {
default: string;
};
requiredMark: {
type: PropType<"" | RequiredMark>;
default: any;
};
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
hideRequiredMark: import("vue-types").VueTypeValidableDef;
model: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
rules: {
type: PropType<{
[k: string]: ValidationRule | ValidationRule[];
}>;
};
validateMessages: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
validateOnRuleChange: import("vue-types").VueTypeValidableDef;
scrollToFirstError: {
type: PropType>;
};
onSubmit: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
default: (...args: any[]) => any;
};
name: import("vue-types").VueTypeValidableDef & {
default: string;
};
validateTrigger: {
type: PropType;
};
size: {
type: PropType;
};
onValuesChange: {
type: PropType<(changedValues: any, values: any) => void>;
};
onFieldsChange: {
type: PropType<(changedFields: import("./interface").FieldData[], allFields: import("./interface").FieldData[]) => void>;
};
onFinish: {
type: PropType<(values: any) => void>;
};
onFinishFailed: {
type: PropType<(errorInfo: ValidateErrorEntity) => void>;
};
onValidate: {
type: PropType<(name: string | number | string[] | number[], status: boolean, errors: string[]) => void>;
};
}>> & {
onSubmit?: (...args: any[]) => any;
onValidate?: (...args: any[]) => any;
onFinish?: (...args: any[]) => any;
onFinishFailed?: (...args: any[]) => any;
}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("submit" | "finishFailed" | "finish" | "validate")[], string, {
onSubmit: (...args: any[]) => any;
prefixCls: string;
name: string;
requiredMark: "" | RequiredMark;
model: {
[key: string]: any;
};
validateMessages: {
[key: string]: any;
};
}> & {
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: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase>, info: string) => boolean | void) | ((err: unknown, instance: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase>, info: string) => boolean | void)[];
};
$forceUpdate: () => void;
$nextTick: typeof import("vue").nextTick;
$watch(source: string | Function, cb: Function, options?: import("vue").WatchOptions): import("vue").WatchStopHandle;
} & Readonly;
labelCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
wrapperCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
colon: import("vue-types").VueTypeValidableDef;
labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
labelWrap: import("vue-types").VueTypeValidableDef;
prefixCls: import("vue-types").VueTypeValidableDef & {
default: string;
};
requiredMark: {
type: PropType<"" | RequiredMark>;
default: any;
};
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
hideRequiredMark: import("vue-types").VueTypeValidableDef;
model: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
rules: {
type: PropType<{
[k: string]: ValidationRule | ValidationRule[];
}>;
};
validateMessages: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
validateOnRuleChange: import("vue-types").VueTypeValidableDef;
scrollToFirstError: {
type: PropType>;
};
onSubmit: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
default: (...args: any[]) => any;
};
name: import("vue-types").VueTypeValidableDef & {
default: string;
};
validateTrigger: {
type: PropType;
};
size: {
type: PropType;
};
onValuesChange: {
type: PropType<(changedValues: any, values: any) => void>;
};
onFieldsChange: {
type: PropType<(changedFields: import("./interface").FieldData[], allFields: import("./interface").FieldData[]) => void>;
};
onFinish: {
type: PropType<(values: any) => void>;
};
onFinishFailed: {
type: PropType<(errorInfo: ValidateErrorEntity) => void>;
};
onValidate: {
type: PropType<(name: string | number | string[] | number[], status: boolean, errors: string[]) => void>;
};
}>> & {
onSubmit?: (...args: any[]) => any;
onValidate?: (...args: any[]) => any;
onFinish?: (...args: any[]) => any;
onFinishFailed?: (...args: any[]) => any;
} & import("vue").ShallowUnwrapRef<() => JSX.Element> & {} & {} & import("vue").ComponentCustomProperties;
__isFragment?: never;
__isTeleport?: never;
__isSuspense?: never;
} & import("vue").ComponentOptionsBase;
labelCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
wrapperCol: {
type: PropType;
};
sm: {
type: PropType;
};
md: {
type: PropType;
};
lg: {
type: PropType;
};
xl: {
type: PropType;
};
xxl: {
type: PropType;
};
xxxl: {
type: PropType;
};
prefixCls: StringConstructor;
flex: (StringConstructor | NumberConstructor)[]; /** validation error message */
}>> & HTMLAttributes>;
};
colon: import("vue-types").VueTypeValidableDef;
labelAlign: import("vue-types").VueTypeDef<"left" | "right">;
labelWrap: import("vue-types").VueTypeValidableDef;
prefixCls: import("vue-types").VueTypeValidableDef & {
default: string;
};
requiredMark: {
type: PropType<"" | RequiredMark>;
default: any;
};
/** @deprecated Will warning in future branch. Pls use `requiredMark` instead. */
hideRequiredMark: import("vue-types").VueTypeValidableDef;
model: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
rules: {
type: PropType<{
[k: string]: ValidationRule | ValidationRule[];
}>;
};
validateMessages: import("vue-types").VueTypeValidableDef<{
[key: string]: any;
}> & {
default: () => {
[key: string]: any;
};
};
validateOnRuleChange: import("vue-types").VueTypeValidableDef;
scrollToFirstError: {
type: PropType>;
};
onSubmit: import("vue-types").VueTypeValidableDef<(...args: any[]) => any> & {
default: (...args: any[]) => any;
};
name: import("vue-types").VueTypeValidableDef & {
default: string;
};
validateTrigger: {
type: PropType;
};
size: {
type: PropType;
};
onValuesChange: {
type: PropType<(changedValues: any, values: any) => void>;
};
onFieldsChange: {
type: PropType<(changedFields: import("./interface").FieldData[], allFields: import("./interface").FieldData[]) => void>;
};
onFinish: {
type: PropType<(values: any) => void>;
};
onFinishFailed: {
type: PropType<(errorInfo: ValidateErrorEntity) => void>;
};
onValidate: {
type: PropType<(name: string | number | string[] | number[], status: boolean, errors: string[]) => void>;
};
}>> & {
onSubmit?: (...args: any[]) => any;
onValidate?: (...args: any[]) => any;
onFinish?: (...args: any[]) => any;
onFinishFailed?: (...args: any[]) => any;
}, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("submit" | "finishFailed" | "finish" | "validate")[], "submit" | "validate" | "finishFailed" | "finish", {
onSubmit: (...args: any[]) => any;
prefixCls: string;
name: string;
requiredMark: "" | RequiredMark;
model: {
[key: string]: any;
};
validateMessages: {
[key: string]: any;
};
}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {
readonly Item: typeof FormItem;
readonly useForm: typeof useForm;
};
export default _default;