Haptic Feedback API

Add haptic feedback using the WebToNative JavaScript API. Trigger vibration responses to enhance user interactions on Android and iOS apps.

Functions to trigger haptic feedback effects on the device and to check whether haptic feedback is supported. Haptic effects use predefined vibration patterns that help users recognize the significance of different interactions.

You'll need to import the javascript file in your website before starting from this link.

Trigger

Triggers a haptic feedback effect on the device. If effect is omitted or an invalid value is provided, a default effect is applied. Optionally, pass soundName to also play a custom sound (uploaded via the Dashboard) at the same time — see Sound.play for the full rules for this parameter, and OS Notification Sound for how to upload a sound file.

Plain Javascript

window.WTN.Haptics.trigger({
  effect: "impactMedium",
  soundName: "your_sound_name", // optional — see Sound.play
});

npm

import { trigger } from "webtonative/Haptics";

trigger({
  effect: "impactMedium",
  soundName: "your_sound_name", // optional — see Sound.play
});

Parameters:

Key	Type	Required	Description
effect	String	No	The vibration pattern to play. See the supported values below.
soundName	String	No	Name of an uploaded sound file to play alongside the haptic effect, using the exact same lookup rules as Sound.play — omit it to trigger the haptic effect only.

Supported effect values:

Value	Description
impactLight	A light impact, suitable for small UI interactions.
impactMedium	A medium impact, suitable for standard UI interactions.
impactHeavy	A heavy impact, suitable for prominent UI interactions.
notificationSuccess	Indicates a successful action or outcome.
notificationWarning	Indicates a warning or cautionary state.
notificationError	Indicates an error or failed action.

---

Is Haptic Supported

Checks whether the device supports haptic feedback.

This function is currently only available on Android. On iOS the callback will not be invoked.

Plain Javascript

window.WTN.Haptics.isHapticSupported({
  callback: function (response) {
    console.log(response.isSupported);
  },
});

npm

import { isHapticSupported } from "webtonative/Haptics";

isHapticSupported({
  callback: (response) => {
    console.log(response.isSupported);
  },
});

Parameters:

Key	Type	Required	Description
callback	Function	No	Callback function invoked with the response.

Callback Response:

Key	Type	Description
type	String	Always "isHapticSupported".
isSupported	Boolean	true if the device supports haptic feedback, false otherwise.