folksable / shake_detector

a package to detect shake gestures for flutter, configurable and simple api.

shake_detector

A flutter package to detect phone shakes, with pause and resume listening when the app is in background and foreground respectively.

Usage

1. Use as Widget

class HomePage extends StatelessWidget {
  const HomePage({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('ShakeGesture Example')),
      body: Center(
        // The start.
        child: ShakeDetectWrap(
          enabled: true,
          onShake: () {
            ScaffoldMessenger.of(context).showSnackBar(
              const SnackBar(content: Text('Shake!')),
            );
          },
          child: const Center(
            child: OutlinedButton(
              onPressed: ShakeGestureTestHelperExtension.simulateShake,
              child: Text('Simulate Shake'),
            ),
          ),
        ),
		// The end.
      ),
    );
  }
}

2. Use as Listener

To listen to phone shake:

ShakeDetector detector = ShakeDetector.autoStart(
    onShake: () {
        // Do stuff on phone shake
    }
);

OR

This will wait for user to call startListening() to start listening to phone shake:

ShakeDetector detector = ShakeDetector.waitForStart(
    onShake: () {
        // Do stuff on phone shake
    }
);

// start listening later on, after using waitForStart constructor
detector.startListening();

Control Detector:

// usually you don't start listening but used in constructor
detector.startListening();

// pause shake listening for a while (e.g. when app is in background)
detector.pauseListening();

// resume shake listening after pause
detector.resumeListening();

// stop shake detection
// this will cancel the stream subscription 
detector.stopListening();

shake_detector's Issues

Error: 'onPhoneShake' is not defined.

Error: 'onPhoneShake' is not defined; 'onShake' is used instead.

Please update the documentation to reflect this change. Additionally, if possible, update the example documentation on pub.dev to reflect the usage of 'onShake' instead of 'onPhoneShake'.

Thank in advance.

Pause Listening to Shake while App in Background.

currently the package is still listening to shakes happening when the app is not currently visible but in memory.

need to add pause method to the controller to fix this and listen to lifecycle changes.