Giter Club home page Giter Club logo

warez's Introduction

warez

 __     __     ______     ______     ______     ______
/\ \  _ \ \   /\  __ \   /\  == \   /\  ___\   /\___  \
\ \ \/ ".\ \  \ \  __ \  \ \  __<   \ \  __\   \/_/  /__
 \ \__/".~\_\  \ \_\ \_\  \ \_\ \_\  \ \_____\   /\_____\
  \/_/   \/_/   \/_/\/_/   \/_/ /_/   \/_____/   \/_____/
==========INPUT=HARDWARE=DETECTION=FOR=JAVASCRIPT========

Sometimes it makes sense for a user interface to adapt to the input device being used. For example, in my app KameSame I wanted to expand the input size when the user was interacting with an Apple Pencil as opposed to the touchscreen or a physical keyboard (demo). Unfortunately, browsers don't make it easy to answer the question "what's the most recent input method that's been used?", or "what methods have been used since the page was loaded?"

This tiny package helps answer those questions with a pretty straightforward little API.

Install

$ npm i -S warez

Then const warez = require('warez') or import * as warez from 'warez' or whatever.

Usage

Monitoring input

The package offers start() and stop() functions that govern whether user interactions are being actively monitored. If you intend to track the current input device, just kick things off with:

warez.start()

And you can remove the event handlers with:

warez.stop()

Querying input device information

If you want to know the most recently used input device, you can call:

warez.currentDevice() // will be 'pen', 'keyboard', touch', or 'mouse'

And if you call:

warez.allDevices() // an array of one or more of the above input types

Be notified when the current device changes

You can also register an event handler to respond whenever the input device currently being used by the user changes:

warez.onDeviceChange(e => {
  console.log('Now using device', e.current)
  console.log('Previous device was', e.previous)

  // You might update any nodes in the DOM whose CSS styles ought to reflect
  // the current input device with something like this:
  document.querySelectorAll('[data-warez]').forEach(node => {
    node.setAttribute('data-warez', e.current)
  })
})

If you want to remove the handler, you can pass a reference to the function:

warez.removeDeviceChangeHandler(yourHandlerFunction)

Demo

Here's a little demo of the test page included in this repo:

warez's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.