Geolocation
The Geolocation API extends the web spec: https://developer.mozilla.org/en-US/docs/Web/API/Geolocation
As a browser polyfill, this API is available through the navigator.geolocation
global - you do not need to import
it.
Configuration and Permissions
iOS
You need to include the NSLocationWhenInUseUsageDescription
key in Info.plist to enable geolocation when using the app. Geolocation is enabled by default when you create a project with react-native init
.
In order to enable geolocation in the background, you need to include the 'NSLocationAlwaysUsageDescription' key in Info.plist and add location as a background mode in the 'Capabilities' tab in Xcode.
Android
To request access to location, you need to add the following line to your app's AndroidManifest.xml
:
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
Android API >= 18 Positions will also contain a mocked
boolean to indicate if position was created from a mock provider.
Methods
Reference
Methods
requestAuthorization()
static requestAuthorization()
Request suitable Location permission based on the key configured on pList. If NSLocationAlwaysUsageDescription is set, it will request Always authorization, although if NSLocationWhenInUseUsageDescription is set, it will request InUse authorization.
getCurrentPosition()
static getCurrentPosition(geo_success, geo_error?, geo_options?)
Invokes the success callback once with the latest location info. Supported options: timeout (ms), maximumAge (ms), enableHighAccuracy (bool) On Android, if the location is cached this can return almost immediately, or it will request an update which might take a while.
watchPosition()
static watchPosition(success, error?, options?)
Invokes the success callback whenever the location changes. Supported options: timeout (ms), maximumAge (ms), enableHighAccuracy (bool), distanceFilter(m), useSignificantChanges (bool)
clearWatch()
static clearWatch(watchID)
stopObserving()
static stopObserving()
Stops observing for device location changes. In addition, it removes all listeners previously registered.
Notice that this method has only effect if the geolocation.watchPosition(successCallback, errorCallback)
method was previously invoked.