Leverage Vertical Scroll Direction with CSS 😎
ScrollDir, short for Scroll Direction, is a 0 dependency, ~1kb micro Javascript plugin to easily leverage vertical scroll direction in CSS via a data attribute. 💪
ScrollDir will set the data-scrolldir attribute on the <html> element to up or down:
<html data-scrolldir="up"></html>
or
<html data-scrolldir="down"></html>
Now it’s easy to change styles based on the direction the user is scrolling!
[data-scrolldir="down"] .my-fixed-header {
display: none;
}
npm
npm install scrolldir --save
bower
bower install scrolldir --save
yarn
yarn add scrolldir
Add dist/scrolldir.auto.min.js and you’re done. There is nothing more to do! Scrolldir will just work.
Now go write some styles using [data-scrolldir="down"] and [data-scrolldir="up"].
Add dist/scrolldir.min.js. You have access to the API options below and must invoke scrollDir.
scrollDir();
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 });
To turn provide a different scroll direction on page load (or app start):
scrollDir({ dir: "up" }); // the default is 'down'
To change the thresholdPixels—the number of pixels to scroll before re-evaluating the direction:
scrollDir({ thresholdPixels: someNumber }); // the default is 64 pixels
// example: scrollDir({ thresholdPixels: 10 })
This is a modular version of pwfisher's scroll-intent. If you'd like to use scrolldir with jQuery—use Scroll Intent. Scrolldir should work easily within any front-end framework so it ditches library dependencies. ~TY!
FAQs
Vertical scroll direction in CSS
The npm package scrolldir receives a total of 363 weekly downloads. As such, scrolldir popularity was classified as not popular.
We found that scrolldir demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.