Giter Club home page Giter Club logo

autoscroll.js's Introduction

Codacy Badge npm Gitter

autoscroll.js

Auto Scroll is a Jquery plugin which is used to auto-scroll your content smoothly . It is less than 1KB when minified.

##How To use Auto Scroll

It is very easy to install, just copy and paste the autoscroll.js in your js root folder and then initialize its path in your html file. It's better to initialize it in head tag.

<head>
 <script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha256-cCueBR6CsyA4/9szpPfrX3s49M9vUU5BgtiJj06wt/s=" crossorigin="anonymous"></script>

 <script src="path/to/autoscroll.js"></script>
</head>

*** Dependency : It depends on jquery. So initialize jquery before autoscroll.js***

Download autoscroll.js

##Using npm

npm install autoscroll.js

##Install using bower

bower install autoscroll.js

#General Notes

##Initialize ###With jQuery

$('element').scroller();

###With vanilla JavaScript

var scroll = new Scroller('{"element" : element }');

###With HTML Add a data-config attribute to your element and a class scroller. Options can be set in JSON in the value.

<div class="scroller" id="id-1" data-config='{ "amount": 150, "delay": 1500 }'>
  <div class="item"></div>
  <div class="item"></div>
  ...
</div>

Note: element can be id or class or any html tag

##Default options

{"amount" : 100 , "delay" : 2000 } //2000ms and 100px

##Add your options

{"amount" : 200 , "delay" : 1500 }

#Example for a div tag having id named "id-1"

<div id="id-1"></div>

you can initialize it like this

$("#id-1").scroller('{"amount" : 150, "delay" : 1500 }');

OR

var scroll = new Scroller('{"element" : "#id-1", "amount" : 150, "delay" : 1500 }');

OR

By using HTML

<div class="scroller" id="id-1" data-config='{ "amount": 150, "delay": 1500 }'>
  <div class="item"></div>
  <div class="item"></div>
  ...
</div>

#License Copyright (c) 2016 Ankit Jain - Released under the MIT License

Run this script in your browser... Enjoy Cheers !!

autoscroll.js's People

Contributors

ankitjain28may avatar ctoicqtao avatar itaditya avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.