add flutter_vibrate

2026-01-13 22:03:47 -08:00
parent a2af086126
commit 7eb3d100ac
89 changed files with 2213 additions and 0 deletions
@@ -0,0 +1,76 @@
+import 'dart:async';
+
+import 'package:flutter/services.dart';
+
+enum FeedbackType {
+  success,
+  error,
+  warning,
+  selection,
+  impact,
+  heavy,
+  medium,
+  light
+}
+
+class Vibrate {
+  static const MethodChannel _channel = MethodChannel('vibrate');
+  static const Duration defaultVibrationDuration = Duration(milliseconds: 500);
+
+  /// Vibrate for 500ms on Android, and for the default time on iOS (about 500ms as well)
+  static Future vibrate() => _channel.invokeMethod(
+        'vibrate',
+        {'duration': defaultVibrationDuration.inMilliseconds},
+      );
+
+  /// Whether the device can actually vibrate or not
+  static Future<bool> get canVibrate async {
+    final bool isOn = await _channel.invokeMethod('canVibrate');
+    return isOn;
+  }
+
+  static void feedback(FeedbackType type) {
+    switch (type) {
+      case FeedbackType.impact:
+        _channel.invokeMethod('impact');
+        break;
+      case FeedbackType.error:
+        _channel.invokeMethod('error');
+        break;
+      case FeedbackType.success:
+        _channel.invokeMethod('success');
+        break;
+      case FeedbackType.warning:
+        _channel.invokeMethod('warning');
+        break;
+      case FeedbackType.selection:
+        _channel.invokeMethod('selection');
+        break;
+      case FeedbackType.heavy:
+        _channel.invokeMethod('heavy');
+        break;
+      case FeedbackType.medium:
+        _channel.invokeMethod('medium');
+        break;
+      case FeedbackType.light:
+        _channel.invokeMethod('light');
+        break;
+      default:
+    }
+  }
+
+  /// Vibrates with [pauses] in between each vibration
+  /// Will always vibrate once before the first pause
+  /// and once after the last pause
+
+  static Future vibrateWithPauses(Iterable<Duration> pauses) async {
+    for (final Duration d in pauses) {
+      await vibrate();
+      //Because the native vibration is not awaited, we need to wait for
+      //the vibration to end before launching another one
+      await Future.delayed(defaultVibrationDuration);
+      await Future.delayed(d);
+    }
+    await vibrate();
+  }
+}