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

@warp-works/warpjs-action-plugin

v2.0.2

Published

Base action plugin class

Downloads

14

Readme

WarpJS Action Plugin

This is the base "abstract" class for action plugins.

See warpjs-plugin for base plugin documentation.

API

These are the additional API on top of the warpjs-plugin.

.jsScriptUrl

This getter returns the URL of the javascript file to be added to the <script src>.

If you want to stay on the current page, this getter should return a URL, and the script should handle a click on this action. Something like this:

(($) => $(document).ready(() => {
  $(document).on('click', `[data-warpjs-plugin-identifier="your-identifier"]`, function(e) {
    // Code to open a modal and deal with all the events.
  });
}))(jQuery);

If you want the click to bring you to the path defined in the plugins' configuration path, the getter should return a falsy value.

The your-identifier is generated from .pluginIdentifier.

.getRootUrl(domain, type, id)

Returns the URL to use to handle the current element. This implementation is only needed if .jsScriptUrl getter is not falsy. This value will be set into the element clicked (see .jsScriptUrl).

$(this).data('warpjsPluginRootUrl');

.toJSON(domain, type, id)

Get the JSON of the action plugin.