Field value within a re-indexed parent array item (keyed by UUID) temporarily becomes `undefined` on preceding item removal. #1518
Send to my agentDescribe the bug#
In TanStack Form, when managing an array of objects where each object uses a unique React key (e.g., a uuid), a specific re-render issue can occur. If an item is removed from this array, and that item is not the last one, fields within the item that shifts to take the removed item's place can have their form.Field instance report state.value as undefined for a transient period during the re-render.
This behavior is unexpected because fields, especially those initialized with default values or specific types (like strings or other arrays), are generally assumed to consistently provide a value of that type, not undefined.
Your minimal, reproducible example#
https://stackblitz.com/edit/tanstack-form-7wb235yh?file=src%2Fcollapsible-item.tsx
Steps to reproduce#
- Setup: The example form contains a
sectionsarray. Each item insectionsis an object with a uniqueuuid(used as its Reactkey) and asectionTitlestring field (initialized with a default string). Aninvariantchecks ifsectionTitle's value is a string. - Add Items: Click "Add Section" twice to create two distinct section items in the form.
- Remove Preceding Item: Click "Remove Section" for the first of the two section items.
- Observe Error: The application will throw an error, caught by the Error Boundary, for the remaining section item (which was previously the second). The error message will indicate that the
sectionTitlefield's value wasundefined, failing the invariant check:Invariant failed: Expected sectionTitle field value to be a string! Received: undefined. (See attached screenshot).
Expected behavior#
The state.value of any field (e.g., sectionTitle) within an array item should consistently maintain its correct type and initialized value throughout all re-render cycles. This includes re-renders that occur after removing a preceding item from the parent array and the subsequent re-indexing of items. A field initialized as a string should not temporarily become undefined.
How often does this bug happen?#
Every time
Screenshots or Videos#
https://github.com/user-attachments/assets/8fd533a5-2ab6-4d78-a11f-a6db69a1980a
Platform#
- Macos, Chrome browser
TanStack Form adapter#
react-form
TanStack Form version#
1.11.1
TypeScript version#
No response
Additional context#
No response
The issue persists in
@tanstack/react-formversion1.23.7.Plus one for this. I found this issue in
1.14.1and it persists in1.27.6. Very strange behavior.Calling
form.getFieldValuewith theform.Field'snameproperty value returns the correct result while thefield.state.valueis undefined.I found this issue in
'@tanstack/react-form': ^1.28.3which uses@tanstack/form-core@1.28.5.To reproduce it;#
- create a basic form with an object array.
- create "add new item" button to add items to it.
- create basic validation for the object's fields (like firstname is required, age must be a number etc.)
- create a "remove" button for each object that uses form.removeFieldValue
- Create an object fill it.
- Create another one leave it empty.
- Create the last one and fill it.
- Remove the 2nd one (the one with the empty fields).
Result:#
- No validation errors appear on the last card(it was the 3rd one before) when you submit it.
- You cannot submit the form its invalid but not visible.
- A newly created item will have the previous item's values for some reason.
How to get rid of it for now#
- Use mapped array's index for the key property of the object jsx tag.
Hi sorry it took so long for a response, but yeah you need to use the index of the map as the key for the container in order to get react reconciliation algorithm to react to changes.
I'll add a note to the docs now explaining this.
Sign in to join this conversation.
Hi 🙂
Could it be the same issue reported by @juanvilladev in https://github.com/TanStack/form/issues/1363 / https://github.com/TanStack/form/issues/1439 and possibly fixed by https://github.com/TanStack/form/pull/1440?
I am seeing the same issue on my end as well!