react-native-haptic-feedback

When setEnabled(false) is active, the following behaviors occur:

If you are using the useHaptics hook, all calls through the returned object (e.g., haptics.trigger()) automatically respect this global state.

The enableVibrateFallback option is a no-op on iOS because Core Haptics handles all supported devices internally. It is safe to include this option in your configuration to maintain cross-platform code compatibility.

HapticFeedback.trigger("impactMedium", {
  enableVibrateFallback: true, // no-op on iOS — safe to pass for cross-platform code
});

The useHaptics hook returns a memoized object. It is designed to be stable, meaning the object reference only changes if the values within the defaultOptions object actually change. This prevents unnecessary re-renders or infinite loops when the haptics object is used as a dependency in React hooks like useEffect or useCallback.

const haptics = useHaptics({ enableVibrateFallback: true });

useEffect(() => {
  haptics.trigger("impactMedium");
}, [haptics]); // ✓ stable — won't cause infinite loop

The library uses decorView.performHapticFeedback() for precise, system-calibrated responses. This method accesses the activity's decorView directly without adding extra views to the layout tree.

Always-available (API 23+)

• clockTick
• contextClick
• keyboardPress
• keyboardRelease
• keyboardTap
• longPress
• textHandleMove
• virtualKey
• virtualKeyRelease

API 30+ (Android 11)

• confirm
• reject
• gestureStart
• gestureEnd
• segmentTick
• segmentFrequentTick

API 34+ (Android 14)

• toggleOn
• toggleOff
• dragStart
• gestureThresholdActivate
• gestureThresholdDeactivate
• noHaptics (explicit no-op)

Note: On devices below the required API level, these types fall back to a VibrationEffect waveform equivalent.

Apple Haptic and Audio Pattern (AHAP) is a JSON-based format for defining complex haptic experiences. This feature is iOS-only. The library allows you to play .ahap files at runtime or compose AHAP objects directly in TypeScript.

To use AHAP files, you must first include them in your iOS Xcode project as folder references so they are bundled with your app.

import HapticFeedback from "react-native-haptic-feedback";

// plays ios/YourApp/haptics/celebration.ahap
await HapticFeedback.playAHAP("celebration.ahap");

On iOS, the library utilizes CHHapticEngine (Core Haptics) instead of UIKit feedback generators.

Lifecycle Management:

• The engine is created eagerly during module initialization to ensure the first haptic call has no latency.
• If the engine is unavailable at initialization, it is created lazily on the first call.
• The engine automatically restarts via its resetHandler; you do not need to manually manage its lifecycle.

Requirements:

• Minimum iOS version: 13.0 (required for Core Haptics). While the library compiles for older targets, no haptic output will be produced on devices running versions below 13.0.

On iOS, every trigger() call follows a three-tier fallback chain. The system stops at the first tier that is supported by the device hardware/software:

1. Core Haptics: Requires iPhone 8+ or iPad Pro (iOS 13+). Provides full per-type patterns with custom intensity and sharpness using CHHapticEngine.
2. UIKit generators: Requires a Taptic Engine (iPhone 6s, 7, SE 1st gen on iOS 13+). Uses UIImpactFeedbackGenerator, UINotificationFeedbackGenerator, or UISelectionFeedbackGenerator to semantically map types to system haptics.
3. Audio vibration: Available on any device. Uses AudioServicesPlaySystemSound(kSystemSoundID_Vibrate). Note: This only fires if enableVibrateFallback: true is set in your options.

Tier 3 is intended for devices without a Taptic Engine (e.g., iPod touch 7th gen).

The following utilities are available for cross-platform haptic implementation:

• playHaptic(ahapFile, fallback, options?): Plays an AHAP file on iOS, or falls back to a pattern on Android.
• pattern(notation): Converts a notation string into a HapticEvent[] array.
• Patterns: A collection of six built-in named presets.
• useHaptics(defaultOptions?): A React hook for integrating haptics into components.
• TouchableHaptic: A Pressable wrapper component for easy haptic integration.

Because the Web Vibration API does not support vibration amplitude, the impact() method uses a fixed duration on web and ignores the intensity parameter. If precise intensity is critical to your UX, you should gate your calls by checking the platform.

import { Platform } from "react-native";
import { impact } from "react-native-haptic-feedback";

if (Platform.OS !== "web") {
  impact("impactMedium", 0.3); // precise on iOS / Android
} else {
  impact("impactMedium"); // web: fixed duration, intensity ignored
}