Skip to content
Make items sticky as you scroll, to a point.
JavaScript CSS
Find file
Latest commit 5959084 Feb 13, 2015 @davist11 Add license file
Failed to load latest commit information.
LICENSE.md Add license file Feb 13, 2015
README.md tweaks after pull request Oct 3, 2012
component.json update version number Oct 31, 2013
index.html initial commit Sep 10, 2012
jquery.js initial commit Sep 10, 2012
jquery.stickem.js update version number Oct 31, 2013
screen.css initial commit Sep 10, 2012

README.md

Make items sticky as you scroll, to a point. (See Demo)

Usage

<div class="container">
    <div class="row stickem-container">
        <div class="content">
            Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
        </div>
        
        <div class="aside stickem">
          I'm gonna be sticky!
        </div>
    </div>
</div>
.stickem-container {
  position: relative;
}

.stickit {
    margin-left: 660px;
    position: fixed;
    top: 0;
}

.stickit-end {
    bottom: 40px;
    position: absolute;
    right: 0;
}
$('.container').stickem();

Defaults

item: '.stickem'
Items that you want to stick on scroll.

container: '.stickem-container'
Container that you want the sticky item to be contained in.

stickClass: 'stickit'
Class added to the sticky item once it should start being sticky.

endStickClass: 'stickit-end'
Class added to the sticky item once it has reached the end of the container

offset: 0
Do you already have a fixed horizontal header on the page? Offset stick 'em by that many pixels.

start: 0
If your sticky item isn't at the top of the container, tell it where it should start being sticky.

onStick: null
You can create a callback function that fires when an item gets "stuck". The item gets passed back.

onUnstick: null
You can create a callback function that fires when an item gets "un-stuck". The item gets passed back.

Destroying

If you have a bunch of stuff that happens after your page has loaded (e.g. AJAX requests) that changes the height of your containers and page, and you need to "destroy" stick 'em, do it like this:

var sticky = $('.container').stickem();
sticky.destroy();

Then you can re-instantiate again if you need to.

Something went wrong with that request. Please try again.