ohhai
v1.1.3
Published
Add class to images when they enter the viewport
Downloads
2
Maintainers
Readme
oh hai
Add class to element once it enters the viewport.
Usage
Install via NPM
npm install --save-dev ohhai
Include jQuery and ohhai.js:
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="/node_modules/ohhai/ohhai.min.js"></script>
<script src="/js/main.js"></script>
Initialize in your .js file:
// main.js
$('.fade-on-scroll').ohhai();
// Or change the options
$('.fade-on-scroll').ohhai({
triggerOffset: 200
inViewClass: 'visible'
});
Works with require
as well:
var ohhai = require('ohhai');
$('.fade-on-scroll').ohhai();
// Or change the options
$('.fade-on-scroll').ohhai({
triggerOffset: 200
inViewClass: 'visible'
});
Options
| Option | Type | Default | Description |
|-------------------|------|------------|-------------|
| elTrigger | str | top
| top
or bottom
. The point of the element that determines if it is in the viewport. |
| triggerOffset | int | 0 | Pixel amount that will be scrolled before trigger occurs |
| inViewClass | str | 'visible'
| The class that is added to visible elements. |