large Flutter Favorite logosmall Flutter Favorite logo

geolocator 0.0.1 icon indicating copy to clipboard operation
geolocator: ^0.0.1 copied to clipboard


Geolocation plugin for Flutter

Flutter Geolocator Plugin #

A Flutter plugin which provides easy access to the platform specific location services (FusedLocationProviderClient on Android and CLLocationManager on iOS).

BranchBuild Status
developBuild Status
masterBuild Status

Usage #

To use this plugin, add flutter_geolocator as a dependency in your pubspec.yaml file.

Permissions #

Android #

On Android you'll need to add the ACCESS_COARSE_LOCATION and ACCESS_FINE_LOCATION permissions to your Android Manifest. Todo so open the AndroidManifest.xml file and add the following two lines as direct children of the <manifest> tag:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

iOS #

On iOS you'll need to add the NSLocationWhenInUseUsageDescription to your Info.plist file in order to access the device's location. Simply open your Info.plist file and add the following:

<string>This app needs access to location when open.</string>

If you would like to access the device's location when your App is running in the background, you should also add the NSLocationAlwaysAndWhenInUseUsageDescription (if your App support iOS 10 or earlier you should also add the key NSLocationAlwaysUsageDescription) key to your Info.plist file:

<string>This app needs access to location when in the background.</string>
<string>This app needs access to location when open and in the background.</string>

Example #

To query the current location of the device simply make a call to the getPosition method:

import 'package:geolocator/geolocator.dart';
import 'package:geolocator/models/position.dart';

Position position = await new Geolocator.getPosition;

To listen for location changes you can subscribe to the onPositionChanged stream:

import 'package:geolocator/geolocator.dart';
import 'package:geolocator/models/position.dart';

Geolocator geolocator = new Geolocator();
StreamSubscription<Position> positionStream = geolocator.onPositionChanged.listen(
    (Position position) {
        print(_position == null ? 'Unknown' : _position.latitude.toString() + ', ' + _position.longitude.toString());

See also the example project for a complete implementation.