search

ocordeiro / vue-smooth-scroll

Simple vue smooth scroll
77 stars 12 forks source link

readme

Vue Smooth Scroll

Simple vue smooth scroll based on vue-smoothscroll https://github.com/Teddy-Zhu/vue-smoothscroll/blob/master/README.md

Instalation

# install dependency
npm install --save vue-smooth-scroll
// import on your project (less then 1KB gziped)
import vueSmoothScroll from 'vue-smooth-scroll'
Vue.use(vueSmoothScroll)

Usage

<a href="#div-id" v-smooth-scroll>Anchor</a> 
<div id="div-id"></div>

Custom options

Defaults

  {
    duration: 500, // Animation speed
    offset: 0, // Offset from element, you can use positive or negative values
  }

Example:

<a href="#div-id" v-smooth-scroll="{ duration: 1000, offset: -50 }">Anchor</a> 
<div id="div-id"></div>

Without Browserify or Webpack

<body>
  <div id="app">
    <a href="#app" v-smooth-scroll>Anchor</a>
  </div>
  <script src="https://unpkg.com/vue/dist/vue.js"></script>
  <script src="https://unpkg.com/vue-smooth-scroll@1.0.11"></script>
  <script>
  Vue.use(VueSmoothScroll)
  var app = new Vue({
    el: '#app',
    data: {
      message: 'Hello Vue!'
    }
  })
</script>
</body>