@modular-forms/react/dist/types/hooks/useLifecycle.d.ts

The modular and type-safe form library for React

import type { FieldArrayPath, FieldPath, FieldPathValue, FieldValues, FormStore, InternalFieldArrayStore, InternalFieldStore, Maybe, MaybeArray, ResponseData, TransformField, ValidateField, ValidateFieldArray, ValidationMode } from '../types';
/**
 * Value type of the lifecycle properties.
 */
type LifecycleProps<TFieldValues extends FieldValues, TResponseData extends ResponseData, TFieldName extends FieldPath<TFieldValues>> = {
    of: FormStore<TFieldValues, TResponseData>;
    name: TFieldName | FieldArrayPath<TFieldValues>;
    store: InternalFieldStore<TFieldValues, TFieldName> | InternalFieldArrayStore;
    validate?: Maybe<MaybeArray<ValidateField<FieldPathValue<TFieldValues, TFieldName>>> | MaybeArray<ValidateFieldArray<number[]>>>;
    validateOn?: Maybe<ValidationMode>;
    revalidateOn?: Maybe<ValidationMode>;
    transform?: Maybe<MaybeArray<TransformField<FieldPathValue<TFieldValues, TFieldName>>>>;
    keepActive?: Maybe<boolean>;
    keepState?: Maybe<boolean>;
};
/**
 * Handles the lifecycle dependent state of a field or field array.
 *
 * @param props The lifecycle properties.
 */
export declare function useLifecycle<TFieldValues extends FieldValues, TResponseData extends ResponseData, TFieldName extends FieldPath<TFieldValues>>(props: LifecycleProps<TFieldValues, TResponseData, TFieldName>): void;
export {};