[Suggestion]: Can you add a paragraph saying useOptimistic updater function should be called in transition?

[gmoniava]

Summary

Here:

const [optimisticState, addOptimistic] = useOptimistic(state, updateFn);

When you call updateFn without transition react gives warning:

Warning: An optimistic state update occurred outside a transition or action. To fix, move the update to an action, or wrap with startTransition.

Page

https://react.dev/reference/react/useOptimistic

Details

Can you also add this information (which is in the warning) in the docs so that it is not only as a warning in the console?

[rickhanlonii]

Yeah we need to rewrite all of the useOptimistic docs.

[MaxwellCohen]

A clear warning ought to be added, but in addition, notes/sections should be added throughout the page

some ideas:

• Pifall warning section with the console warning
• In the returns section
  

  react.dev/src/content/reference/react/useOptimistic.md

  Line 53 in 2da4f7f

  * `addOptimistic`: `addOptimistic` is the dispatching function to call when you have an optimistic update. It takes one argument, `optimisticValue`, of any type and will call the `updateFn` with `state` and `optimisticValue`.

  
  Add a few words like the suggested bold text here
  addOptimistic: addOptimistic is the dispatching function to call when you have an optimistic update in a transition or form action. It takes one argument, optimisticValue, of any type and will call the updateFn with state and optimisticValue.
• linking to the resulting documentation of the Async React Working Group.
• code example(s) explicitly calling that addOptimistic needs to be called in a transition.

I am very excited about the useOptimistic and other Async React work. This is a shift in thinking that will have lots of little paper cuts, so it is important to have doc/warnings/tools be explicit about how to use them. I hope this is helpful.

[rickhanlonii]

Thanks @MaxwellCohen, I think I address all that feedback and the original suggest in #7737!

[gmoniava]

@rickhanlonii Ricky I want to use an opportunity and ask you is anyone trying to address this: #7984? don't you think it raises valid points?