From: Lindsay Gaines <hello@lindsaygain.es>
Date: Tue, 18 May 2021 13:45:29 +0000 (+1000)
Subject: docs: add scrollBehavior API detail and link to guide (#954)
X-Git-Tag: v4.0.9~43
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1544f4e2705b4aa584303b50609f9e9200191d94;p=thirdparty%2Fvuejs%2Frouter.git

docs: add scrollBehavior API detail and link to guide (#954)

* docs: add scrollBehavior API detail and link to guide

* Update docs/api/index.md

Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>
---

diff --git a/docs/api/index.md b/docs/api/index.md
index f708c3ff..c0ba0e15 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -746,12 +746,12 @@ routes: RouteRecordRaw[]
 
 ### scrollBehavior
 
-Function to control scrolling when navigating between pages. Can return a Promise to delay scrolling. Check .
+Function to control scrolling when navigating between pages. Can return a Promise to delay when the scrolling happens. See [Scroll Behaviour](../guide/advanced/scroll-behavior.md) for more details.
 
 **Signature:**
 
 ```typescript
-scrollBehavior?: ScrollBehavior
+scrollBehavior?: RouterScrollBehavior
 ```
 
 #### Examples