Git Product home page Git Product logo

track-scrolling's Introduction

Track Scrolling

A small library for tracking the scroll of the user in the browser and having a callback run on scroll percentages sent.

/*
 * Log to the console whenever the document.body element
 * enters one of the defined percentages .
 */
TrackScrolling([20, 30, 60, 90], (percentageReached) => console.log("Percentage Scrolled:", percentageReached));


Table of Contents
-----------------

  * [Requirements](#requirements)
  * [Usage](#usage)


Requirements
------------
a normal npm package can be used with webpack.

Usage
-----

Track Scrolling is easiest to use when installed with [npm]:

```sh
npm install track-scrolling

Then you can import it import TrackScrolling from "track-scrolling";

It takes following params

  • scrollDepths an Array of depths you want to be tracked and have your callback called on.
  • callBack the callback to be called when certain percentages are reached when scrolling.
  • returnError a boolean to send if you want any error to be returned.

track-scrolling's People

Contributors

cutjavascript avatar

Watchers

 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.