jquery.modern.inview

Event that is fired as soon as an element appears in the user's viewport.

Author: Takehiko Ono
Forked from: Protonet (https://github.com/protonet/jquery.inview/)
Based on the idea of: Remy Sharp (http://remysharp.com/2009/01/26/element-in-view-event-plugin/)

Requires

jQuery 1.8+ (https://github.com/jquery/jquery)
setAnimationFrameTimeout (https://github.com/onopko/setAnimationFrameTimeout)

<script src="jquery.min.js"></script>
<script src="setAnimationFrameTimeout.min.js"></script>
<script src="jquery.modern.inview.min.js"></script>

Usage

$('div').on('inview', function(event, isInView) {
	if (isInView) {
		// element is now visible in the viewport
	}
	else {
		// element has gone out of viewport
	}
});

To stop listening for the event - simply unbind:

$('div').off('inview');

If you would like the event only to trigger once per element while the page is loaded, you can use the .one() method instead of .on():

$('div').one('inview', ...);

options

jquery.modern.inview accepts offsetLeft • OffsetRight • offsetTop • offsetBottom properties. Each value can be took Number (px) or String (%) type.

offsetLeft (Default: 0)
OffsetRight (Default: 0)
offsetTop (Default: 0)
offsetBottom (Default: 0)

$('div').on('inview', { offsetLeft: 30, OffsetRight: 0, offsetTop: '-10%', offsetBottom: 0 }, function(event, isInView) {
	if (isInView) {

	}
	else {

	}
});

Recommended Browser Compatibility

Safari 8+
Google Chrome 20+
Firefox 15+
Opera 15+
Edge 12+
IE 10+
iOS 9.2+
Android 4.4+

License

The MIT License (MIT)

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.