react-ts-form-hook - v1.1.6
    Preparing search index...

    Function useForm

    • Custom React hook for managing forms with validation.

      Type Parameters

      • T

        Type representing the shape of your form values.

      Parameters

      Returns {
          bindError: (
              name: keyof T,
          ) => {
              errorMessage: undefined | Partial<Record<keyof T, string>>[keyof T];
          };
          bindInput: (
              name: keyof T,
              doValidateCheck?: boolean,
          ) =>
              | {
                  checked: T[keyof T] & boolean;
                  name: keyof T;
                  onChange: (e: FormChangeEvent) => void;
                  value?: undefined;
              }
              | {
                  checked?: undefined;
                  name: keyof T;
                  onChange: (e: FormChangeEvent) => void;
                  value: string | number;
              };
          errors: Partial<Record<keyof T, string>>;
          handleChange: (e: FormChangeEvent, doValidateCheck?: boolean) => void;
          handleSubmit: (e: FormEvent<HTMLFormElement>) => Promise<void>;
          isPristine: boolean;
          isValid: boolean;
          resetForm: () => void;
          setValidationErrors: (validationErrors: FormErrors<T>) => void;
          updateValues: (updatedValues: T, doValidateCheck?: boolean) => void;
          values: T;
      }

      • bindError: (
            name: keyof T,
        ) => { errorMessage: undefined | Partial<Record<keyof T, string>>[keyof T] }

        Binds error message for a field

      • bindInput: (
            name: keyof T,
            doValidateCheck?: boolean,
        ) =>
            | {
                checked: T[keyof T] & boolean;
                name: keyof T;
                onChange: (e: FormChangeEvent) => void;
                value?: undefined;
            }
            | {
                checked?: undefined;
                name: keyof T;
                onChange: (e: FormChangeEvent) => void;
                value: string | number;
            }

        Return props for binding an input element to the form.

      • errors: Partial<Record<keyof T, string>>
      • handleChange: (e: FormChangeEvent, doValidateCheck?: boolean) => void

        Handles input changes and triggers optional validation

      • handleSubmit: (e: FormEvent<HTMLFormElement>) => Promise<void>

        Handles form submission

      • isPristine: boolean
      • isValid: boolean
      • resetForm: () => void

        Reset form values and errors to initial state.

      • setValidationErrors: (validationErrors: FormErrors<T>) => void

        Set validation errors programmatically

      • updateValues: (updatedValues: T, doValidateCheck?: boolean) => void

        Updates multiple form values programmatically

      • values: T