搜索插件、代码仓与 APP 分类

插件详情v0.8.0

haptic_feedback

用于触觉反馈的 Flutter 插件。虽然它利用了标准的 iOS 触觉反馈,但旨在在 Android 上模拟相同的触觉模式,以实现跨平台的一致体验。

AndroidiOS
近 30 天下载
4.8万
喜欢数
136
Pub 分数
160

安装插件

flutter pub add haptic_feedback

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

haptic_feedback 包在 Flutter 应用中为 Android 和 iOS 平台提供一致的触觉反馈。它利用原生 iOS 触觉技术,同时在 Android 上模拟类似的模式,以确保统一的用户体验。专为寻求应用中触觉响应的开发者设计,支持标准的触觉模式,如冲击、通知和选择。该插件轻量且易于集成,非常适合增强移动应用中的交互反馈。

适合场景

  • 通过触觉反馈增强触摸交互
  • 通过物理提示改善可访问性
  • 在游戏应用中添加响应式反馈
  • 创建沉浸式用户体验
  • 支持手势导航
  • 为操作提供确认反馈

主要特点

  • 跨平台触觉一致性
  • 在 Android 上模拟 iOS 触觉反馈
  • 用于常见触觉反馈模式的简单 API
  • 轻量且高效
  • 支持影响、通知和选择类型
  • 通过 Flutter pub 实现轻松集成

适合对象

  • 面向 Android 和 iOS 的移动应用开发者
  • 以可访问性为重点的应用程序设计
  • 需要触觉反馈的交互式UI组件
  • 游戏化或手势驱动的界面
  • 用户反馈提升可用性的应用

使用建议

  • 仅限基本触觉模式
  • Android 模拟可能因设备而异
  • 并非所有设备都支持高级触感反馈
  • 需要平台特定权限
  • 行为在不同平台之间略有差异
  • 依赖硬件功能以获得最佳效果

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

haptic_feedback

A haptic feedback plugin for both iOS and Android.

While it utilizes standard iOS haptics, it aims to emulate these same haptic patterns on Android for a consistent experience across platforms.

For a guide on when to use each haptic type, see Missing haptic types, and which to use when by Kamran.

Getting Started

1. Add the dependency
flutter pub add haptic_feedback
2. Use the plugin
final canVibrate = await Haptics.canVibrate();

await Haptics.vibrate(HapticsType.success);
await Haptics.vibrate(HapticsType.warning);
await Haptics.vibrate(HapticsType.error);

await Haptics.vibrate(HapticsType.light);
await Haptics.vibrate(HapticsType.medium);
await Haptics.vibrate(HapticsType.heavy);

await Haptics.vibrate(HapticsType.rigid);
await Haptics.vibrate(HapticsType.soft);

await Haptics.vibrate(HapticsType.selection);

If you want to be defensive, you can wrap calls in a try/catch to handle a PlatformException. Native exceptions are caught and returned as PlatformException (code: VIBRATION_ERROR) so they won't crash your app, but you can log or react if needed:

try {
  await Haptics.vibrate(HapticsType.success);
} on PlatformException catch (e) {
  // Handle or log as needed
}

Android-specific options

// Use native Android haptic constants (default: false)
// When true, uses HapticFeedbackConstants like CONFIRM, REJECT, etc.
// When false, uses custom vibration primitives that are more aligned
// with iOS haptics
await Haptics.vibrate(
  HapticsType.success,
  useAndroidHapticConstants: false,  // default
);

// On Android 13+, you can hint how the system should treat this vibration
// (alarm, communicationRequest, hardwareFeedback, media, notification, physicalEmulation, ringtone, touch, unknown)
await Haptics.vibrate(
  HapticsType.success,
  usage: HapticsUsage.media,
);

The optional usage parameter is a hint for the system. It can influence how the vibration is routed and which volume / haptics settings control it (for example, notification vs touch feedback).

Use a concrete value whenever the vibration clearly matches one of the defined categories (for example HapticsUsage.notification for reminders or status updates), and keep the default HapticsUsage.unknown for simple taps and other lightweight UI feedback.

iOS: SwiftPM vs CocoaPods

Flutter can consume this plugin via Swift Package Manager (SPM) or CocoaPods. SPM support in Flutter is still experimental:

  1. To enable SPM (Flutter 3.24+): flutter config --enable-swift-package-manager or add to pubspec.yaml:

    flutter:
      config:
        enable-swift-package-manager: true
    

    If you hit Xcode build issues after switching, do a one-time clean: flutter clean and remove Xcode DerivedData for this app (e.g., rm -rf ~/Library/Developer/Xcode/DerivedData/Runner-*), then rebuild.

  2. To stick with CocoaPods (or if you hit SPM issues): disable SPM with flutter config --no-enable-swift-package-manager or by adding to pubspec.yaml:

    flutter:
      config:
        enable-swift-package-manager: false
    

The plugin still supports CocoaPods; SPM is available for native iOS apps and newer Flutter toolchains.

Platform Implementation

iOS

Uses Apple's native haptic feedback APIs:

  • UINotificationFeedbackGenerator for success, warning, and error
  • UIImpactFeedbackGenerator for light, medium, heavy, rigid, and soft
  • UISelectionFeedbackGenerator for selection
Android

On Android, the plugin defaults to high-fidelity haptic primitives on API 30+ (great on devices with advanced/HD hardware); falls back to waveforms on API 26-29 and legacy timing-only vibration on older SDKs; and can opt into system HapticFeedbackConstants via useAndroidHapticConstants on supported SDKs. The plugin uses a multi-strategy approach for the best possible haptic experience:

