Repository navigation
isDirty should flip back to false when default values are equal #1080
Description
Describe the bug
isDirty flips to true when you change any form value, but doesn't return to false when the state returns back to default values.
For most if not all form libraries I've used, the expected behavior is the form is not dirty when the default values is equal. See formik example here:
https://stackblitz.com/edit/react-hooks-form-validation-example-formik-hh9rdieb
Tanstack Form already exposes the isTouched property which can be used to determine if the form has been touched. It appears right now that both isTouched and isDirty now have the same behavior. Except when you reset the form, dirty returns to false as expected.
Your minimal, reproducible example
https://stackblitz.com/edit/tanstack-form-1cspfar1?file=src%2Findex.tsx
Steps to reproduce
- Type in to the input
- See that the form is dirty
- Remove the value from the input
- See that the form remains dirty
- Reset the form
- See that the form is no longer dirty
Expected behavior
- Type into the input
- See that the form is dirty
- Remove the value from the input (effectively resetting it)
- See that the form is no longer dirty
How often does this bug happen?
None
Screenshots or Videos
No response
Platform
- Windows
- Chrome Version 131.0.6778.140
TanStack Form adapter
None
TanStack Form version
0.40.2
TypeScript version
No response
Additional context
No response
Reacted by Chynara Aitkulova and nick
Activity
thazlett16 commentedon Dec 17, 2024
This is documented in the field-state section.
In your example if you add the
isTouchedprop with yourisDirtyflag,isTouchedwill change totruewhen you focus the input and then remove focus from the input field (without changing the value).alexqhj commentedon Dec 17, 2024
That's not what I'm referring to.
Even the docs say:
Changed, not modified.
A-B (the value has changed. I.e it's dirty)
A-B-A (the value hasn't been changed, i.e not dirty, but touched)
If the field returns to its original value, is it still dirty? All libraries I've worked with so far says no, it's only touched. Dirty is only true if the values differ from the initial value(s).
thazlett16 commentedon Dec 17, 2024
I'm not a maintainer so not sure for their reasoning but just wanted to point you to the right spot for the different lifecycles. Under the image of that link for
field-statethey say:If you want to keep the issue open and talk to them about why that is the case that is fine. Just wanted to point you in the right direction!
alexqhj commentedon Dec 17, 2024
Yeah I think it warrants a discussion. I'd love to hear the reasoning behind this deviation, as the behavior of
isDirtyseems to be a well established in many well known form libraries. I'll reopen this as a question instead.devth commentedon Jan 17, 2025
Discussion continues at #1081 (I have the same question).