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

pick-element-overlay

v2.0.1

Published

Move an overlay around as user picks an element with a mouse

Downloads

1

Readme

pick-element-overlay

Move an overlay around as user picks an element with a mouse.

Install

$ yarn add pick-element-overlay

or

$ npm install pick-element-overlay

Usage

import { pickElement } from 'pick-element-overlay';

const picker = pickElement({
  mouseOver(target, overlay) {
    // Add styles and/or children to overlay here
  },
});

picker.finish.then((element) => {
  if (element) {
    // user picked element
  } else {
    // pick operation was canceled
  }
});

// cancels pick operation
picker.cancel();

API

pickElement(options = {})

options

type Options = {
  /**
   * Invoked when user mouses over an element. Optional, defaults to no-op.
   *
   * This is where the overlay can be styled. Probably don't change anything
   * related to its display, position, width, or height.
   *
   * @param target Element that was moused over
   * @param overlay Overlay element that is visible and positioned over target.
   */
  mouseOver?: (target: Element, overlay: HTMLElement) => void;
  /**
   * Invoked when user mouses out from an element. Optional, defaults to no-op.
   *
   * @param target Element that was moused-out from
   */
  mouseOut?: (target: Element) => void;
};

Returns

A picker object.

type Picker = {
  /**
   * Cancel the pick operation.
   */
  cancel: () => void;
  /**
   * Resolved with the picked element or null if the pick was canceled.
   */
  finish: Promise<Element | null>;
};

License

MIT