Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

scrolldir

Package Overview
Dependencies
Maintainers
1
Versions
32
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

scrolldir

Track user scroll direction without jitter

  • 0.0.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
535
decreased by-0.74%
Maintainers
1
Weekly downloads
 
Created
Source

Build Status

ScrollDir 🔺||🔻

ScrollDir is a micro Javascript library that perfectly describes user vertical scroll direction in a html data attribute. From there, do what want. 💪

ScrollDir is perfect for:

  • showing or hiding sticky elements based on scroll direction.
  • tracking events on scroll direction
  • ignoring small scroll movements that cause unwanted element jitters.
  • Scrolldir will only change direction when the user scrolls a significant vertical amount.

Installing from a package manager 🌴

npm

npm install scrollDir --save

bower

bower install scrollDir --save

yarn

yarn add scrolldir 

Setup

Add dist/scrolldir.min.js.

Basic Usage

scrollDir();

By default ScrollDir will set the data-scrolldir attribute on the <html> element to up or down:

<html data-scrolldir="up">

or

<html data-scrolldir="down">

You can then change your styling based on vertical scroll direction.

[data-scrolldir="down"] .my-fixed-header { display: none; }

Options

To use an attribute besides data-scrolldir:

scrollDir({attribute: 'new-attribute-name'});

To add the Scrolldir attribute to a different element:

scrollDir({el: 'your-new-selector'});

To turn Scrolldir off:

scrollDir({off: true});

Examples 🌴

This is a modular version of pwfisher's scroll-intent. ~TY!

Keywords

FAQs

Package last updated on 11 Jan 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc