vue-gamepad
A Vue.js plugin to add gamepad support. Bind any element to trigger a callback when a gamepad button is pressed.
Installation
npm/yarn
$ npm install vue-gamepad# or with yarn $ yarn add vue-gamepad
CDN
https://unpkg.com/vue-gamepad/dist/vue-gamepad.min.js
Usage
Tell Vue to use the plugin
;; Vue;
Example usage inside templates:
Press me!
Constructor Options
Key | Description | Default | Type |
---|---|---|---|
analogThreshold |
Threshold before analog events are triggered. Low values may cause false positives | 0.5 |
Number |
buttonMapping |
List of strings containing button indices | Mapping | Array |
buttonInitialTimeout |
Time (in milliseconds) until the button will start repeating when held down | 200 |
Number |
buttonRepeatTimeout |
Time (in milliseconds) between each button repeat event when held down | 200 |
Number |
injectClasses |
Add classes to elements which have a gamepad binding | true |
Boolean |
Directives
v-gamepad
- Bind an element to a gamepad action which will fire a callbackreleased
modifier - Only fire the callback when the button is releasedrepeat
modifier - Repeatedly fire the callback when the button is held
v-gamepad-layer
- TODOv-gamepad-json
- Pass a raw object of buttons, actions and callbacks to bind
License
This project is licensed under the MIT License - see the LICENSE file for details