npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

stickme

v1.3.0

Published

Fixed elements depending on the scroll position

Downloads

14

Readme

jQuery StickMe Plugin

Fixed elements depending on the scroll position.

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

stickme.mev.bg

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

License

Copyright © 2017 Martin Metodiev. Licensed under the MIT license. See here for more details.