Install with Bower
bower install --save scrollClass
Usage
Include jQuery
<script type="text/javascript" src="https://code.jquery.com/jquery-2.2.4.min.js"></script>
Include scrollClass
<script type="text/javascript" src="./dist/scrollClass.min.js"></script>
Options
- target (jQuery Object) [Default:
$(this)]
- The targeted element to change classes.
- offset (number | function) [Default
100]
- number - The number of pixels offset from the top of the document that determines when the CSS class passed in the class option will be toggled.
- function - A function that returns a number value representing the number of pixels offset from the top of the document that determines when the CSS class passed in the class option will be toggled.
- downClass (string) [Default
"progressing"]
- The class toggled on to the target element when the user is scrolling downward.
- upClass (string) [Default
"regressing"]
- The class toggled on to the target element when the user is scrolling upward.