Skip to content

Latest commit

 

History

History
43 lines (25 loc) · 1.47 KB

README.markdown

File metadata and controls

43 lines (25 loc) · 1.47 KB

Element Onscreen Visibility

This is a jQuery plugin which allows us to quickly check if an element is within the browsers visual viewport, regardless of the scroll position. If a user can see this element, the function will return true.

Documentation

Basic visibility check

This basic check will return true if the entire element is visible to the user (within the visual viewport).

$('#element').visible();

If you'd like to check for ANY PART of the element, you can use the following:

$('#element').list( true );

The plugin ignores the elements visibility. E.g., display:none, visibility: hidden, offsetWidth or offsetHeight is 0). To filter on css visibility, you can use the jQuery :visible selector:

$('#element:visible').visible();

Demos

The Demos for this plugin live under the examples/ directory. Open them directly in your web browser, or view the following online examples:

See the blog article:

Limitations

Currently the plugin only checks for vertical positioning and scroll. We're planning on adding horizontal support soon, with the ability to optionally run the check on horizontal, vertical or both planes.