Skip to content

Commit f450f1f

Browse files
committed
chore: generate markdown docs from jsdocs
1 parent 3bc35f5 commit f450f1f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/api/declarative-routers/Router.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,16 @@ will not be reactive to location changes.
7474

7575
### unstable_useTransitions
7676

77-
Whether this router should wrap navigations in `React.startTransition()`
77+
Control whether router state updates are internally wrapped in
78+
[`React.startTransition`](https://react.dev/reference/react/startTransition).
79+
80+
- When left `undefined`, all router state updates are wrapped in
81+
`React.startTransition`
82+
- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
83+
in `React.startTransition` and all router state updates are wrapped in
84+
`React.startTransition`
85+
- When set to `false`, the router will not leverage `React.startTransition`
86+
on any navigations or state changes.
87+
88+
For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
7889

0 commit comments

Comments
 (0)