Skip to main content

Function: useFormState()

useFormState<T>(): object

Defined in: hooks/useFormState.ts:32

Hook to manage the entire form state with reactive values and control methods. This hook provides access to all form values and methods to update them.

Type Parameters​

T​

T extends object

The type of the form data object

Returns​

object

Object containing form values and control methods

values​

values: undefined | T

setValues()​

setValues: (values) => void

Parameters​

values​

T

Returns​

void

getValues()​

getValues: () => undefined | T

Returns​

undefined | T

Example​

const MyComponent = () => {
  const { values, setValues, getValues } = useFormState<UserForm>();

  const handleReset = () => {
    setValues({ name: '', email: '' });
  };

  return (
    <div>
      <p>Current values: {JSON.stringify(values)}</p>
      <button onClick={handleReset}>Reset Form</button>
    </div>
  );
};