{"_id":"@awesome-cordova-library/taptic-engine","_rev":"1-9ab42db4593978f9ef8c69d6bfc9e452","name":"@awesome-cordova-library/taptic-engine","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@awesome-cordova-library/taptic-engine","version":"1.0.0","description":"Apache Cordova / PhoneGap Plugin to enables adding contextual haptic feedback in response to specific user actions.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","typescript","mobile","taptic","vibration","ios"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"gitHead":"08675e4703e7849413e0b5184afa256d59725753","_id":"@awesome-cordova-library/taptic-engine@1.0.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-BrOAULFO7jhxqQuyanb5Az9ZEGNBq+cXaGWIKTUwvtTbjfAJYlZryIRT+YjwsCkHneq5Jf775a8AN5i+Cfue2g==","shasum":"3bec21f946301a61c0da94da589e8427654ae704","tarball":"https://registry.npmjs.org/@awesome-cordova-library/taptic-engine/-/taptic-engine-1.0.0.tgz","fileCount":7,"unpackedSize":15798,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCbMXO8jdW0Ys6tBdrI4r0JZX6ABsSeL9pJHbIGxIYRRgIgLg4Iy9VrwXtcYFOj3obp+9xsqfK94hXLOZJC430ZjJo="}]},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/taptic-engine_1.0.0_1691161307946_0.1953090523651626"},"_hasShrinkwrap":false},"1.0.1":{"name":"@awesome-cordova-library/taptic-engine","version":"1.0.1","description":"Apache Cordova / PhoneGap Plugin to enables adding contextual haptic feedback in response to specific user actions.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","typescript","mobile","taptic","vibration","ios"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"gitHead":"2a2b9cf007a870056251632315547e6a651d26a0","_id":"@awesome-cordova-library/taptic-engine@1.0.1","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-hk7/FLGgUAbDzF7xybx1CYiJx1XrzVn09GHhherM311C+qkb+J02LYFCQGJFQnOivtbCHbqiIzEJKUza5cHLsw==","shasum":"bcd47ca159d7e9657175e3b9968fbccbc565f277","tarball":"https://registry.npmjs.org/@awesome-cordova-library/taptic-engine/-/taptic-engine-1.0.1.tgz","fileCount":7,"unpackedSize":16173,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2hNL2FR99SRulfR8FT3edswBw+U710v1M2it2PKJkrwIgbncwoXmnaV53GaEEobdH8qLBZzhNn/A8197Qpr56M2U="}]},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/taptic-engine_1.0.1_1694499595750_0.1731437861757188"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-04T15:01:47.833Z","1.0.0":"2023-08-04T15:01:48.142Z","modified":"2023-09-12T06:19:56.259Z","1.0.1":"2023-09-12T06:19:55.999Z"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"description":"Apache Cordova / PhoneGap Plugin to enables adding contextual haptic feedback in response to specific user actions.","homepage":"https://github.com/joazco/awesome-cordova-library","keywords":["cordova","capacitor","ionic","javascript","typescript","mobile","taptic","vibration","ios"],"repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"license":"SEE LICENSE IN LICENSE","readme":"---\nid: plugin-taptic-engine\ntitle: Taptic Engine\ntags:\n  - cordova\n  - capacitor\n  - ionic\n  - javascript\n  - typescript\n  - plugin\n  - mobile\n  - taptic engine\n  - vibration\n---\n\n# Taptic Engine\n\nApache Cordova / PhoneGap Plugin to enables adding contextual haptic feedback in response to specific user actions.\n\n**Only on iOS**\n\n[Online documentation](https://awesomecordovalibrary.com)\n\n[Github documentation](https://github.com/EddyVerbruggen/cordova-plugin-taptic-engine)\n\n## Installation\n\n### Cordova\n\n```sh\ncordova plugin add cordova-plugin-taptic-engine\nnpm install @awesome-cordova-library/taptic-engine\n```\n\n### Capacitor / Ionic\n\n```bash\nnpm install cordova-plugin-taptic-engine\nnpm install @awesome-cordova-library/taptic-engine\nnpx cap sync\n```\n\n## Vanilla\n\n### Declaration\n\n```typescript\nexport default class TapicEngineIos {\n  /**\n   * Use selection feedback generators to indicate a change in selection.\n   */\n  static selection(): void;\n  /**\n   * Use notification feedback generators to indicate successes, failures, and warnings.\n   * @param type {\"success\" | \"warning\" | \"error\"}\n   */\n  static notification(type: \"success\" | \"warning\" | \"error\"): void;\n  /**\n   * Use impact feedback generators to indicate that an impact has occurred. For example, you might trigger impact feedback when a user interface object collides with something or snaps into place.\n   * @param style {\"light\" | \"medium\" | \"heavy\" | \"rigid\" | \"soft\"}\n   */\n  static impact(style: \"light\" | \"medium\" | \"heavy\" | \"rigid\" | \"soft\"): void;\n  /**\n   * Tell the taptic engine that a gesture for a selection change is starting.\n   */\n  static gestureSelectionStart(): void;\n  /**\n   * Tell the taptic engine that a selection changed during a gesture.\n   */\n  static gestureSelectionChanged(): void;\n  /**\n   * Tell the taptic engine we are done with a gesture. This needs to be called lest resources are not properly recycled.\n   */\n  static gestureSelectionEnd(): void;\n  /**\n   * This triggers the 'Pop' effect of 'Peek & Pop', which is a bit more profound than the 'Peek' effect.\n   * Codewise this is exactly the same as weakBoom, except for the function name of course.\n   */\n  static weakBoom(onSuccess: () => void, onFail: () => void): void;\n  /**\n   * Start watching for shake gestures and call \"onShake\"\n   * @param coords\n   */\n  static strongBoom(onSuccess: () => void, onFail: () => void): void;\n  /**\n   * This triggers the 'Nope' effect you get when fi. force touching a home icon which doesn't have any action. It's a short burst of 3-ish 'weak booms'.\n   * Codewise this is exactly the same as weakBoom and strongBoom, except for the function name of course.\n   */\n  static burst(onSuccess: () => void, onFail: () => void): void;\n  static warnPluginIsUnInstallOrIncompatible(): void;\n}\n```\n\n### Usages\n\n```typescript\nimport TapicEngineIos from '@awesome-cordova-library/taptic-engine';\n\nTapicEngineIos.notification(\"error\");\n.....\n```\n\n## React\n\n### Declaration\n\n```typescript\ndeclare const useTapicEngineIos: () => {\n  selection: () => void;\n  notification: (type: \"success\" | \"warning\" | \"error\") => void;\n  impact: (style: \"light\" | \"medium\" | \"heavy\" | \"rigid\" | \"soft\") => void;\n  gestureSelectionStart: () => void;\n  gestureSelectionChanged: () => void;\n  gestureSelectionEnd: () => void;\n  weakBoom: () => Promise<void>;\n  strongBoom: () => Promise<void>;\n  burst: () => Promise<void>;\n};\n```\n\n### Usages\n\n```typescript\nimport useTapicEngineIos from \"@awesome-cordova-library/taptic-engine/lib/react\";\n\nfunction App() {\n  const { notification } = useTapicEngineIos();\n\n  return (\n    <button\n      onClick={() => {\n        notification(\"error\");\n      }}\n    >\n      Send error haptic\n    </button>\n  );\n}\n```\n","readmeFilename":"README.md"}