https://github.com/ajinasokan/flutter_fgbg
Flutter plugin to detect when app(not Flutter container) goes to background or foreground
https://github.com/ajinasokan/flutter_fgbg
Last synced: about 2 months ago
JSON representation
Flutter plugin to detect when app(not Flutter container) goes to background or foreground
- Host: GitHub
- URL: https://github.com/ajinasokan/flutter_fgbg
- Owner: ajinasokan
- License: mit
- Created: 2020-09-08T07:04:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T10:09:57.000Z (4 months ago)
- Last Synced: 2025-03-29T01:06:37.482Z (2 months ago)
- Language: Dart
- Size: 378 KB
- Stars: 85
- Watchers: 5
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Foreground/Background Event Notifier
Flutter plugin to detect when app(not Flutter container) goes to background or foreground.
## Why
Flutter has [WidgetsBindingObserver](https://api.flutter.dev/flutter/widgets/WidgetsBindingObserver-class.html) to get notified when app changes its state from active to inactive states and back. But it actually includes the state changes of the embedding Activity/ViewController as well. So if you have a plugin that opens a new activity/view controller or in iOS if you start a FaceID prompt then WidgetsBindingObserver will report as the app is inactive/resumed.
This plugin on the other hand reports the events only at app level. Since most apps need only background/foreground events this plugin is implemented with just those events. In iOS, plugin reports `didEnterBackgroundNotification` and `willEnterForegroundNotification` notifications and in Android, plugin reports these using `androidx.lifecycle:lifecycle-process` package. In other platforms plugin fallbacks to `AppLifecycleListener` API for signals.
Checkout `example/` project to see the differences in action.
## Getting Started
Add to your pubpsec:
```shell
flutter pub add flutter_fgbg
```
Do a clean build to integrate the plugin native code to app. Otherwise you might encounter `MissingPluginException`.
Use the built in Widget:
```dart
FGBGNotifier(
onEvent: (event) {
print(event); // FGBGType.foreground or FGBGType.background
},
child: ...,
)
```
Or consume the event stream directly:
```dart
import 'package:flutter_fgbg/flutter_fgbg.dart';
StreamSubscription subscription;
...
// in initState
subscription = FGBGEvents.instance.stream.listen((event) {
print(event); // FGBGType.foreground or FGBGType.background
});
// in dispose
subscription.cancel();
```
## Caveats
In newer Android versions and `image_picker` library, picking an image will open a different app this will make Flutter app switch to background/foreground and `flutter_fgbg` will report this. At the moment there is no solution to this since the API is working as intented. Tracking the issue [here](https://github.com/ajinasokan/flutter_fgbg/issues/5).
As a work around you can use `FGBGEvents.ignoreWhile` API like this:
```dart
FGBGEvents.ignoreWhile(() async {
await picker.pickImage(source: ImageSource.gallery);
// or do something else that can put app to background but don't want to be handled by flutter_fgbg
});
```