-
Notifications
You must be signed in to change notification settings - Fork 47.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[React 19] allow opting out of automatic form reset when Form Actions are used #29034
Comments
I think you should return current values from action in such case and update the default value 😃 |
@adobe export issue to Jira project PWA |
I think you should return current values from action in such case and update the default value. and return required! |
This is very necessary in the step-by-step form, such as verifying the email in the auth form first |
Be careful to handle if the action throws an error, your "returning the new default" at the end of the function will be ineffective. |
The automatic form reset in React 19 actually caught me off guard, where in my case, I was trying to validate the form inputs on the server, then return & display the input errors on the client, but React will reset all my uncontrolled inputs. For context, I wrote a library just for doing server-side validation https://github.com/chungweileong94/server-act?tab=readme-ov-file#useformstate-support. I know that you can pass the original input ( It's easy to reset a form, but hard to restore a form. |
Now that I have played with React 19 form reset for a while, I think this behavior kind of forces us to write a more progressive enhancement code. This means that if you manually return the form data from the server and restore the form values, the user input will persist even without JavaScript enabled. Mixed feelings, pros and cons. |
what about using onSubmit as well the action to prevent default? |
If you want to opt-out of automatic form reset, you should continue using +function handleSubmit(event) {
+ event.preventDefault();
+ const formData = new FormData(event.target);
+ startTransition(() => action(formData));
+}
...
-<form action={action}>
+<form onSubmit={handleSubmit}> -- That way you still opt-into transitions but keep the old non-resetting behavior. And if you're a component library with your own action-based API that wants to maintain form-resetting behavior, you can use // use isPending instead of `useFormStatus().pending`
const [isPending, startTransition] from useTransition();
function onSubmit(event) {
// Disable default form submission behavior
event.preventDefault();
const form = event.target;
startTransition(async () => {
// Request the form to reset once the action
// has completed
ReactDOM.requestFormReset(form);
// Call the user-provided action prop
await action(new FormData(form));
})
} --https://codesandbox.io/p/sandbox/react-opt-out-of-automatic-form-resetting-45rywk We haven't documented that yet in https://react.dev/reference/react-dom/components/form. It would help us a lot if somebody would file a PR with form-resetting docs. |
@eps1lon do you think using I am surprised by this new default behavior here, because this forces essentially everyone to use So if this reset behavior is a 100% set in stone for React 19, why not suggest using |
@rwieruch I'm not sure this is true. As @acdlite mentions in the PR below, it's for uncontrolled inputs.
Controlled inputs are probably in almost every form case still desirable with RSC (as Sebastian mentions "I will also say that it's not expected that uncontrolled form fields is the way to do forms in React. Even the no-JS mode is not that great.") Also, this is about "not diverging from browser behavior", as @rickhanlonii mentions in more discussion over on X here: But it does indeed seem to be a controversial choice to match browser behavior and reset uncontrolled fields. |
EDIT: I have written about the solution over HERE. Thanks for the input here @karlhorky and putting all the pieces together. I have seen that this matches the native browser more closely, so I see the incentive for this change. Just wanted to double check here, because I am re-adjusting my teaching material again (my own fault here, because we are still quite early on this :)). So if I am not using a third-party library for forms or actions, would the following code look good for upserting an entity with form + server action, if I still would want to use the const TicketUpsertForm = ({ ticket }: TicketUpsertFormProps) => {
const [actionState, action] = useActionState(
upsertTicket.bind(null, ticket?.id),
{ message: "" }
);
return (
<form action={action} className="flex flex-col gap-y-2">
<Label htmlFor="title">Title</Label>
<Input
id="title"
name="title"
type="text"
defaultValue={
(actionState.payload?.get("title") as string) || ticket?.title
}
/>
<Label htmlFor="content">Content</Label>
<Textarea
id="content"
name="content"
defaultValue={
(actionState.payload?.get("content") as string) || ticket?.content
}
/>
<SubmitButton label={ticket ? "Edit" : "Create"} />
{actionState.message}
</form>
);
}; And then the action returns the const upsertTicketSchema = z.object({
title: z.string().min(1).max(191),
content: z.string().min(1).max(1024),
});
export const upsertTicket = async (
id: string | undefined,
_actionState: {
message: string;
payload?: FormData;
},
formData: FormData
) => {
try {
const data = upsertTicketSchema.parse({
title: formData.get("title"),
content: formData.get("content"),
});
await prisma.ticket.upsert({
where: {
id: id || "",
},
update: data,
create: data,
});
} catch (error) {
return {
message: "Something went wrong",
payload: formData,
};
}
revalidatePath(ticketsPath());
if (id) {
redirect(ticketPath(id));
}
return { message: "Ticket created" };
}; EDIT: I think that's something @KATT wanted to point out in his proposal: #28491 (comment) |
Yup, that’s pretty much it. This way it works the same if submitted before hydration happens |
Resetting the form automatically is a real head-scratcher. How should we preserve the state of a form when errors occur? Using Using controlled components defeats the purpose of The example here is deceptively simple, as there are no visible form inputs. What am I missing? |
The docs are misleading on this topic because on the React 19 docs, it's the React 18 canary version that is shown as an example which does not reset the form. https://19.react.dev/reference/react-dom/components/form#handling-multiple-submission-types |
Automatic form reset only applies when passing functions to the The original issue description isn't explicit about this. @LutherTS If there was a change in behavior to APIs available in previous React stable versions, please include a reproduction. |
@eps1lon You're correct, the feature has only been available since the React 18 canary version so it's only going to be breaking for those using the canary version. However, the canary version is the default version running on Next.js, so the change may be breaking for a significant number of codebases there. |
The same thing doesn't apply to NextJS app router tho, where both |
Sure, but that would be an issue for Next.js. I don't think we rolled this change out in a 14.x Next.js stable release. The automatic form reset was enabled in #28804 which was included in vercel/next.js#65058 which is not part of any stable Next.js release as far as I can tell. |
OK, so what you're saying is this behavior only happens in Next.js 15 RC which uses React 19 RC, both of which being currently unstable, and therefore this is a trade-off for using unstable versions. Then at the very least the React 19 docs should reflect these changes. And I reiterate that if these changes are reflected in the React 19 docs, the entire example for "Handling multiple submission types" is completely irrelevant, because there is no point in saving a draft if after saving said draft it disappears from the textarea. So how does the React team reconcile presenting a feature for one purpose when the actual feature currently does the exact opposite? |
True, fair enough.
Yes, it is not. But that's the whole points right, where we feedback on a feature before stable release. I do think that auto form reset behaviour does bring some benefits in terms of progressive enhancement, but if you think again, React is kinda doing extra stuff unnecessarily. By default, the browser will reset the form when we submit it, then when we submit a form via JS(React), it retains the form values after submit, but React then artificially reset the form. Yes, form reset is a cheap operation, but why not make it an option for people to opt-in instead of doing it automatically. |
And that's certainly appreciated. Though there's an important difference between a change in behavior and the behavior of a new feature. The comments here read as though this breakage is not the norm when we didn't change any behavior between stable, SemVer minor React releases nor between stable, SemVer minor Next.js releases. Changes in behavior between Canary releases should be expected. Now that we established that this isn't a change in behavior, we can discuss the automatic form reset. The reason this was added was that it matches the native browser behavior before hydration or with no JS (e.g. when |
I have no minimal example at hand, but it seems like |
That seems like something you should be able to highlight starting with https://react.new. Though I believe |
Nice idea, I didn't think about it this way. I'm just really skeptical about relying on React features right now for stuff that can be done via HTML and pure JavaScript, because if the key prop experiences breaking changes in the future, this form feature may break down on the entire project. I don't think it will happen, but if anything can simply be handled with pure JavaScript, I consider it to be more reliable. |
Hey y'all – apologies if the Next.js docs added more confusion here. Transparently, I'm still learning the best way to teach these patterns too! So I appreciate this discussion. This is what I was doing previously using an event handler (as mentioned above): const handleSubmit = (event) => {
event.preventDefault();
startTransition(() => {
formAction(new FormData(event.currentTarget));
});
}; I prefer the default to reset the form, but fully acknowledge this has tripped me up, and will take more education to get it right (in both the Next.js and React docs). @rwieruch's example above is helpful and how I plan to teach this going forward, when you want to retain the client state. |
@leerob thanks for jumping in! Do you happen to know if there's been a final decision on whether the "new" automatic reset will be included in React 19? It would be really helpful to get confirmation so we can adjust our teaching accordingly going forward. |
This is a bug we're tracking in #30580 To avoid form reset, you can send back the original async function sendMessage(currentState, formData) {
const name = formData.get("name");
const message = formData.get("message");
if (!name || !message) {
return { form: formData, error: "Missing inputs" };
}
return {};
}
function Form({ action }) {
const [{ form = new FormData(), error }, formAction] = useActionState(
action,
{}
);
return (
<form action={formAction}>
<p>{error !== undefined ? error : null}</p>
<input name="name" defaultValue={form.get("name")} />
<input name="message" defaultValue={form.get("message")} />
<input type="submit" />
</form>
);
} If you want to control which inputs to reset on the Server, you have to send back a new FormData object. Using |
I'm not sure if this is a bad idea, but by utilizing both <form
action={formAction}
onSubmit={(e) => {
e.preventDefault();
startTransition(() => {
formAction(new FormData(e.currentTarget));
});
}}
> |
Unfortunately, this won't work for inputs like |
This is a bug. Likely related to #30580 |
Thanks @leerob and @eps1lon for the two solutions you've highlighted, and special thanks to @rwieruch for bringing it up initially. The first solution has the benefit of preventing the form submission altogether with preventDefault while still accessing the formData for the action, whereas the second solution brings the benefit of being able to choose the values that each uncontrolled field should reset to by returning the formData or even a modified version of it from the server. That being said, I feel like Lee's first solution is a bit of workaround which effectively bypasses the action prop and defeats its purpose in this circumstance, while Sebastian's solution still resets the form which is an extra undesired step in this case – even though the fields are reset with the appropriate values – and a step which is at the root of the bug this solution is currently facing with selects. Is there a one-size-fits-all solution that the React team by itself or in conjuction with the Next.js team (or any other framework) could produce which, in my opinion, would be able to bring the best of both worlds? Should React as a library focus on being closer to the original defaults, while Next.js as a framework focuses on the developer experience of this matter? I understand this is not an easy task, but it's one that I'd love for both teams to tackle internally. |
Adding here an example of the solution of returning the data from the action and using it as the defaultvalues. In this example, the item that's being edited is being used as the initialstate of useActionState. It becomes a very small piece of code that does not need javascript to run. It also returns the errors in the same way. export default function ContactForm({ contact }: { contact: Contact }) {
const updateContactById = updateContact.bind(null, contact.id);
const [state, updateContactAction] = useActionState(updateContactById, {
data: {
avatar: contact.avatar,
first: contact.first,
last: contact.last,
notes: contact.notes,
twitter: contact.twitter,
},
errors: {} as ContactSchemaErrorType,
});
return (
<form className="flex max-w-[40rem] flex-col gap-4 @container" action={updateContactAction}>
<div className="grip-rows-5 grid gap-2 @sm:grid-cols-[1fr_4fr] @sm:gap-4">
<span className="flex">Name</span>
<div className="flex gap-4">
<Input
errors={state.errors?.fieldErrors?.first}
defaultValue={state.data?.first || undefined} type State = {
data?: ContactSchemaType;
errors?: ContactSchemaErrorType;
};
export async function updateContact(contactId: string, _prevState: State, formData: FormData) {
const data = Object.fromEntries(formData);
const result = contactSchema.safeParse(data);
if (!result.success) {
return {
data: data as ContactSchemaType,
errors: result.error.formErrors,
};
} Blog post explaining each step: And by the way, using the action prop will allow you to optionally use the onSubmit for client-only extra functionality, like optimistic updates, that can be a progressive enhancement on top of the no-js base case as seen here |
Ideally you'd send back the original |
I tried this initially, but for some reason it wasn't working then. I can test it again! |
It won't work in Next.js just yet. It should work in |
This work for me: const formAction = () => {
startTransition(async () => {
await askAIAnalysis(new FormData(formRef.current!); // formRef is obtained from useRef of your form
};
<Button
disabled={pending}
onClick={formAction}>
Submit
</Button> |
Yes, but you might as well just use |
@rwieruch just saw your new "How to (not) reset a form after a Server Action in React" blog post, thanks for that! Seems like it could be a nice pattern:
'use server';
type ActionState = {
message: string;
payload?: FormData;
};
export async function createPost(
_actionState: ActionState,
formData: FormData,
) {
const data = {
name: formData.get('name'),
content: formData.get('content'),
};
if (!data.name || !data.content) {
return {
message: 'Please fill in all fields',
payload: formData,
};
}
// TODO: create post in database
return { message: 'Post created' };
}
'use client';
import { useActionState } from 'react';
import { createPost } from './action';
export function PostCreateForm() {
const [actionState, action] = useActionState(createPost, {
message: '',
});
return (
<form action={action}>
<label htmlFor="name">Name:</label>
<input
name="name"
id="name"
defaultValue={(actionState.payload?.get('name') || '') as string}
/>
<label htmlFor="content">Content:</label>
<textarea
name="content"
id="content"
defaultValue={(actionState.payload?.get('content') || '') as string}
/>
<button type="submit">Send</button>
{actionState.message}
</form>
);
} |
Yeah, thanks for sharing @karlhorky Seems pretty straightforward, but I didn't run into all the edge cases yet I guess 😅 |
@karlhorky thanks for your blog post. it was excellent. do you know how to handle it when its a ---- edit ---- |
@johnyvelho to be clear, it's not my blog post / research haha - it's from @rwieruch |
How do I handle form state if I want to use Zod on the frontend, and in case of errors, ensure that the form does not reset? |
@devdatkumar There are a couple of other solutions above that you're welcome to pursue as well and figure out what best fits your needs. I do want to point out that actions are uniquely situated to validate backend data, so maybe stick with an onSubmit? |
@quick007 I spent quite some time on this problem. I could persist data using the useState() hook, but then I had to manage the pending state. Additionally, I wanted to use the useActionState() hook, but there isn’t a clean code solution around it. So, I came up with a solution that you don’t recommend. Please guide me if this is the right way to handle things for creating a login/signup form. should i use react-hook-form ? and accept the defeat! :D. "use client";
// imports here.
export default function SignupCredentialsForm() {
const [state, dispatch, isPending] = useActionState(
signupAction,
undefined
);
return (
<Form
action={dispatch}
>
<Input
name="email"
defaultValue={state?.formData?.get("email")?.toString() ?? ""} //this is how i persist data.
/>
{state?.errorField?.email && (
<ul>
{state.errorField.email.map((error, index) => (
<li key={index}>{error}</li>
))}
</ul>
)}
// other fields
{state?.errorMessage && (
<div>
<p>{state.errorMessage}</p>
</div>
)}
<Button type="submit" disabled={isPending}>
{isPending ? "loading" : "Sign up"}
</Button>
</Form>
);
} "use server";
// import here
export async function signup(_prevState: unknown, formData: FormData) {
const validationResult = signupSchema.safeParse(Object.fromEntries(formData));
if (!validationResult.success) {
return {
errorField: validationResult.error?.flatten().fieldErrors,
formData,
};
}
try {
// something with database
} catch {
return {
errorMessage: "Something went wrong with Database!",
formData,
};
}
} |
I understand where you came from, but in what scenario does a user want to persist the changes that were made during the transition though? I personally kinda like the For example: User enters an invalid input and clicks submit, during the transition user made some changes to the input, after the state(with validation errors) being sent back and reset via I'm curious in what scenario where persisting the changes is needed? The form submission is usually fast (based on my usage of course), so I don't think they have enough time to change any of the fields |
Form state and validationHi everyone, I'm working on form validation for a project and would love your thoughts on the approach. Here's what I've been considering:
Although I don’t particularly like the "back-end validation" approach, I would prefer the "both front-end and back-end validation" option. Most users will interact with the form via the front-end, so validating on the client side and sending sanitized data seems better. This approach might reduce server load and avoids relying on the back-end response for basic validation. Additionally, it ensures that no Would love to hear your thoughts or suggestions for optimizing this further!
return { error: "Invalid data type." }
return { error: validationResult.error?.flatten().fieldErrors } well, this comes with a catch: Type error is thrown if other type of errors are returned. const validationResult = signinSchema.safeParse(Object.fromEntries(formData));
if (!validationResult.success) {
return { error: validationResult.error?.flatten().fieldErrors };
}
// authenticate credentials
if (!authenticated) {
return { error: "Invalid credentials!" };
} there are two ways to mitigate this error
const validationResult = signinSchema.safeParse(Object.fromEntries(formData));
if (!validationResult.success) {
errors: { ...validationResult.error?.flatten().fieldErrors, authError: undefined,}
}
// authenticate credentials
if (!authenticated) {
return {
error: {
email: undefined,
password: undefined,
authError: "Invalid credentials!",
}
}
const validationResult = signinSchema.safeParse(Object.fromEntries(formData));
if (!validationResult.success) {
return { fieldError: validationResult.error?.flatten().fieldErrors };
}
// authenticate credentials
if (!authenticated) {
return { authError: "Invalid credentials!" };
} |
This can be handled using |
One of the original examples from the react team was a save draft button. If you clicked this (especially if you coded in a hotkey for it), I could see it creating unintentional behavior. It's also worth noting server actions are only as fast as your server is, and if that server isn't vercel (or you have a really slow db connection from that), saving might not always be super fast. When submitting a form I don't see it as a huge issue, but saving (even for smth like a user profile), can become an issue. I also sometimes notice a problem with what I input after I click submit when filling out forms that will trigger an error, so I start editing while it's still submitting. Overall though, the defaultValue method is probably fine, just not my preferred method of implementation. I do think it fares better/worse in different scenarios though, so if it doesn't matter a lot in your implementation, have at it. Edit: Re-reading your message, I do see your concern about returning errors that are no longer valid. It's definitely a trade-off, with both resulting in a bad user experience. But if you move away from actions to client-side validation (with server-side as well), you can cut down on API calls and solve both issues in one swoop. |
Personally, I've gone back to just using onSubmit. Doesn't support progressive enhancement, but realistically my website isn't functional without js anyways. It also supports both frontend and backend validation, but (obviously) doesn't have anywhere near the DX of the native stuff. It's a shame, but still works fine and doesn't require controlled inputs. |
Summary
repo: https://github.com/stefanprobst/issue-react-19-form-reset
react 19@beta currently will automatically reset a form with uncontrolled components after submission. it would be really cool if there was a way to opt out of this behavior, without having to fall back to using controlled components - especially since component libraries (e.g.
react-aria
) have invested quite a bit of time to work well as uncontrolled form elements.the main usecase i am thinking of are forms which allow saving progress, or saving a draft, before final submit. currently, every "save progress" would reset the form.
The text was updated successfully, but these errors were encountered: