/sticky

jQuery Plugin for Sticky Objects

Primary LanguageJavaScriptOtherNOASSERTION

Sticky

Sticky is a jQuery plugin that gives you the ability to make any element on your page always stay visible.

Sticky in brief

This is how it works:

  • When the target element is about to be hidden, the plugin will add the class className to it (and to a wrapper added as its parent), set it to position: fixed and calculate its new top, based on the element's height, the page height and the topSpacing and bottomSpacing options.
  • That's it. In some cases you might need to set a fixed width to your element when it is "sticked". Check the example-*.html files for some examples.

Usage

  • Include jQuery & Sticky.
  • Call Sticky.
<script src="jquery.js"></script>
<script src="jquery.sticky.js"></script>
<script>
  $(document).ready(function(){
    $("#sticker").sticky({topSpacing:0});
  });
</script>

  • Edit your css to position the elements (check the examples in example-*.html).

  • To unstick an object

<script>
  $("#sticker").unstick();
</script>

Options

  • topSpacing: Pixels between the page top and the element's top.
  • bottomSpacing: Pixels between the page bottom and the element's bottom.
  • className: CSS class added to the element's wrapper when "sticked".
  • wrapperClassName: CSS class added to the wrapper.
  • getWidthFrom: Selector of element referenced to set fixed width of "sticky" element.
  • responsiveWidth: boolean determining whether widths will be recalculated on window resize (using getWidthfrom).

Methods

  • sticky(options): Initializer. options is optional.
  • sticky('update'): Recalculates the element's position.

Events

  • sticky-start: When the element becomes sticky.
  • sticky-end: When the element returns to its original location

To subscribe to events use jquery:

<script>
  $('#sticker').on('sticky-start', function() { console.log("Started"); });
  $('#sticker').on('sticky-end', function() { console.log("Ended"); });
</script>