Skip to main content

Function: useFormValue()

useFormValue<T>(fieldPath?): undefined | T

Defined in: hooks/useFormValue.ts:30

Hook to get a reactive value from the form state. This hook subscribes to value changes and returns the current value.

Type Parameters​

T​

T

The type of the value to retrieve

Parameters​

fieldPath?​

string

Optional dot notation path to the field. If not provided, returns all form values

Returns​

undefined | T

The current value at the specified path or all form values

Example​

const MyComponent = () => {
  const userName = useFormValue<string>('user.name');
  const allValues = useFormValue<UserForm>();

  return (
    <div>
      <p>User name: {userName}</p>
      <p>All values: {JSON.stringify(allValues)}</p>
    </div>
  );
};