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

jquery-plugin-events

v0.0.1

Published

jQuery event helper functions

Downloads

5

Readme

jQuery Plugin Events

An event helper class written with TypeScript for the jQuery Plugin Boilerplate It contains generic functions that simplify event handling within all kinds of plugins

Naming convention

The naming convention pattern should be: [?prefix].[action].[?area].[pluginName]

  • prefix (optional) - the prefix mostly describes the temporal state like before or after
  • action - this is the most important part of the event name. It describes the action of that specific event
  • area (optional) - if the action is not global or clear on its own, add an area where this action occurs.
  • pluginName - surprise surprise.... this is the name of the plugin

Examples

  • init.slider
  • slide.carousel
  • after.init.accordion
  • change.header.table
  • before.slide.carousel
  • after.change.header.table

wrapEvents

This static function is used to automatically wrap jQuery events before and after a given function. Because it uses jQuery Events you can stop the ongoing process within the initial before event by setting event.preventDefault()

Parameters

  • $element - the jQuery element on which the event is fired
  • eventName - the desired event name excluding the before/after prefixes
  • fn - the function
  • params (optional) - optional params that will be added to the events

Example

import EventHelper from npm package

import EventHelper from "jquery-plugin-events";

wrap events around the method

EventHelper.wrapEvents('action.pluginName', () => {
	console.log('action goes here');
}, this.$element, this, ['some param']);

catch before and after event on the given element

this.$element.on('before.action.pluginName', (e) => {
	console.log('before action');
	// prevent method and after-event of being executed
	// e.preventDefault();
});

this.$element.on('after.action.pluginName', () => {
	console.log('after action');
});