Docs updates

remix-run · Nov 13, 2023 · 3ed602e · 3ed602e
1 parent 8a224b4
commit 3ed602e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/docs/hooks/use-fetcher.md b/docs/hooks/use-fetcher.md
@@ -107,7 +107,7 @@ function SomeComponent() {
 
 ## Methods
 
-## `fetcher.load(href, options)`
+### `fetcher.load(href, options)`
 
 Loads data from a route loader.
 
@@ -133,13 +133,15 @@ If you find yourself calling this function inside of click handlers, you can pro
 
 <docs-info>Any `fetcher.load` calls that are active on the page will be re-executed as part of revalidation (either after a navigation submission, another fetcher submission, or a `useRevalidator()` call)</docs-info>
 
-### `options.unstable_flushSync`
+#### `options.unstable_flushSync`
 
 The `unstable_flushSync` option tells React Router DOM to wrap the initial state update for this `fetcher.load` in a [`ReactDOM.flushSync`][flush-sync] call instead of the default [`React.startTransition`][start-transition]. This allows you to perform synchronous DOM actions immediately after the update is flushed to the DOM.
 
 <docs-warning>`ReactDOM.flushSync` de-optimizes React and can hurt the performance of your app.</docs-warning>
 
-## `fetcher.submit()`
+<docs-warning>Please note that this API is marked unstable and may be subject to breaking changes without a major release</docs-warning>
+
+### `fetcher.submit()`
 
 The imperative version of `<fetcher.Form>`. If a user interaction should initiate the fetch, you should use `<fetcher.Form>`. But if you, the programmer are initiating the fetch (not in response to a user clicking a button, etc.), then use this function.
 

diff --git a/docs/hooks/use-navigate.md b/docs/hooks/use-navigate.md
@@ -91,8 +91,12 @@ function EditContact() {
 
 The `unstable_flushSync` option tells React Router DOM to wrap the initial state update for this navigation in a [`ReactDOM.flushSync`][flush-sync] call instead of the default [`React.startTransition`][start-transition]. This allows you to perform synchronous DOM actions immediately after the update is flushed to the DOM.
 
+<docs-warning>`unstable_flushSync` only works when using a data router, see [Picking a Router][picking-a-router]</docs-warning>
+
 <docs-warning>`ReactDOM.flushSync` de-optimizes React and can hurt the performance of your app.</docs-warning>
 
+<docs-warning>Please note that this API is marked unstable and may be subject to breaking changes without a major release</docs-warning>
+
 ## `options.unstable_viewTransition`
 
 The `unstable_viewTransition` option enables a [View Transition][view-transitions] for this navigation by wrapping the final state update in `document.startViewTransition()`. If you need to apply specific styles for this view transition, you will also need to leverage the [`unstable_useViewTransitionState()`][use-view-transition-state].

diff --git a/docs/hooks/use-submit.md b/docs/hooks/use-submit.md
@@ -166,6 +166,8 @@ The `unstable_flushSync` option tells React Router DOM to wrap the initial state
 
 <docs-warning>`ReactDOM.flushSync` de-optimizes React and can hurt the performance of your app.</docs-warning>
 
+<docs-warning>Please note that this API is marked unstable and may be subject to breaking changes without a major release</docs-warning>
+
 [pickingarouter]: ../routers/picking-a-router
 [form]: ../components/form
 [flush-sync]: https://react.dev/reference/react-dom/flushSync