nativescript-vibrate
Advanced tools
A vibrate NativeScript plugin for Android and iOS
Read this in other languages: English, Español
Run the following command from the root of your project:
$ ns plugin add nativescript-vibrate
This command automatically installs the necessary files, as well as stores nativescript-vibrate as a dependency in your project's package.json file.
To 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.
<uses-permission android:name="android.permission.VIBRATE" />
To use the vibrate module you must first require() it:
var Vibrate = require("nativescript-vibrate").Vibrate;
var vibrator = new Vibrate();
If you use Typescript, you can import it this way:
import { Vibrate } from 'nativescript-vibrate';
let vibrator = new Vibrate();
After you have a reference to the module you can then call its vibrate(milliseconds) method.
// my-page.js
vibrator.vibrate(2000);
If you prefer to use a vibration pattern, you could try:
// my-page.js
vibrator.vibrate([1000, 300, 500, 2000]);
There 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.
Only one method is available: vibrate(). Below are all the supported properties you can play around.
| Property | Default | Description | Android | iOS |
|---|---|---|---|---|
| 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. | ✔︎ | ✘ |
| repeat | -1 | The index into pattern at which to repeat, or -1 if you don't want to repeat. | ✔︎ | ✘ |
This project is sponsored by me, a Full Stack Developer. If you require assistance on your project(s), please contact me at https://marquez.co.
Please make sure to read the Contributing Guide before making a pull request.
Everyone participating in this project is expected to agree to abide by the Code of Conduct.
Code released under the MIT License.
FAQs
A vibrate NativeScript plugin for Android and iOS
We found that nativescript-vibrate demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.