[Suggestion]: Document that useFormStatus works with a preventDefault-ed onSubmit + startTransition
Les mainteneurs répondent en général sous 3 jours
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 78/100
- Type d'issue
- Documentation
- Clarté
- Clairement spécifiée
- Activité
- Active
- Stack technique
- javascript, react
- Domaine
- documentation
Piste de recherche
Mettez à jour la page de référence de useFormStatus à l’adresse react.dev/reference/react-dom/hooks/useFormStatus. Lisez les sections Returns et Usage, puis vérifiez la PR React liée et les cas de ReactDOMForm-test.js afin de confirmer les conditions décrites. Ajoutez l’explication de l’état en attente et un court exemple avec onSubmit/preventDefault()/startTransition ; le travail est terminé lorsque les deux appels requis et le comportement sont documentés avec exactitude.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Summary
Document that useFormStatus also reports pending: true when a submit event handler calls event.preventDefault() and starts a Transition with startTransition, not only when the form uses the action prop.
Page
https://react.dev/reference/react-dom/hooks/useFormStatus
Details
I'm implementing a custom <Form> component that accepts a Transition-based prop like submitAction (it validates and transforms the values, then calls submitAction inside startTransition). I wanted to provide the form's pending state through useFormStatus itself, instead of adding a custom context. While investigating, I found that this already works, but because it is not documented, I could not tell whether it is safe to rely on.
The useFormStatus page currently describes the status only in terms of the action prop on the parent <form>. However, since https://github.com/facebook/react/pull/29019 (shipped in React 19.0.0), useFormStatus is also activated when startTransition is called inside a submit event handler that is preventDefault-ed:
After this change,
useFormStatuswill also be activated if you callstartTransition(actionFn)inside a submit event handler that ispreventDefault-ed.
The PR describes this as the way for UI component libraries to implement a custom action prop with onSubmit, and the behavior is covered by tests in ReactDOMForm-test.js:
- useFormStatus is activated if startTransition is called inside preventDefault-ed submit event
- useFormStatus is not activated if startTransition is not called
- useFormStatus is not activated if event is not preventDefault-ed
This matters for form components like mine that cannot use the action prop, for example because they validate and transform values before calling the action, or because they do not want the automatic form reset.
I confirmed the behavior with React 19.3.0 in Chrome.
Playground: https://codesandbox.io/p/sandbox/custom-useformstatus-fm2fkl
// App.js
import { startTransition, useActionState } from "react";
import { useFormStatus } from "react-dom";
// A fake request that takes 2 seconds.
function save(value) {
return new Promise((resolve) => setTimeout(() => resolve(value), 2000));
}
// A form component in a UI library. It does not use the `action` prop,
// e.g. because it validates and transforms the values before calling the action.
function MyForm({ submitAction, children }) {
return (
<form
onSubmit={(event) => {
event.preventDefault();
const value = new FormData(event.currentTarget).get("name");
startTransition(async () => {
await submitAction(value);
});
}}
>
{children}
</form>
);
}
function SubmitButton() {
const { pending } = useFormStatus();
return (
<button type="submit" disabled={pending}>
{pending ? "Sending" : "Send"}
</button>
);
}
function App() {
const [state, sendAction] = useActionState(async (prev, value) => {
await save(value);
return value;
}, null);
return (
<MyForm submitAction={sendAction}>
<input name="name" />
<SubmitButton />
{state && <p>Saved: {state}</p>}
</MyForm>
);
}
export default App;
pending stays true until the action finishes, and the form is not reset.
Suggested changes:
- In "Returns", say that
pendingis alsotruewhile a Transition started from apreventDefault-ed submit event of the parent<form>is pending. - In "Usage", add a short example of the
onSubmit+preventDefault()+startTransitionpattern, and note that bothpreventDefault()andstartTransitionin the same event are required.
- Langage dominant
- JavaScript
- Étoiles
- 11.8k
- Forks
- 8k
- Merge moyen
- 3 j 5 h
- PR mergées (30 j)
- 9
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de reactjs/react.dev
-
[Suggestion]: lazy initialization example can encourage unsafe patterns - show examplePeut-être pris @Mahendra-2006 l’a pris il y a 6 jours. Ouvertetype: documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
reactjs/react.dev#8677 · 2 commentaires ·
Les mainteneurs répondent en général sous 3 jours
-
type: documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
reactjs/react.dev#8661 · 1 commentaire · 7 réactions ·
Les mainteneurs répondent en général sous 3 jours
-
docs: improve useState explanation in quick startPeut-être pris @tirthraj01 l’a pris il y a 25 jours. Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 3 jours
-
[Bug]: Next button throws a runtime error instead of cycling to the first sculpturePeut-être pris @Saurav10codes l’a pris il y a 33 jours. Ouvertebug: unconfirmed
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
reactjs/react.dev#8634 · 3 commentaires ·
Les mainteneurs répondent en général sous 3 jours
-
[Typo]: Repeaded words in Pitfall sectionPeut-être pris @mdimamhosen l’a pris il y a 35 jours. Ouvertetype: typos
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
reactjs/react.dev#8622 · 1 commentaire ·
Les mainteneurs répondent en général sous 3 jours
Toutes les issues de reactjs/react.dev
Issues similaires
-
Bug pulumi/pulumi
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
andromarces/agent-loops#571 ·
Les mainteneurs répondent en général sous 1 jour
-
Code Cleanup Dev Environment
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
ProjectSidewalk/SidewalkWebpage#5699 ·
Les mainteneurs répondent en général sous 1 jour
-
automated issue report
Difficulté 2/5 1-3 heures Accessibilité débutants 64/100
lirantal/discoprint#38 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
zenstackhq/zenstack#2873 ·
Les mainteneurs répondent en général sous 1 jour