Add network usage example and caveat to useOptimistic page #6463
Conversation
kmiddleton14
requested review from
davidmccabe,
lunaleaps and
mattcarrollcode
Size changes📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
|
|
||
| #### Caveats {/*caveats*/} | ||
|
|
||
| * An optimistic state update needs to be called in an action or wrapped with `startTransition`. If it's used outside an action or a transition React will throw an error. |
There was a problem hiding this comment.
| * An optimistic state update needs to be called in an action or wrapped with `startTransition`. If it's used outside an action or a transition React will throw an error. | |
| * An optimistic state update needs to be called in an action or wrapped with `startTransition`. If it's used outside an action or a transition, React will throw an error. |
|
|
||
| --- | ||
|
|
||
| ### Optimistically update the UI while waiting for a network request {/*optimistically-update-while-waiting-for-network*/} |
There was a problem hiding this comment.
Hmm I may be forgetting something but what was the reasoning for us to add this example? It seems quite similar to the form action example above, the only difference being that it isn't in a form? I think we'd want to add some description here of why this example is worth highlighting.
In addition, I think it'd be valuable to expand the example and show a failed optimistic update.
There was a problem hiding this comment.
Yes it is similar but wanted to showcase another example that isn't using a form. I agree on adding in a failure example and have it as a followup
There was a problem hiding this comment.
Can we add a line about that?
Something like
| ### Optimistically update the UI while waiting for a network request {/*optimistically-update-while-waiting-for-network*/} | |
| ### Optimistically update the UI while waiting for a network request {/*optimistically-update-while-waiting-for- | |
| network*/} | |
| `useOptimistic` can also be used outside of forms, for any network request but within a transition. |
| import { startTransition, useOptimistic } from "react"; | ||
|
|
||
| export function LikeButton({ likes, updateLikes, disabled }) { | ||
| const [optimisticLikes, addOptimisticLike] = useOptimistic( |
There was a problem hiding this comment.
Also the example for me is not updating the like count from 0->1
re: https://react-ac6nnqh06-fbopensource.vercel.app/reference/react/useOptimistic#noun-labs-1201738-(2)
There was a problem hiding this comment.
@lunaleaps One way to fix this example would be to start a transition with useTransition hook instead of using the standalone startTransition function. This way you'll be able to:
- replace the
disabledprop with the transition's pending state, - make the arrow function (scope) passed to
startTransitionasync and awaitupdateLikesinside (crucial).
It fixes the issue while slightly simplifying the code, here's the preview:
https://codesandbox.io/p/sandbox/gallant-nova-8w3s2h
|
Hi @kmiddleton14! Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours needs attention. You currently have a record in our system, but the CLA is no longer valid, and will need to be resubmitted. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
4 participants
useOptimisticDemo.mp4