[FEATURE] Form callback API

[crutchcorn]

Imagine a usecase where the user wants two buttons, they both send the item to the backend (after form validation) but one goes back to the list and the other goes to a different page, like a step 2 or a detail page.

To solve this, we're thinking of introducing a new API called onSubmitMeta that allows you to pass arguments to the onSubmit function via a meta field.

This API might look something like this:

  const form = useForm({
    defaultValues: {
      firstName: '',
      lastName: '',
    },
    // Is 'never' by default unless you provide a type
    // {} is the default value passed to `onSubmit`'s `meta` property
    onSubmitMeta: {} as { someValue: string },
    onSubmit: async ({ value, meta }) => {
      // Do something with form data
      console.log(value)
      // Do something with the values passed via handleSubmit
      console.log(meta)
    },
  })

  return (
    <div>
      <h1>Simple Form Example</h1>
      <form
        onSubmit={(e) => {
          e.preventDefault()
          e.stopPropagation()
          form.handleSubmit({
            someValue: 'value',
          })
        }}
      >

By having onSubmitMeta it enables us to have a few features on top of passing properties such as:

• Type safety
• Default arguments to meta field from the FW itself

This API should be purely additive, so it may not make it into v1 of TanStack Form

[thejasviES]

Hi @crutchcorn can I be assigned this ticket?

[zoodirector]

Hey @crutchcorn . Thank you very much for taking up my ideas of #949 ! However, I don't find this API proposal of yours particularly advantageous. It would require me to put the business logic that handles the server response (e.g. navigating to different routes after submissions) inside the onSubmit function of the form. It is an inversion of control where not necessary. For me it would feel more natural if the form API would return control after the successful submission of the form and not wrap around the business logic that follows afterwards. I think that my suggested design in #949 would allow for a better decoupling of code. For example if I want to reuse the same redirection logic in different forms.

But that is just my opinion. I guess I could also live with the API suggested above.

[godd9170]

I've got this exact use case, and I was able to solve it by looking at the id of the submitting button.

() => {
  let form = useForm({
    defaultValues: {},
    onSubmit: async ({ value }) => await post(value),
  });
  return (
    <form
      onSubmit={async (event) => {
        event.preventDefault();
        event.stopPropagation();
        await form.handleSubmit();
        if (event.nativeEvent.submitter.id === "save-and-go-back") {
          // redirect
        }
      }}
    >
      <button id="save" name="save" type="submit">
        Save
      </button>
      <button id="save-and-go-back" name="save-and-go-back" type="submit">
        Save & Go Back
      </button>
    </form>
  );
};

What I would love, is the ability to get the response returned from my onSubmit, from form.handleSubmit as @zoodirector has proposed above. Like this . That way, I could use some server values in the redirect (such as a newly created id).

So it would become

() => {
  let form = useForm({
    defaultValues: {},
    onSubmit: async ({ value }) => await post(value),
  });
  return (
    <form
      onSubmit={async (event) => {
        event.preventDefault();
        event.stopPropagation();
        const response = await form.handleSubmit();
        if (event.nativeEvent.submitter.id === "save-and-go-back") {
          history.push(`items/${response.id}`)
        }
      }}
    >
      <button id="save" name="save" type="submit">
        Save
      </button>
      <button id="save-and-go-back" name="save-and-go-back" type="submit">
        Save & Go Back
      </button>
    </form>
  );
};

[Rinaldo]

I think there's value in getting the result from onSubmit but I also see not wanting to deal with unhandled promise rejections when calling handleSubmit.

One possibility would be to move closer to the useMutation hook from TanStack Query where there are separate mutation.mutate and mutation.mutateAsync methods. The form object could have both submit and submitAsync methods which return void and the result of onSubmit respectively.