Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hanayik/hapticjs

provide haptic feedback for Electron apps in MacOS on supported touchpads
https://github.com/hanayik/hapticjs

app electromagnetic electron haptic javascript macos mouse nodejs npm npm-module npm-package touchpad vibrate vibration

Last synced: 2 months ago
JSON representation

provide haptic feedback for Electron apps in MacOS on supported touchpads

Host: GitHub
URL: https://github.com/hanayik/hapticjs
Owner: hanayik
License: mit
Created: 2017-08-14T17:13:49.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-04-14T21:20:41.000Z (almost 3 years ago)
Last Synced: 2024-08-09T14:59:35.742Z (6 months ago)
Topics: app, electromagnetic, electron, haptic, javascript, macos, mouse, nodejs, npm, npm-module, npm-package, touchpad, vibrate, vibration
Language: C
Size: 54.6 MB
Stars: 26
Watchers: 3
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

# HapticJS

(Haptic feedback npm module for macOS touchpads)

### Description
HapticJS was developed in order to provide haptic (vibration) feedback to users when certain events happen. These events are set by the developer of the app, but for example, I enabled haptic feedback in one of my applications when users "bump" into the falling shapes or words on the screen.

This npm module was designed to work with any macOS electron app so long as you ``` require ``` it before using.

### To use

``` npm install --save hapticjs ```

``` var hapticjs = require('hapticjs') ```

``` hapticjs.vibrate() ```

The vibration will occur instantly. If haptic feedback isn't supported on your system then the module will simply just not vibrate when called. It will not stop the rest of your code execution.

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&[email protected]&lc=US&item_name=hapticJS&amount=1.00&currency_code=USD&bn=PP-DonationsBF:btn_donate_LG.gif:NonHostedGuest)

### License
[MIT](https://github.com/hanayik/HapticJS/blob/master/LICENSE)

### Developers
This npm module is currently only developed for MacOS

##### To clone repo:

``` cd /to/your/desired/install/location ```

``` git clone https://github.com/hanayik/HapticJS.git ```