light-smooth-scroll v1.0.1

light-smooth-scroller

A very light no nonsense javascript scroller, with smooth option. No dependencies, 2.5~KB Size.

Features

* Super fast and only getting faster.
* Very light and only getting lighter.
* No Dependencies and never getting any.

Install

# Using npm
npm install light-smooth-scroller

# Using yarn
yarn add light-smooth-scroller

You can now include light-smooth-scroller and you are all set!

// es6
import { SmoothScroller } from 'light-smooth-scroller';

// commonjs
const SmoothScroller = require('light-smooth-scroller');

Usage

Javascript:

let scroller = new SmoothScroller({
    selector: '.scroll',
    header: 'navbar',
    definedOffset: 30,
    smooth: true,
});

HTML:

<a id="top" target="bottom" class="scroll">
    Click me!
</a>
<a id="bottom" target="top" class="scroll">
    Click me!
</a>

Options

light-smooth-scroller supports 4 options, 3 which are optional

• selector - class / id (Required - Must be a valid class name or ID of element) - No Default Selector
• header - class (Optional - Select the class of your fixed header to calculate needed padding for scroll) - Default: none
• definedOffset - number (Optional - If you want to add more offset to the scroll) - Default: 0
• smooth - boolean (Optional - Defines if you want smooth scrolling or not) - Default: true

let scroller = new SmoothScroller({ selector: '.scroll', header: 'navbar', definedOffset: 30, smooth: true, });