https://github.com/melbournedeveloper/flutter_location_wakeup
Listens for significant location changes on the device and wakes it up when they arrive
https://github.com/melbournedeveloper/flutter_location_wakeup
dart flutter ios location
Last synced: 5 months ago
JSON representation
Listens for significant location changes on the device and wakes it up when they arrive
- Host: GitHub
- URL: https://github.com/melbournedeveloper/flutter_location_wakeup
- Owner: MelbourneDeveloper
- License: bsd-3-clause
- Created: 2023-09-20T09:50:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-24T08:49:35.000Z (over 2 years ago)
- Last Synced: 2025-10-26T02:41:53.656Z (5 months ago)
- Topics: dart, flutter, ios, location
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_location_wakeup
- Size: 614 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# flutter_location_wakeup
`flutter_location_wakeup` is a Flutter plugin designed to listen for significant location changes on the device. When the changes are detected, the foreground app wakes up, or stays awake from suspension. Use this library when you need location changes to keep the foreground app alive, such as in the case of a navigation apps, or place based interaction apps.
The plugin's iOS implementation predominantly relies on Apple's [`startMonitoringSignificantLocationChanges`](https://developer.apple.com/documentation/corelocation/cllocationmanager/1423531-startmonitoringsignificantlocati) Swift API. For an in-depth understanding of its functionality, refer to Apple's official documentation. As of now, the plugin offers support exclusively for iOS, with Android support in the pipeline.
## Getting Started
### iOS Configuration
To set up the plugin for iOS, you need to request location permissions. Add the following keys to your Info.plist to describe the reasons for using the location:
```xml
NSLocationWhenInUseUsageDescription
We need your location for...
NSLocationAlwaysUsageDescription
We need your location for...
NSLocationAlwaysAndWhenInUseUsageDescription
We need your location for...
```
### Sample Usage
For a comprehensive demonstration, refer to the example provided in the `example` directory.
Test the functionality with the Freeway Drive feature of the iOS Simulator.
Below is a snippet showcasing a stateful widget that listens for location updates and presents them using a `SnackBar`:
```dart
class _LocationDisplayState extends State {
String _display = 'Unknown';
final _locationWakeup = LocationWakeup();
@override
void initState() {
super.initState();
startListening();
}
Future startListening() async {
if (!mounted) return;
try {
//Start listening before initializing
_locationWakeup.locationUpdates.listen(
(result) {
if (!mounted) return;
setState(() => onLocationResultChange(result));
},
);
//Initialize
await _locationWakeup.startMonitoring();
} on PlatformException {
// Handle exception
}
}
void onLocationResultChange(LocationResult result) {
_display = result.match(
onSuccess: (l) => '''
Lat: ${l.latitude}
Long: ${l.longitude}
Altitude: ${l.altitude}
Horizontal Accuracy: ${l.horizontalAccuracy}
Vertical Accuracy: ${l.verticalAccuracy}
Course: ${l.course}
Speed: ${l.speed}
Timestamp: ${l.timestamp}
Floor Level: ${l.floorLevel}
''',
onError: (e) => e.message);
messengerStateKey.currentState.let(
(state) async => state.showSnackBar(
SnackBar(
content: Text(
_display,
style: const TextStyle(fontSize: 16, fontWeight: FontWeight.bold),
),
backgroundColor: Theme.of(state.context).colorScheme.background,
behavior: SnackBarBehavior.floating,
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(10),
),
margin: const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
duration: const Duration(seconds: 10),
action: SnackBarAction(
label: 'Dismiss',
onPressed: () {},
textColor: Colors.white,
),
),
),
);
}
@override
Widget build(BuildContext context) => Text(_display);
}
```