README.html

<h1>jquery-scrolltracker</h1>

<p>A jQuery plugin that tracks designated elements' scroll position relative to the viewport, and adds CSS classes to the element(s) describing the current position. Great for adding CSS transitions to elements as they appear/disappear from view.</p>

<h2>Demo</h2>

<p><a href="https://rusackas.github.io/jquery-scrolltracker/demos/vertical/index.html">Vertical scrolling demo</a></p>

<p><a href="https://rusackas.github.io/jquery-scrolltracker/demos/horizontal/index.html">Horizontal scrolling demo</a></p>

<h2>Installation</h2>

<p>To install, copy the javascript file into your project and add it in the header like so:</p>

<pre><code>&lt;script src="https://ajax.googleapis.com/ajax/libs/jquery/2.0.2/jquery.js" type="text/javascript"&gt;&lt;/script&gt;
&lt;script src="jquery.scrolltracker.js" type="text/javascript"&gt;&lt;/script&gt;
</code></pre>

<p>Then, in your site&rsquo;s main javascript file, initialize the plugin with jQuery selector(s) of the elements you&rsquo;d like to track, like so:</p>

<pre><code>$(function () {
  $.scrolltracker('div.watchme, div.thistoo');
});
</code></pre>

<p>By default, the plugin tracks vertical scrolling. You can override that to track horizontal position by setting the &ldquo;direction&rdquo; option like so:</p>

<pre><code>$(function () {
  $.scrolltracker('#trackthis',{direction:"horizontal"});
});
</code></pre>

<p>You can also set the direction to &ldquo;both&rdquo; if you want to track elements on both axes.</p>

<p>As you scroll your page, the element(s) will have CSS classes added reflecting their position relative to the viewport:</p>

<p><strong>Vertical statuses</strong> <a href="https://rusackas.github.io/jquery-scrolltracker/demos/vertical/index.html">See demo</a>
* onscreen_vert = element contained completely in the viewport, not cut off on the top or bottom
* offscreen_vert = element is completely offscreen, not at all in the viewport
* overflowing_vert = element is onscreen, but does not fit in the viewport, and is cropped off on both the top and bottom
* onfromtop = element is partly onscreen, partly cropped off at the top of the viewport
* onfrombottom = element is partly onscreen, partly cropped off at the bottom of the viewport</p>

<p><strong>Horizontal statuses</strong> <a href="https://rusackas.github.io/jquery-scrolltracker/demos/horizontal/index.html">See demo</a>
* onscreen_horiz = element contained completely in the viewport, not cut off on the left or right
* offscreen_horiz = element is completely offscreen, not at all in the viewport
* overflowing_horiz = element is onscreen, but does not fit in the viewport width, and is cropped off on both the left and right
* onfromleft = element is partly onscreen, partly cropped off at the left of the viewport
* onfromright = element is partly onscreen, partly cropped off at the right of the viewport</p>

<p>You can then use these classes in your CSS to style/animate elements according to their position quite easily.</p>

<h2>Copyright</h2>

<p>Copyright &copy; Evan Rusackas. See LICENSE for details.</p>

<p><a href="http://www.rusackas.com">http://rusackas.com</a></p>