chore: generate markdown docs from jsdocs

Author: remix-run-bot

docs/api/data-routers/RouterProvider.md

@@ -49,6 +49,7 @@ function RouterProvider({
   router,
   flushSync: reactDomFlushSyncImpl,
   unstable_onError,
+  unstable_useTransitions,
 }: RouterProviderProps): React.ReactElement
 ```
 
@@ -86,3 +87,22 @@ and is only present for render errors.
 
 The [`DataRouter`](https://api.reactrouter.com/v7/interfaces/react_router.DataRouter.html) instance to use for navigation and data fetching.
 
+### unstable_useTransitions
+
+Control whether router state updates are internally wrapped in
+[`React.startTransition`](https://react.dev/reference/react/startTransition).
+
+- When left `undefined`, all state updates are wrapped in
+  `React.startTransition`
+  - This can lead to buggy behaviors if you are wrapping your own
+    navigations/fetchers in `startTransition`.
+- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
+  in `React.startTransition` and router state changes will be wrapped in
+  `React.startTransition` and also sent through
+  [`useOptimistic`](https://react.dev/reference/react/useOptimistic) to
+  surface mid-navigation router state changes to the UI.
+- When set to `false`, the router will not leverage `React.startTransition` or
+  `React.useOptimistic` on any navigations or state changes.
+
+For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
+

docs/api/declarative-routers/BrowserRouter.md

@@ -28,7 +28,12 @@ API for client-side routing.
 ## Signature
 
 ```tsx
-function BrowserRouter({ basename, children, window }: BrowserRouterProps)
+function BrowserRouter({
+  basename,
+  children,
+  unstable_useTransitions,
+  window,
+}: BrowserRouterProps)
 ```
 
 ## Props
@@ -41,6 +46,21 @@ Application basename
 
 ``<Route>`` components describing your route configuration
 
+### unstable_useTransitions
+
+Control whether router state updates are internally wrapped in
+[`React.startTransition`](https://react.dev/reference/react/startTransition).
+
+- When left `undefined`, all router state updates are wrapped in
+  `React.startTransition`
+- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
+  in `React.startTransition` and all router state updates are wrapped in
+  `React.startTransition`
+- When set to `false`, the router will not leverage `React.startTransition`
+  on any navigations or state changes.
+
+For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
+
 ### window
 
 [`Window`](https://developer.mozilla.org/en-US/docs/Web/API/Window) object

docs/api/declarative-routers/HashRouter.md

@@ -29,7 +29,12 @@ of the URL so it is not sent to the server.
 ## Signature
 
 ```tsx
-function HashRouter({ basename, children, window }: HashRouterProps)
+function HashRouter({
+  basename,
+  children,
+  unstable_useTransitions,
+  window,
+}: HashRouterProps)
 ```
 
 ## Props
@@ -42,6 +47,21 @@ Application basename
 
 ``<Route>`` components describing your route configuration
 
+### unstable_useTransitions
+
+Control whether router state updates are internally wrapped in
+[`React.startTransition`](https://react.dev/reference/react/startTransition).
+
+- When left `undefined`, all router state updates are wrapped in
+  `React.startTransition`
+- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
+  in `React.startTransition` and all router state updates are wrapped in
+  `React.startTransition`
+- When set to `false`, the router will not leverage `React.startTransition`
+  on any navigations or state changes.
+
+For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
+
 ### window
 
 [`Window`](https://developer.mozilla.org/en-US/docs/Web/API/Window) object

docs/api/declarative-routers/HistoryRouter.md

@@ -39,7 +39,12 @@ the same version of the `history` library that React Router uses internally.
 ## Signature
 
 ```tsx
-function HistoryRouter({ basename, children, history }: HistoryRouterProps)
+function HistoryRouter({
+  basename,
+  children,
+  history,
+  unstable_useTransitions,
+}: HistoryRouterProps)
 ```
 
 ## Props
@@ -56,3 +61,18 @@ Application basename
 
 A `History` implementation for use by the router
 
+### unstable_useTransitions
+
+Control whether router state updates are internally wrapped in
+[`React.startTransition`](https://react.dev/reference/react/startTransition).
+
+- When left `undefined`, all router state updates are wrapped in
+  `React.startTransition`
+- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
+  in `React.startTransition` and all router state updates are wrapped in
+  `React.startTransition`
+- When set to `false`, the router will not leverage `React.startTransition`
+  on any navigations or state changes.
+
+For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
+

docs/api/declarative-routers/MemoryRouter.md

@@ -32,6 +32,7 @@ function MemoryRouter({
   children,
   initialEntries,
   initialIndex,
+  unstable_useTransitions,
 }: MemoryRouterProps): React.ReactElement
 ```
 
@@ -53,3 +54,18 @@ Initial entries in the in-memory history stack
 
 Index of `initialEntries` the application should initialize to
 
+### unstable_useTransitions
+
+Control whether router state updates are internally wrapped in
+[`React.startTransition`](https://react.dev/reference/react/startTransition).
+
+- When left `undefined`, all router state updates are wrapped in
+  `React.startTransition`
+- When set to `true`, [`Link`](../components/Link) and [`Form`](../components/Form) navigations will be wrapped
+  in `React.startTransition` and all router state updates are wrapped in
+  `React.startTransition`
+- When set to `false`, the router will not leverage `React.startTransition`
+  on any navigations or state changes.
+
+For more information, please see the [docs](https://reactrouter.com/explanation/react-transitions).
+

docs/api/declarative-routers/Router.md

@@ -38,6 +38,7 @@ function Router({
   navigationType = NavigationType.Pop,
   navigator,
   static: staticProp = false,
+  unstable_useTransitions,
 }: RouterProps): React.ReactElement | null
 ```
 
@@ -71,3 +72,7 @@ or a custom navigator that implements the [`Navigator`](https://api.reactrouter.
 Whether this router is static or not (used for SSR). If `true`, the router
 will not be reactive to location changes.
 
+### unstable_useTransitions
+
+Whether this router should wrap navigations in `React.startTransition()`
+

docs/api/hooks/useLinkClickHandler.md

@@ -38,13 +38,15 @@ function useLinkClickHandler<E extends Element = HTMLAnchorElement>(
     preventScrollReset,
     relative,
     viewTransition,
+    unstable_useTransitions,
   }: {
     target?: React.HTMLAttributeAnchorTarget;
     replace?: boolean;
     state?: any;
     preventScrollReset?: boolean;
     relative?: RelativeRoutingType;
     viewTransition?: boolean;
+    unstable_useTransitions?: boolean;
   } = ,
 ): (event: React.MouseEvent<E, MouseEvent>) => void {}
 ```
@@ -81,6 +83,11 @@ The target attribute for the link. Defaults to `undefined`.
 Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) for this navigation. To apply specific styles during the transition, see
 [`useViewTransitionState`](../hooks/useViewTransitionState). Defaults to `false`.
 
+### options.unstable_useTransitions
+
+Wraps the navigation in [`React.startTransition`](https://react.dev/reference/react/startTransition)
+for concurrent rendering. Defaults to `false`.
+
 ## Returns
 
 A click handler function that can be used in a custom [`Link`](../components/Link) component.