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

sticky-events-listener

v1.0.0

Published

Events listeners for position sticky, without an onscroll listener.

Downloads

6

Readme

Sticky Events Listener

Events listeners for position: sticky, without an onscroll listener.

Installation

npm i sticky-events-listener --save

Credit

This is essentially a fork from Ryan Walters original Sticky Events. All I've done is refactor the code to work as a standalone ES6 Class. With only a couple minor tweaks.

Requires

ES6 Support Relies on position: sticky and IntersectionObserver support.

Usage

When you declare the initial Sticky Events class, there are two optional parameters you can pass in.

First, is an object of elements that you know to be sticky. The event handler will callback when the sticky state updates. The selector class will automatically be added to each elements if it isn't already defined.

Second, is an object of options that be be configured at your discretion. The defaults are as follows:

events : {
  change  : 'sticky-change',
  stuck   : 'sticky-stuck',
  unstuck : 'sticky-unstuck'
},
sentinels : {
  sentinel : 'sticky-sentinel',
  top      : 'sticky-top-sentinel',
  bottom   : 'sticky-bottom-sentinel'
},
selector : '.sticky',
container : document

There are some checks that will permit you to pass in the options as the first parameters instead of the elements. So you can do any of the following:

const sticky = new StickyEvents(stickyElements);
const sticky = new StickyEvents(stickyElements, {...});
const sticky = new StickyEvents({...});

Example

The following examples assume you are using jQuery. However, the core class can be used independently from jQuery.

let stickyElements = $('search-bar, nav');

const sticky = new StickyEvents(stickyElements);

stickyElements.each((index, element) => {

  let ele = $(element);

  ele.on(sticky.change, (event) => {
   console.log(element.nodeName.toLowerCase(), event.detail.isSicky)
  });

  ele.on(sticky.stuck, (event) => {
    ele.addClass('stuck').removeClass('unstuck')
  });

  ele.on(sticky.unstuck, (event) => {
    ele.addClass('unstuck').removeClass('stuck')
  });
});