Giter Club home page Giter Club logo

flutter_gaimon's Introduction


๐Ÿง 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 ๐ŸŽ‰.

flutter_gaimon's People

Contributors

bassiuz avatar dimapparence avatar ductranminh avatar fauconspartiate avatar istornz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.