react-native-haptic-feedback
Version:
Basic haptic feedback for iOS and android
23 lines • 1.14 kB
TypeScript
import type { HapticOptions, HapticEvent, HapticFeedbackTypes } from "../types";
/**
* React hook that provides haptic feedback methods with optional default options.
* Returns a stable object — methods only change when the option values change.
*
* @example
* const haptics = useHaptics({ enableVibrateFallback: true });
* haptics.trigger('impactMedium');
*/
export declare function useHaptics(defaultOptions?: HapticOptions): {
trigger(type: keyof typeof HapticFeedbackTypes | HapticFeedbackTypes, opts?: HapticOptions): void;
triggerPattern(events: HapticEvent[], opts?: HapticOptions): void;
stop(): void;
isSupported(): boolean;
playHaptic(ahapFile: string, fallback: HapticEvent[], opts?: HapticOptions): Promise<void>;
impact(type?: keyof typeof HapticFeedbackTypes | HapticFeedbackTypes, intensity?: number, opts?: HapticOptions): void;
setEnabled: (value: boolean) => void;
isEnabled: () => boolean;
getSystemHapticStatus: () => Promise<import("..").SystemHapticStatus>;
/** @platform ios */
playAHAP: (fileName: string) => Promise<void>;
};
//# sourceMappingURL=useHaptics.d.ts.map