KevinHoughton / vue-scroll-to

Adds a directive that listens for click events and scrolls to elements.

vue-scroll-to

Vue.js directive that listens for click events and scrolls to elements.

Install

With npm do:

$ npm install vue-scroll-to --save

or

$ yarn add vue-scroll-to

Usage

Please note that it's necessary to use single quotes within the double quotes of the directive when defining the class and padding.

import Vue from 'vue';
import vueScrollTo from 'vue-scroll-to';

Vue.use(vueScrollTo, options);

<a href="#" v-scroll-to="'.element, 50px'">Scroll to .element</a>

<div class="element">
    Hi. I'm element.
</div>

Variables in directive

v-scroll-to="'<element>, <padding-in-px>'"

Default:

• padding-in-px: 0

Settings

Default options:

• speed = 500 - Animation speed.
• padding = 0 - You can set default global padding, which will override when put padding-in-px value inline with v-scroll-to.
• movingFrequency = 15 = Number of steps of animation.

License

MIT