From da34ccda583030faeb0535e20e9608fafd3ba0e3 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Wed, 4 Nov 2020 21:33:26 +0100 Subject: [PATCH] docs: add behavior option to scrollBehavior --- docs/guide/advanced/scroll-behavior.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/guide/advanced/scroll-behavior.md b/docs/guide/advanced/scroll-behavior.md index 485abc9f1..a07159351 100644 --- a/docs/guide/advanced/scroll-behavior.md +++ b/docs/guide/advanced/scroll-behavior.md @@ -80,3 +80,18 @@ scrollBehavior (to, from, savedPosition) { ``` It's possible to hook this up with events from a page-level transition component to make the scroll behavior play nicely with your page transitions, but due to the possible variance and complexity in use cases, we simply provide this primitive to enable specific userland implementations. + +## Smooth Scrolling + +You can enable native smooth scrolling for [browsers supporting it](https://developer.mozilla.org/en-US/docs/Web/API/ScrollToOptions/behavior) by simply adding the `behavior` option to the object returned inside `scrollBehavior`: + +```js +scrollBehavior (to, from, savedPosition) { + if (to.hash) { + return { + selector: to.hash + behavior: 'smooth', + } + } +} +```