Strategy 1: Native HapticFeedbackConstants (when enabled)

When useAndroidHapticConstants: true, the plugin uses Android's system-level haptic constants via View.performHapticFeedback():

Type Android Constant API Level
success CONFIRM ≥ 30
error REJECT ≥ 30
light VIRTUAL_KEY ≥ 5
medium KEYBOARD_PRESS (≥ 27) / KEYBOARD_TAP (≥ 8) ≥ 8
heavy CONTEXT_CLICK ≥ 23
selection CLOCK_TICK ≥ 21

Note: warning, rigid, and soft don't have direct Android mappings and fall back to primitives/waveforms/legacy.

Strategy 2: Haptic Primitives (API 30+)

When native constants aren't available or useAndroidHapticConstants: false (default), the plugin uses VibrationEffect.Composition, which is tuned to resemble the iOS patterns:

Type Primitive(s) Description
success CLICK × 2 Two clicks with increasing intensity
warning CLICK × 2 Two clicks with decreasing intensity
error CLICK × 4 Four clicks with an accented third pulse
light TICK Subtle, light feedback
medium CLICK Moderate feedback
heavy THUD Strong, deep feedback
rigid CLICK Sharp, crisp feedback
soft SPIN* Gentle, longer feedback
selection TICK Subtle selection feedback

* SPIN requires API 31+; falls back to TICK on API 30.

Strategy 3: Waveform Vibrations (API 26-29)

For devices without primitive support, the plugin uses VibrationEffect.createWaveform() with amplitude control.

Strategy 4: Legacy Vibration (API < 26)

Basic timing-only patterns for older devices.

For detailed timing specifications and implementation rationale, see HAPTIC_PATTERNS.md.

Testing

When testing widgets that use haptic feedback, defaultTargetPlatform is TargetPlatform.android by default, but the default platform implementation still calls the method channel and will throw MissingPluginException unless you register a mock. If you swap in a mock platform that returns true, Haptics.canVibrate() will return true even on a non-mobile host unless you override the target platform.

To test widgets that use haptic feedback, you can:

  1. Use debugDefaultTargetPlatformOverride to test platform-specific behavior:
import 'package:flutter/foundation.dart';

void main() {
  testWidgets('test on iOS', (tester) async {
    debugDefaultTargetPlatformOverride = TargetPlatform.iOS;
    addTearDown(() => debugDefaultTargetPlatformOverride = null);

    // Your test code here
  });
}
  1. Mock the platform interface in your tests:
import 'package:haptic_feedback/src/haptic_feedback_platform_interface.dart';
import 'package:plugin_platform_interface/plugin_platform_interface.dart';

class MockHapticFeedbackPlatform extends Mock
    with MockPlatformInterfaceMixin
    implements HapticFeedbackPlatform {}

void main() {
  testWidgets('my widget test', (tester) async {
    final mockPlatform = MockHapticFeedbackPlatform();
    HapticFeedbackPlatform.instance = mockPlatform;
    
    when(() => mockPlatform.canVibrate()).thenAnswer((_) async => true);
    when(() => mockPlatform.vibrate(any())).thenAnswer((_) async {});
    
    // Your test code here
  });
}
  1. Mock the method channel to avoid MissingPluginException while using the real platform class:
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:haptic_feedback/src/haptic_feedback_method_channel.dart';
import 'package:haptic_feedback/src/haptics_type.dart';

void main() {
  const channel = MethodChannelHapticFeedback.methodChannel;
  TestDefaultBinaryMessengerBinding.ensureInitialized();

  setUp(() {
    final binding = TestDefaultBinaryMessengerBinding.instance;
    binding.defaultBinaryMessenger.setMockMethodCallHandler(
      channel,
      (MethodCall call) async {
        if (call.method == 'canVibrate') return true;
        return null; // success for vibrate calls
      },
    );
  });

  tearDown(() {
    final binding = TestDefaultBinaryMessengerBinding.instance;
    binding.defaultBinaryMessenger.setMockMethodCallHandler(channel, null);
  });

  test('canVibrate works with mocked channel', () async {
    expect(await MethodChannelHapticFeedback().canVibrate(), isTrue);
  });

  test('vibrate forwards to mocked channel', () async {
    await MethodChannelHapticFeedback().vibrate(HapticsType.success);
  });
}

You can find these examples as runnable tests in example/test on GitHub.

Automatic Permissions Inclusion

Android VIBRATE Permission

When you integrate the haptic_feedback plugin into your Flutter project, it will automatically include the necessary VIBRATE permission in the final merged AndroidManifest.xml of your app. This is due to the permission being declared in the plugin's manifest.

What this means for you:
  • No Manual Action Required: You don't have to add the <uses-permission android:name="android.permission.VIBRATE"/> permission to your app's AndroidManifest.xml manually. It will be automatically merged when building the app.

  • Transparency: By using the haptic_feedback plugin, your app will request the VIBRATE permission. Ensure that you are aware of all permissions your app requires, especially if you publish it on app stores. Some users may be sensitive to app permissions, even if they don't require explicit consent.

  • Permission Overview: To review all permissions that your app requests due to plugins and your own declarations, inspect the final merged AndroidManifest.xml after a build. This will provide a comprehensive view of all permissions and other manifest entries.

所属分类

依赖

依赖清单 1 项

  • plugin_platform_interface^2.0.0

源码仓库

使用此插件的项目