diva-js
v1.0.7
Published
Lets you know when elements are in view.
Downloads
1
Readme
diva.js
Let's you know when elements have scrolled into view in 3kb.
##Example
<script src="diva.min.js"></script>
<script>
diva.always('.test', {offset: '10%'}, function() {
console.log('test is in view!');
});
</script>
##API
###once(selector, opts, callback)
Calls callback
when selector
has scrolled into view once, then calls destroy
selector, string or object, accepts a class or id
opts, object
offset, string, Adjusts the screen boundary to the given offset
callback, function
###always(selector, opts, callback)
Calls callback
when selector
has scrolled into view
selector, string or object, accepts a class or id
opts, object
offset, string, Adjusts the screen boundary to the given offset
callback, function
###sometimes(selector, opts, callback)
After count
times selector
has scrolled into view, destroy
is called
selector, string or object, accepts a class or id
opts, object
count, integer
offset, string, Adjusts the screen boundary to the given offset
callback, function
###destroy(element)
Removes element
from the event list
element, string or object, If string is supplied, looks for a selector. If object is supplied, looks for an element
##Licence
The MIT License (MIT)
Copyright (c) 2016 Red Lion Canada
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.