Skip to content

A Flutter plugin to fully support Haptic feedback with custom pattern πŸ“³

License

Notifications You must be signed in to change notification settings

istornz/flutter_gaimon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

48 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


🧐 What is it ?

Gaimon is a very simple & easy to use plugin to include Haptic feedback in your app. It support custom pattern with .ahap file support.

πŸ‘» Getting started

  • Import the plugin.
import 'package:gaimon/gaimon.dart';
  • Trigger haptic πŸ“³.
Gaimon.selection();
Gaimon.success();
Gaimon.error();
// [...]

Quite simple right ? 😎

πŸ“˜ Documentation

Name Description Android iOS
.canSupportsHaptic() Check if haptic are supported or not βœ… βœ…
.selection() Use it on a tap event βœ… βœ…
.error() Use it when an error occur βœ… βœ…
.success() Use it when a successful event occur βœ… βœ…
.warning() Use it when a warning event occur βœ… βœ…
.heavy() Huge feedback βœ… βœ…
.medium() Medium feedback βœ… βœ…
.light() Light feedback βœ… βœ…
.rigid() A huge but speed feedback βœ… βœ…
.soft() A medium but speed feedback βœ… βœ…
.pattern(String data) Read a custom .ahap file (you can use Captain AHAP to generate file) βœ… βœ…

❓ FAQ

  • Why custom pattern is not working on my iPhone?

    Custom vibration patterns is only supported on iPhone 8 and newer devices.

🎯 Roadmap

  • Support pattern for Android (send .ahap file & convert it to waveform).
  • Support audio file to haptic feedback (generate correct feedback for audio file).

πŸ‘₯ Contributions

Contributions are welcome. Contribute by creating a PR or create an issue πŸŽ‰.