TanStack / TanStack/form

Type error when passing field from `useForm(formOptions(...))` to `AnyFieldApi` prop

Open
#1,794 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: bug v1 v2: needs investigation
Dominant language
TypeScript
Stars
6.7k
Forks
682
Avg merge
5d 18h
Merged PRs (30d)
7

Description

Describe the bug

When I try to pass field object (FieldApi) to prop of type AnyFieldApi I get a type error. It only happens when the form object from useForm was created using the formOptions function.

TS2322: Type
FieldApi<{ firstName: string; }, "firstName", string, FieldValidateOrFn<{ firstName: string; }, "firstName", string> | undefined, ({ value }: { value: string; fieldApi: FieldApi<{ ...; }, ... 21 more ..., any>; }) => "A first name is required" | ... 1 more ... | undefined, ... 17 more ..., never>
is not assignable to type AnyFieldApi
The types of form.options.listeners are incompatible between these types.
Type 'FormListeners<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, FormAsyncValidateOrFn<...> | undefined, ... 7 more ..., never> | undefined' is not assignable to type 'FormListeners<any, any, any, any, any, any, any, any, any, any, any, any> | undefined'.
Type 'FormListeners<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, FormAsyncValidateOrFn<...> | undefined, ... 7 more ..., never>' is not assignable to type 'FormListeners<any, any, any, any, any, any, any, any, any, any, any, any>'.
Types of property onChange are incompatible.
Type '((props: { formApi: FormApi<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, ... 8 more ..., never>; fieldApi: AnyFieldApi; }) => void) | undefined' is not assignable to type '((props: { formApi: FormApi<any, any, any, any, any, any, any, any, any, any, any, any>; fieldApi: AnyFieldApi; }) => void) | undefined'.
Type '(props: { formApi: FormApi<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, ... 8 more ..., never>; fieldApi: AnyFieldApi; }) => void' is not assignable to type '(props: { formApi: FormApi<any, any, any, any, any, any, any, any, any, any, any, any>; fieldApi: AnyFieldApi; }) => void'.
Types of parameters props and props are incompatible.
Type '{ formApi: FormApi<any, any, any, any, any, any, any, any, any, any, any, any>; fieldApi: AnyFieldApi; }' is not assignable to type '{ formApi: FormApi<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, ... 8 more ..., never>; fieldApi: AnyFieldApi; }'.
The types of formApi.options.listeners are incompatible between these types.
Type 'FormListeners<any, any, any, any, any, any, any, any, any, any, any, any> | undefined' is not assignable to type 'FormListeners<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, FormAsyncValidateOrFn<...> | undefined, ... 7 more ..., never> | undefined'.
Type 'FormListeners<any, any, any, any, any, any, any, any, any, any, any, any>' is not assignable to type 'FormListeners<{ firstName: string; }, FormValidateOrFn<{ firstName: string; }> | undefined, FormValidateOrFn<{ firstName: string; }> | undefined, FormAsyncValidateOrFn<...> | undefined, ... 7 more ..., never>'.
Type any is not assignable to type never
Your minimal, reproducible example

https://stackblitz.com/edit/vitejs-vite-qffrfz9w?file=src%2FApp.tsx

Steps to reproduce
  1. Open stackblitz repro.
  2. See the type error you get when you try to pass field object to field prop of FieldInfo component.
  3. Delete onSubmit handler from formOptions.
  4. The type error is gone.

Also, if you take the stuff you pass into formOptions and directly pass it to useForm, (skipping formOptions completely) there is no type error. But I need to reuse the options in other useForm calls.

The repro code is the example from https://tanstack.com/form/latest, when you scroll all the way down. I just moved the options to formOptions instead of passing them directly to useForm.

Expected behavior

The type error should not happen when onSubmit handler is present in formOptions.

How often does this bug happen?

Every time

Screenshots or Videos
Image
Platform

rocky linux, chrome 139

TanStack Form adapter

react-form and svelte adapter. I didn't check other frameworks.

TanStack Form version

^1.23.5

TypeScript version

~5.9.3

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked StackBlitz reproduction and compare the types produced by useForm(formOptions(...)) with options passed directly to useForm. Trace the AnyFieldApi and FieldInfo types involved in the reported error, then verify that the reproduction compiles with onSubmit retained and that the React and Svelte adapters remain covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.