gaimon 1.2.0
gaimon: ^1.2.0 copied to clipboard
A Flutter plugin to fully support Haptic feedback with custom pattern.
🧐 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.
- Why custom pattern is not working on Android?
This feature is only available on iOS for now (a PR would be appreciated 🤗).
🎯 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 🎉.