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

detect-hover

v1.0.3

Published

JavaScript wrapper for hover and any-hover media queries

Downloads

232,221

Readme

Detect Hover

JavaScript wrapper for hover and any-hover media queries.

Live detection test

Exports a reference to a singleton object (a micro state machine with an update function) with its state set to the results of the hover and any-hover media queries, as well as an update() function which re-runs the tests and updates the object's state.

Note that detect-hover is one of the micro state machines used by detect-it to determine if a device is mouseOnly, touchOnly, or hybrid.

For more information on the hover and any-hover media queries, please see the W3C Media Queries Level 4 specification. For information on browser compatibility, please see Can I Use matchMedia.

detectHover micro state machine

const detectHover = {
  // mutually exclusive (only one will be true)
  hover: boolean,
  none: boolean,

  // not mutually exclusive
  anyHover: boolean,
  anyNone: boolean,

  // re-run all the detection tests and update state
  update() {...},
}

Installing detect-hover

$ npm install detect-hover

Using detect-hover

import detectHover from 'detect-hover';
// using the state
detectHover.hover === true; // primary pointing system can hover
detectHover.none === true; // primary pointing system can’t hover, or there is no pointing system

/*
 * identical to the hover media feature, but they correspond to the
 * union of capabilities of all the pointing devices available to the user -
 * more than one of their values can be true, if different pointing devices have
 * different characteristics
 */
detectHover.anyHover === true;
detectHover.anyNone === true;


// updating the state - most apps won't need to use this at all
detectHover.update();
/*
 * note that in the case of a legacy computer and browser, one that
 * doesn't support detect-hover's detection tests, the default state will be:
 */
const detectHover = {
  hover: undefined,
  none: undefined,
  anyHover: undefined,
  anyNone: undefined,
}

Note that the update() function is run once at the time of import to set the object's initial state, and generally doesn't need to be run again. If it doesn't have access to the window or the browser doesn't support the matchMedia() function (all modern browser do), then the state will be undefined (detect-hover will not throw an error). If detect-hover doesn't have access to the window at the time of import, you will have to call the update() function manually at a later time to update its state.

Note that the hover on-demand value was removed from the July 6th 2016 W3C Media Queries Level 4 draft specification, but was included in the previous draft (January 26th 2016) of the spec. Any device that registers as having hover on-demand capabilities will show up as hover none in detectHover's state. As a side note, hover on-demand is pretty much useless for practical purposes, and Android touch only devices register that they can hover on-demand, which is achieved via a long press - I view this as a feature that is a bug.

Part of the detect-it family