Haptics

GitHub npm crates.io

API Reference

Haptic feedback and vibrations on Android and iOS.

There are no standards/requirements for vibration support on Android, so the feedback APIs may not work correctly on more affordable phones, including recently released ones.

Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

Setup

Install the haptics plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add haptics

yarn

yarn run tauri add haptics

pnpm

pnpm tauri add haptics

deno

deno task tauri add haptics

bun

bun tauri add haptics

cargo

cargo tauri add haptics

Manual

1. Run the following command in the src-tauri folder to add the plugin to the project’s dependencies in Cargo.toml:

   cargo add tauri-plugin-haptics --target 'cfg(any(target_os = "android", target_os = "ios"))'

2. Modify lib.rs to initialize the plugin:

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(mobile)]
               app.handle().plugin(tauri_plugin_haptics::init());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

   npm

   npm install @tauri-apps/plugin-haptics

   yarn

   yarn add @tauri-apps/plugin-haptics

   pnpm

   pnpm add @tauri-apps/plugin-haptics

   deno

   deno add npm:@tauri-apps/plugin-haptics

   bun

   bun add @tauri-apps/plugin-haptics

Usage

The haptics plugin is available in JavaScript.

import {
  vibrate,
  impactFeedback,
  notificationFeedback,
  selectionFeedback,
} from '@tauri-apps/plugin-haptics';

await vibrate(1);
await impactFeedback('medium');
await notificationFeedback('warning');
await selectionFeedback();

Permissions

By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

src-tauri/capabilities/mobile.json

{
  "$schema": "../gen/schemas/mobile-schema.json",
  "identifier": "mobile-capability",
  "windows": ["main"],
  "platforms": ["iOS", "android"],
  "permissions": [
    "haptics:allow-impact-feedback",
    "haptics:allow-notification-feedback",
    "haptics:allow-selection-feedback",
    "haptics:allow-vibrate"
  ]
}

Permission Table

Identifier	Description
haptics:allow-impact-feedback	Enables the impact_feedback command without any pre-configured scope.
haptics:deny-impact-feedback	Denies the impact_feedback command without any pre-configured scope.
haptics:allow-notification-feedback	Enables the notification_feedback command without any pre-configured scope.
haptics:deny-notification-feedback	Denies the notification_feedback command without any pre-configured scope.
haptics:allow-selection-feedback	Enables the selection_feedback command without any pre-configured scope.
haptics:deny-selection-feedback	Denies the selection_feedback command without any pre-configured scope.
haptics:allow-vibrate	Enables the vibrate command without any pre-configured scope.
haptics:deny-vibrate	Denies the vibrate command without any pre-configured scope.