import type { SetupContext, UnwrapRef } from 'vue'; import type { RuleItem, ValidateError, ValidateFieldsError } from 'async-validator'; import type { ComponentSize } from 'element-plus/es/constants'; import type { Arrayable } from 'element-plus/es/utils'; import type { MaybeRef } from '@vueuse/core'; import type { FormItemProp, FormItemProps, FormItemValidateState } from './form-item'; import type { FormEmits, FormProps } from './form'; import type { useFormLabelWidth } from './utils'; export type FormLabelWidthContext = ReturnType; export interface FormItemRule extends RuleItem { trigger?: Arrayable; } type Primitive = null | undefined | string | number | boolean | symbol | bigint; type BrowserNativeObject = Date | FileList | File | Blob | RegExp; /** * Check whether it is tuple * * 检查是否为元组 * * @example * IsTuple<[1, 2, 3]> => true * IsTuple => false */ type IsTuple> = number extends T['length'] ? false : true; /** * Array method key * * 数组方法键 */ type ArrayMethodKey = keyof any[]; /** * Tuple index key * * 元组下标键 * * @example * TupleKey<[1, 2, 3]> => '0' | '1' | '2' */ type TupleKey> = Exclude; /** * Array index key * * 数组下标键 */ type ArrayKey = number; /** * Helper type for recursively constructing paths through a type * * 用于通过一个类型递归构建路径的辅助类型 */ type PathImpl = V extends Primitive | BrowserNativeObject ? `${K}` : `${K}` | `${K}.${Path}`; /** * Type which collects all paths through a type * * 通过一个类型收集所有路径的类型 * * @see {@link FieldPath} */ type Path = T extends ReadonlyArray ? IsTuple extends true ? { [K in TupleKey]-?: PathImpl, T[K]>; }[TupleKey] : PathImpl : { [K in keyof T]-?: PathImpl, T[K]>; }[keyof T]; /** * Type which collects all paths through a type * * 通过一个类型收集所有路径的类型 * * @example * FieldPath<{ 1: number; a: number; b: string; c: { d: number; e: string }; f: [{ value: string }]; g: { value: string }[]; h: Date; i: FileList; j: File; k: Blob; l: RegExp }> => '1' | 'a' | 'b' | 'c' | 'f' | 'g' | 'c.d' | 'c.e' | 'f.0' | 'f.0.value' | 'g.number' | 'g.number.value' | 'h' | 'i' | 'j' | 'k' | 'l' */ type FieldPath = T extends object ? Path : never; export type FormRules | string> = string> = Partial extends string ? UnwrapRef : FieldPath>, Arrayable>>; export type FormValidationResult = Promise; export type FormValidateCallback = (isValid: boolean, invalidFields?: ValidateFieldsError) => Promise | void; export interface FormValidateFailure { errors: ValidateError[] | null; fields: ValidateFieldsError; } export type FormContext = FormProps & UnwrapRef & { emit: SetupContext['emit']; getField: (prop: FormItemProp) => FormItemContext | undefined; addField: (field: FormItemContext) => void; removeField: (field: FormItemContext) => void; resetFields: (props?: Arrayable) => void; clearValidate: (props?: Arrayable) => void; validateField: (props?: Arrayable, callback?: FormValidateCallback) => FormValidationResult; }; export interface FormItemContext extends FormItemProps { $el: HTMLDivElement | undefined; size: ComponentSize; validateMessage: string; validateState: FormItemValidateState; isGroup: boolean; labelId: string; inputIds: string[]; hasLabel: boolean; fieldValue: any; propString: string; addInputId: (id: string) => void; removeInputId: (id: string) => void; validate: (trigger: string, callback?: FormValidateCallback) => FormValidationResult; resetField(): void; clearValidate(): void; } export {};