Add documentation about lazily evaluating "preserveScroll"

LucaRed · Jan 2, 2021 · 0047a8b · 0047a8b
1 parent 5adbb52
commit 0047a8b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/pages/manual-visits.mdx b/pages/manual-visits.mdx
@@ -221,6 +221,14 @@ When navigating between pages, Inertia mimics default browser behaviour by autom
 Inertia.visit(url, { preserveScroll: true })
 ```
 
+You can also lazily evaluate the `preserveScroll` option based on the response by providing a callback.
+
+```js
+Inertia.post('/users', data, {
+  preserveScroll: (page) => Object.keys(page.props.errors).length,
+})
+```
+
 For more information, see the [scroll management](/scroll-management) page.
 
 ## Partial reloads

diff --git a/pages/scroll-management.mdx b/pages/scroll-management.mdx
@@ -26,7 +26,15 @@ Sometimes it's desirable to prevent the default scroll resetting when making vis
 Inertia.visit(url, { preserveScroll: true })
 ```
 
-This is also possible with [Inertia links](/links) using the `preserve-scroll` attribute.
+You can also lazily evaluate the `preserveScroll` option based on the response by providing a callback.
+
+```js
+Inertia.post('/users', data, {
+  preserveScroll: (page) => Object.keys(page.props.errors).length,
+})
+```
+
+You can also preserve the scroll position with [Inertia links](/links) using the `preserve-scroll` attribute.
 
 <TabbedCodeExamples
   examples={[