To help you get started, we've collected the most common ways that expo-location is being used within popular public projects.

flow-typed / flow-typed / definitions / npm / expo-location_v5.x.x / flow_v0.104.x- / test_expo-location.js View on Github

it('should raise an error when call function with invalid arguments', () => {
    // $ExpectError: first argument is required
    startLocationUpdatesAsync();

    // $ExpectError: first argument mush be a string
    startLocationUpdatesAsync(1337);

    // $ExpectError: second argument must be an object
    startLocationUpdatesAsync('taskName', 69);

    startLocationUpdatesAsync('taskName', {
      // $ExpectError: invalid accuracy
      accuracy: 1,
      // $ExpectError: invalid activityType
      activityType: 1,

      // $ExpectError: `notificationTitle` is required props
      foregroundService: { notificationBody: 'str' },
    });
  });
});

View more ways to use expo-location

expo-location

Allows reading geolocation information from the device. Your app can poll for the current location or subscribe to location update events.

API documentation

• Documentation for the main branch
• Documentation for the latest stable release

Installation in managed Expo projects

For managed Expo projects, please follow the installation instructions in the API documentation for the latest stable release.

Installation in bare React Native projects

For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

Add the package to your npm dependencies

expo install expo-location

Configure for iOS

Add NSLocationAlwaysAndWhenInUseUsageDescription, NSLocationAlwaysUsageDescription and NSLocationWhenInUseUsageDescription keys to your Info.plist:

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>Allow $(PRODUCT_NAME) to use your location</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>Allow $(PRODUCT_NAME) to use your location</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>Allow $(PRODUCT_NAME) to use your location</string>

Run npx pod-install after installing the npm package.

Configure for Android

This module requires the permissions for approximate and exact device location. It also needs the foreground service permission to subscribe to location updates, while the app is in use. These permissions are automatically added.

<!-- Added permissions -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />

<!-- Optional permissions -->
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

Note: on Android, you have to submit your app for review and request access to use the background location permission.

Contributing

Contributions are very welcome! Please refer to guidelines described in the contributing guide.