https://github.com/asplunds/tappify

A lightweight zero dependency React.js library to handle the client's pointer. Easily detect client cursor type and hide/show html or perform custom logic! Detect touch devices
https://github.com/asplunds/tappify

cursor detect finger mobile pointer react react-component tappify

Last synced: 4 days ago
JSON representation

A lightweight zero dependency React.js library to handle the client's pointer. Easily detect client cursor type and hide/show html or perform custom logic! Detect touch devices

• Host: GitHub
• URL: https://github.com/asplunds/tappify
• Owner: asplunds
• Created: 2020-11-15T19:47:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-09-09T11:48:42.000Z (about 3 years ago)
• Last Synced: 2024-10-08T11:44:04.374Z (about 1 month ago)
• Topics: cursor, detect, finger, mobile, pointer, react, react-component, tappify
• Language: JavaScript
• Homepage: https://github.com/asplunds/tappify
• Size: 18.6 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tappify.js

A lightweight zero dependency [React.js](https://github.com/facebook/react) library to handle the client's pointer. Easily detect client cursor type and hide/show html or perform custom logic!



## Install

```shell

npm i tappify

```

## Getting started

### Basic hide/show

```jsx

import Tappify from "tappify";

function myComponent() {

  return <>

    

      Client is using finger 👉 *tap tap*

    

    

      Client is using mouse cursor 🖱️ *click click*

    

  >

}

```

### Get the current pointer type

```js

const isCursor = Tappify.isCursor(); // will be true if the pointer is mouse cursor. False if it's finger

```

### Subscribe to pointer change

```js

const unsubscribe = Tappify.subscribe(isCursor => {

  if (isCursor) console.log("This client is now using a cursor");

  else console.log("This client is now using a touch screen");

  

});

unsubscribe(); // it's strongly recommended to unsubscribe when component unmounts to avoid memory leaks

```

## [Live demo](https://codesandbox.io/s/javascript-forked-gv8w4?file=/Demo.js)

## Why Tappify?

With growing usage of touch screens on computer devices Tappify makes it seamless and easy to detect when user goes in or out of touch mode. In addition tappify provides an easy to use switch case scenario to handle different HTML elements depending on what pointer the client is using.

Tappify is completely event driven, that means no clocks/setintervals/requestAnimationFrame making it very preferment. It makes use of css's native @media condition to avoid any edge case bugs that JavaScript solutions might invoke.

## How Tappify works

Tappify uses [@media pointer rule](https://developer.mozilla.org/en-US/docs/Web/CSS/@media) to determine the pointer type. If a pointer change is detected the pointerChange event will be dispatched on window and thereafter notifying subscribers and updating the `` and `` components.

## Found an issue?

Please open a new issue on the [Github repository](https://github.com/asplunds/tappify/issues)

## Want to contribute?

Simply create a new pull request on the pull requests tab.

## Browser support

Tappify will work on all modern browsers. Tappify will __not__ work on IE.