adriancbo / stickybits

Stickybits is a lightweight (~2KB) alternative to `position: sticky` polyfills 🍬

Make things get sticky …in a good way

---

---

StickyBits 🍬

Stickybits is a lightweight (~2KB) alternative to position: sticky polyfills. It works perfectly for things like sticky headers.

Stickybits is awesome because:

• it can add a CSS Sticky Class (.js-is-sticky) when position: sticky elements become active and a CSS Stuck Class (.js-is-stuck) when they become stuck. See useStickyClasses.
• it loosely mimics position: sticky to consistently stick elements vertically across multiple platforms
• it does not have the jumpiness that plugins that are built around position: fixed have because it tries to support position: sticky first.
• in its simplest use case, a scroll event listener will not be used if position: sticky is supported.
• it is super simple & lightweight (~2kb minified)

---

Installation   Setup   Usage   Feature   Options   Examples   Notes

---

Installing from a package manager

yarn

yarn add stickybits

npm

npm install stickybits --save

bower

bower install stickybits --save

Setup

Add dist/stickybits.min.js.

Basic Usage

stickybits('selector');

By default, a selected stickybits element will:

• Stick elements to the top of the viewport when scrolled to vertically.
• Stick elements at the bottom of their parent element when scrolled past.

useStickyClasses Feature

Stickybits allows customers to add CSS to elements when they become sticky and when they become stuck at the bottom of their parent element.

By default, if position: sticky is supported, StickyBits will exit allowing the browser to manage stickiness and avoid adding a scroll event listener.

If the useStickyClasses argument is set to true then even if a browser supports position: sticky, StickyBits will still add a scroll event listener to add and remove sticky CSS Classes. This option is available so that CSS styles can use when StickyBits elements become sticky or stuck at the bottom of their parent.

To use useStickyClasses:

stickybits('selector', {useStickyClasses: true});

Then, in css you can do:

.some-sticky-element .js-is-sticky {
  background-color: red;
}
.some-sticky-element .js-is-stuck {
  background-color: green;
}

View add css classes for more information on StickyBits CSS Classes.

Options

Vertical Layout Position

By default, a StickyBits element will stick to the top of the viewport when vertically scrolled to.

Stickybits loosely works for bottom positioning as well.

To have a StickyBits element stick to the bottom:

stickybits('selector', {verticalPosition: 'bottom'});

StickyBit Sticky Offset

By default, a StickyBits element will have a 0px sticky layout top offset. This means that the element will stick flush to the top of the viewport.

To have a StickyBits element stick with a 20px offset to its vertical layout position:

stickybits('selector', {stickyBitStickyOffset: 20});

StickyBits Cleanup

To cleanup an instance of Stickybits:

const stickybitsInstancetoBeCleanedup = stickbits('selector');
stickybitsInstancetoBeCleanedup.cleanup();

For jQuery and Zepto support, read in the jQuery notes below.

Examples

• Basic Usage
• Basic usage but with multiple instances of the same selector
• Custom vertical top offset ie: stickybits('selector', {stickyBitStickyOffset: 20})
• Custom vertical position ie: stickybits('selector', {customVerticalPosition: true})
• UseStickyClasses ie: stickybits('selector', {useStickyClasses: true})
• Clean Stickybits ie: const stickything = stickybits('selector'); stickything.cleanup();
• As a jQuery or Zepto Plugin ie: $('selector').stickybits();

---

Have another example or question? Feel free to comment. 🙌

Notes

CSS Class Usage

3 CSS classes will be added and removed by Stickybits if position: sticky is not supported or if the useStickyClasses: true option is added to the plugin call.

• js-is-sticky if the selected element is sticky.
• js-is-stuck if the selected element is stopped at the bottom of its parent.
• js-stickybit-parent so that styles can easily be added to the parent of a Stickybits element

Not a Polyfill

We strayed away from calling Stickybits a Shim or Polyfill for position: sticky because full support would require more code. This plugin simply makes elements vertically sticky very similarly to position: fixed but in a sticky sort of way. Read more about position sticky here or follow its browser implementation here.

jQuery and Zepto Usage

Basic

$('selector').stickybits();

With useStickyClasses

$('selector').stickybits({useStickyClasses: true});

With customVerticalPosition

$('selector').stickybits({customVerticalPosition: true});

With stickyBitStickyOffset

$('selector').stickybits({stickyBitStickyOffset: 20});

Thanks

This plugin was heavily influenced by Filament Group's awesome Fixed-sticky jQuery plugin. Thanks to them for getting my mind going on this a while back. Thanks to Peloton Cycle's Frame Throttle for an insightful solve for optimizing frame throttling.