jQuery StickMe Plugin

Description

jQuery StickMe Plugin gives the control to make any element on a website fixed on a certain scroll position of the document page wherever and whenever it needs. It's easy to setup with the given options and it's also a great module to interact with due to its methods and callback events.

Demo

I. General initialization

I am just a simple note.

This note above have"stickme" class which is the plugin's target by default. It will stick on the top of the viewport when initializeStickMe in the most basic way:

// like this
    $.stickme();
    // or like this
    var stickedItems = $.stickme();

Now they can be unsticked by triggering the destroy method:

// like this
    $.stickme().destroy();
      // or like this
      stickedItems.destroy();

II. Method initialization

I am a static note.

This note above has an ID called"method-note" and we will use that name for the jQuery selector. We would like to stick the note 10px under the top of the viewport when it hits that position and also to change its text and background color in the context of its position mode.

$('#method-note').stickme({
      top: 10,
    }).bind('onStick', function() {
      $(this)
        .addClass('orange')
        .text('I am a fixed note.');
    }).bind('onUnstick', function() {
      $(this)
        .removeClass('orange')
        .text('I am a static note.');
    });

Getting Started

You can download the plugin as an archive.

Or you can grab it by using npm:

npm install stickme

Or you can grab it by using Bower:

bower install stickme

Installation

Include the script after the jQuery library (unless you package scripts otherwise):

<script src="/path/to/stickme.min.js"></script>

Usage

Initialization

Please keep in mind that DOM elements you would like to be fixed at some point are better to stay clean of any styles which might influence their positions (float, margin…). A good practice would be having a clean, wrapping child element inside of the desired target only for StickMe purposes.

Now, there are two ways of initializing StickMe:

I. jQuery function

The first way is as follows:

$.stickme(); // returns the target

This is the most basic initialization. By calling it so, the plugin will look for any element that has a "stickme" class. If no such elements, nothing will happen.

Of course, you can also provide specific target/s with a custom selector by doing so:

$.stickme({
    target: $('selector') 
});

II. Method function

The second way is as an object method. So, we can also use the plugin this way:

$('selector').stickme(); // returns the target

Options

target

Defines a custom target selector.

The target property is only available when initialize StickMe as a jQuery function like the example below.

$.stickme({
    target: $('selector') 
});

top

Defines an offset from the top of the viewport.

$('selector').stickme({
    top: 10
});

Methods

update()

Updates the styles of the target when it's in a fixed position.

var stickedElement = $('selector').stickme();

stickedElement.update();

destroy()

Removes StickMe from the target.

var stickedElement = $('selector').stickme();

stickedElement.destroy();

Events

There are two ways of binding StickMe events.

1. As option properties:

$('selector').stickme({
    onStick: function(e, target) {
        // do something
    },
    onUnstick: function(e, target) {
        // do something
    }
});

2. As jQuery events:

$('selector').stickme()
    .bind('onStick', function(e, target) {
        // do something
    })
    .bind('onUnstick', function(e, target) {
        // do something
    });

And here are all available events:

onStick

Triggers when the target is being switched to fixed position.

var stickedElement = $('selector').stickme();

stickedElement.bind('onStick', function(e, target) {
    // do something
});

onUnstick

Triggers when the target is being switched to static position.

var stickedElement = $('selector').stickme();

stickedElement.bind('onUnstick', function(e, target) {
    // do something
});

onDestroy

Triggers when StickMe is being removed from the target.

var stickedElement = $('selector').stickme();

stickedElement.bind('onDestroy', function(e, target) {
    // do something
});

Browsers compatibility

Apple Safari
Google Chrome
Microsoft Internet Explorer 9+
Mozilla Firefox
Opera

Dependencies

jQuery