{"id":15653379,"url":"https://github.com/juliomrqz/nativescript-vibrate","last_synced_at":"2025-04-13T15:52:12.680Z","repository":{"id":30232960,"uuid":"33784091","full_name":"juliomrqz/nativescript-vibrate","owner":"juliomrqz","description":"📳📱 A vibrate NativeScript plugin for Android and iOS","archived":false,"fork":false,"pushed_at":"2023-01-14T00:56:28.000Z","size":4212,"stargazers_count":30,"open_issues_count":36,"forks_count":13,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-04-02T03:46:56.273Z","etag":null,"topics":["android","ios","marquez","nativescript","nativescript-plugin","typescript","vibrate-nativescript-plugin","vibration-pattern","vibration-patterns","vibrator"],"latest_commit_sha":null,"homepage":"https://marquez.co/docs/nativescript-vibrate","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/juliomrqz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-11T16:55:18.000Z","updated_at":"2024-05-30T15:59:17.000Z","dependencies_parsed_at":"2023-01-14T16:35:36.708Z","dependency_job_id":null,"html_url":"https://github.com/juliomrqz/nativescript-vibrate","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliomrqz%2Fnativescript-vibrate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliomrqz%2Fnativescript-vibrate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliomrqz%2Fnativescript-vibrate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/juliomrqz%2Fnativescript-vibrate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/juliomrqz","download_url":"https://codeload.github.com/juliomrqz/nativescript-vibrate/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246847137,"owners_count":20843444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","ios","marquez","nativescript","nativescript-plugin","typescript","vibrate-nativescript-plugin","vibration-pattern","vibration-patterns","vibrator"],"created_at":"2024-10-03T12:45:30.701Z","updated_at":"2025-04-13T15:52:12.655Z","avatar_url":"https://github.com/juliomrqz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Codacy Badge](https://img.shields.io/codacy/grade/a40541d66db746bcb6669b7f30fd498d.svg)](https://www.codacy.com/app/juliomrqz/nativescript-vibrate?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=juliomrqz/nativescript-vibrate\u0026utm_campaign=badger)\n[![Travis](https://img.shields.io/travis/juliomrqz/nativescript-vibrate/master.svg)](https://travis-ci.org/juliomrqz/nativescript-vibrate)\n[![version](https://img.shields.io/npm/v/nativescript-vibrate.svg)](https://www.npmjs.com/package/nativescript-vibrate)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://marquez.co/docs/nativescript-vibrate/license?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjuliomrqz%2Fnativescript-vibrate.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjuliomrqz%2Fnativescript-vibrate?ref=badge_shield)\n\n# NativeScript Vibrate ![apple](https://cdn3.iconfinder.com/data/icons/picons-social/57/16-apple-32.png) ![android](https://cdn4.iconfinder.com/data/icons/logos-3/228/android-32.png) \n\nA vibrate NativeScript plugin for Android and iOS\n\n*Read this in other languages: [English](README.md), [Español][documentation-es]*\n\n## Installation\n\nRun the following command from the root of your project:\n\n```bash\n$ ns plugin add nativescript-vibrate\n```\n\nThis command automatically installs the necessary files, as well as stores **nativescript-vibrate** as a dependency in your project's **package.json** file.\n\n## Permissions\n\n### Android\n\nTo use the vibrate functionality on Android your app must request permission access the vibrator. The plugin automatically adds the required permission shown below for you so you don't need to worry about editing the Android Manifest.\n\n```xml\n\u003cuses-permission android:name=\"android.permission.VIBRATE\" /\u003e\n```\n\n## Example of use\n\nTo use the vibrate module you must first `require()` it:\n\n```js\nvar Vibrate = require(\"nativescript-vibrate\").Vibrate;\nvar vibrator = new Vibrate();\n```\n\nIf you use Typescript, you can import it this way:\n\n```typescript\nimport { Vibrate } from 'nativescript-vibrate';\nlet vibrator = new Vibrate();\n```\n\nAfter you have a reference to the module you can then call its `vibrate(milliseconds)` method.\n\n```js\n// my-page.js\nvibrator.vibrate(2000);\n```\n\nIf you prefer to use a vibration pattern, you could try:\n\n```js\n// my-page.js\nvibrator.vibrate([1000, 300, 500, 2000]);\n```\n\n### Notes\n\n#### iOS\n\nThere is no API to vibrate for a specific **amount of time** or **vibration pattern**, so it will vibrate for the default period of time no matter what.\n\n## API\n\nOnly one method is available: `vibrate().` Below are all the supported properties you can play around.\n\n| Property | Default | Description | Android | iOS |\n| :-: | :-: | :-: | :-: | :-: |\n| time | 300 | The number of milliseconds to vibrate. It can be also an array of longs of times for which to turn the vibrator on or off. | ✔︎ | ✘ |\n| repeat | -1 | The index into pattern at which to repeat, or -1 if you don't want to repeat. | ✔︎ | ✘ |\n\n## Documentation \u0026 Support\n\n- 📄 If you want **extra details** of how to configure and use this plugin, the full documentation is available at [https://marquez.co/docs/nativescript-vibrate][documentation].\n- 🐞 For **Bug reports** or **Feature requests**, use the [Issues section][issues].\n- 💬 For **questions**, you can also use the [Issues section][issues].\n- 🚀 You may also want to [follow me on Twitter][twitter].\n\n### Professional Support\n\nThis project is sponsored by me, [a Full Stack Developer][marquez-website]. If you require assistance on your project(s), please contact me at [https://marquez.co][marquez-website].\n\n## Contributing\n\nPlease make sure to read the [Contributing Guide][contributing] before making a pull request.\n\n## Code of Conduct\n\nEveryone participating in this project is expected to agree to abide by the [Code of Conduct][code-of-conduct].\n\n## License\n\nCode released under the [MIT License][license-page].\n\n![](https://ga-beacon.appspot.com/UA-65885578-17/juliomrqz/nativescript-vibrate?pixel)\n\n\n\n[documentation]: https://marquez.co/docs/nativescript-vibrate?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate\n[documentation-es]: https://marquez.co/es/docs/nativescript-vibrate?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate\n[contributing]: https://marquez.co/docs/nativescript-vibrate/contributing?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate\n[code-of-conduct]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/\n[issues]: https://github.com/juliomrqz/nativescript-vibrate/issues\n[twitter]: https://twitter.com/juliomrqz\n[marquez-website]: https://marquez.co?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate\n[license-page]: https://marquez.co/docs/nativescript-vibrate/license?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=nativescript-vibrate\n\n\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjuliomrqz%2Fnativescript-vibrate.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjuliomrqz%2Fnativescript-vibrate?ref=badge_large)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliomrqz%2Fnativescript-vibrate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjuliomrqz%2Fnativescript-vibrate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjuliomrqz%2Fnativescript-vibrate/lists"}