https://github.com/kyleconrad/jquery-stick

Easy jQuery plugin to stick elements when you scroll.
https://github.com/kyleconrad/jquery-stick

Last synced: about 2 months ago
JSON representation

Easy jQuery plugin to stick elements when you scroll.

• Host: GitHub
• URL: https://github.com/kyleconrad/jquery-stick
• Owner: kyleconrad
• Created: 2013-01-09T01:37:57.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-01-09T02:09:45.000Z (about 12 years ago)
• Last Synced: 2024-04-14T22:53:30.295Z (9 months ago)
• Language: JavaScript
• Size: 109 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
jquery-stick

============

Easy jQuery plugin to stick elements when you scroll. Simply adds a default class called "stick" to the named element when the top of the window hits the element, then removes "stick" and replaces it with "stick-end" when the bottom of the named element hits the bottom of its container (default: ".container").

Usage

============

$('.block').stick();

Calls for the "stick" plugin on ".block" using default values.

Advanced Usage

============

Default values of options:

$('.block').stick({

  offset: 0,

  bottompadding: 0,

  container: '.container',

  stickyclass: 'stick',

  endclass: 'stick-end'

});

Description of options:

"offset" - number of pixels above element to call the stickyclass to be added to the element.

"bottompadding" - number of pixels below element (within the container) to remove the stickyclass and replace it with the endclass.

"container" - the container that holds your element that you want it to be referenced against (make sure to have the leading period).

"stickyclass" - the class to be added when sticky (be sure not to have the leading period).

"endclass" - the class to be added once the element has reached the end of the container (be sure not to have the leading period).

License

============

Dual licensed under MIT and GPL. Feel free to clone, modify, and use at will, as you see fit. If used in commercial projects, just let me know with a note, tweet, or email. Thanks!

Contact

============

Kyle Conrad - [email protected] - http://www.kyleconrad.com - @kyle_conrad