Vue2 Smooth Scroll



Lightweight Vue plugin for smooth-scrolling extended from vue-smooth-scroll.

For simple use-cases, the native scroll-behavior CSS property (working draft) may be enough.

This package compatible with Vue 2.x and Vue 1.x

New package for Vue 3.x use this package v-smooth-scroll

Features

- Directive and programmatic API with global and local config overrides
- SSR
- Smooth, non-blocking animation using requestAnimationFrame (with fallback)
- Y-axis or vertical scrolling
- Specific scroll containers
- 1.3kB gzipped, 2.9kB min

Installation

`` bash
npm install --save vue2-smooth-scroll
`

` js
import VueSmoothScroll from 'vue2-smooth-scroll'
Vue.use(VueSmoothScroll)
`




Usage

$3

` html
Section 3

`

$3

` js
const myEl = this.$refs.myEl || this.$el || document.getElementById(...)

this.$smoothScroll({
scrollTo: myEl,
hash: '#sampleHash' // required if updateHistory is true
})
`

$3


` html

Let's go to #bottom!

bottom





`




Custom options

$3

` js
{
duration: 500, // animation duration in ms
offset: 0, // offset in px from scroll element, can be positive or negative
container: '', // selector string or Element for scroll container, default is window
updateHistory: true // whether to push hash to history
easingFunction: null // gives the ability to provide a custom easing function t => ...
// (see https://gist.github.com/gre/1650294 for examples)
// if nothing is given, it will defaults to easeInOutCubic
}
`

$3

` js
import VueSmoothScroll from 'vue2-smooth-scroll'

Vue.use(VueSmoothScroll, {
duration: 400,
updateHistory: false,
})
`

$3


` html

Anchor

`

$3

` js
this.$smoothScroll({
scrollTo: this.$refs.myEl,
duration: 1000,
offset: -50,
})
``

License

MIT

Contributors ✨

Thanks goes to these wonderful people (emoji key):

James 💻

a-kriya 💻 🐛 📖

This project follows the all-contributors specification. Contributions of any kind welcome!