Expo Docs MCP Server

--- title: Location description: A library that provides access to reading geolocation information, polling current location or subscribing location update events from the device. sourceCodeUrl: https://github.com/expo/expo/tree/sdk-53/packages/expo-location packageName: expo-location iconUrl: /static/images/packages/expo-location.png platforms: ["android", "ios", "web"] --- import { ConfigReactNative, ConfigPluginExample, ConfigPluginProperties, } from '~/ui/components/ConfigSection'; `expo-location` allows reading geolocation information from the device. Your app can poll for the current location or subscribe to location update events. ## Installation ## Configuration in app config You can configure `expo-location` using its built-in [config plugin](/config-plugins/introduction/) if you use config plugins in your project ([EAS Build](/build/introduction) or `npx expo run:[android|ios]`). The plugin allows you to configure various properties that cannot be set at runtime and require building a new app binary to take effect. ```json app.json { "expo": { "plugins": [ [ "expo-location", { "locationAlwaysAndWhenInUsePermission": "Allow $(PRODUCT_NAME) to use your location." } ] ] } } ``` If you're not using Continuous Native Generation ([CNG](/workflow/continuous-native-generation/)) or you're using native **ios** project manually, then you need to add the `NSLocationAlwaysAndWhenInUseUsageDescription`, `NSLocationAlwaysUsageDescription` and `NSLocationWhenInUseUsageDescription` keys to your project's **ios/[app]/Info.plist**: ```xml <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> ``` ### Background location Background location allows your app to receive location updates while it is running in the background and includes both location updates and region monitoring through geofencing. This feature is subject to platform API limitations and system constraints: - Background location will stop if the user terminates the app. - Background location resumes if the user restarts the app. - A terminated app will not automatically restart when a location or geofencing event occurs due to platform limitations. - The system will restart the terminated app when a new geofence event occurs. > **Info** On Android, the result of removing an app from the recent apps list varies by device vendor. For example, some implementations treat removing an app from the recent apps list as killing it. Read more about these differences here: [https://dontkillmyapp.com](https://dontkillmyapp.com). ### Background location configuration&ensp; To be able to run background location on iOS, you need to add the `location` value to the `UIBackgroundModes` array in your app's **Info.plist** file. **If you're using [CNG](/workflow/continuous-native-generation/)**, the required `UIBackgroundModes` configuration will be applied automatically by prebuild. If you're not using Continuous Native Generation ([CNG](/workflow/continuous-native-generation/)) or you're using a native iOS project, then you'll need to add the following to your **Expo.plist** file: ```xml ios/project-name/Supporting/Expo.plist <key>UIBackgroundModes</key> <array> <string>location</string> </array> ``` ### Background location methods To use Background Location methods, the following requirements apply: - Location permissions must be granted. - Background location task must be defined in the top-level scope, using [`TaskManager.defineTask`](task-manager.md#taskmanagerdefinetasktaskname-taskexecutor). - `"location"` background mode must be specified in **Info.plist** file. See [Background location configuration](#background-location-configuration). - You must use a [development build](/develop/development-builds/introduction/) to use background location since it is not supported in the Expo Go app. ### Geofencing methods To use Geofencing methods, the following requirements apply: - Location permissions must be granted. - The Geofencing task must be defined in the top-level scope, using [`TaskManager.defineTask`](task-manager.md#taskmanagerdefinetasktaskname-taskexecutor). When using Geofencing, the following platform differences apply: - You are allowed [up to 100](https://developer.android.com/develop/sensors-and-location/location/geofencing) active geofences per app. - Expo Location will report the initial state of the registered geofence(s) at app startup. - There is a [limit of 20](https://developer.apple.com/documentation/corelocation/monitoring_the_user_s_proximity_to_geographic_regions) `regions` that can be simultaneously monitored. ### Background permissions To use location tracking or Geofencing in the background, you must request the appropriate permissions: - On Android, you must request both foreground and background permissions. - On iOS, it must be granted with the `Always` option using [`requestBackgroundPermissionsAsync`](#locationrequestbackgroundpermissionsasync). iOS permissions are divided into the two categories `When In Use` and `Always` and maps to Expo's foreground and background location permissions requested via: - [`requestForegroundPermissionsAsync`](#locationrequestforegroundpermissionsasync) maps to `When In Use` - [`requestBackgroundPermissionsAsync`](#locationrequestbackgroundpermissionsasync) maps to `Always` > **Note:** When requesting `When In Use` authorization, the user can grant **temporary access** by selecting `Allow Once` in the system permission dialog. This authorization will be valid **only for the current app session** and is automatically revoked when the app is closed. **Detecting "Allow Once" versus "Allow While Using the App"** Unfortunately, **iOS does not provide a way to detect whether the user selected `Allow Once` or `Allow While Using the App`**. Both responses result in `When In Use` authorization. If the user selected `Allow Once` and you subsequently call [`requestBackgroundPermissionsAsync`](#locationrequestbackgroundpermissionsasync) in the same session, the system **will not show another prompt**. Instead, the request will **silently fail**, and the returned background permission status will be **denied**. **Handling "Allow Once" scenarios** If you suspect the user selected `Allow Once` and needs to request background permissions, they must **manually enable background location** in the Settings app. You can use `Linking` to open the Settings app within your app: ```js function openSettings() { Linking.openURL('app-settings:'); } ``` **Incremental permission requests** It is possible to request foreground location access first and then ask for background location access later. This can improve the user experience by requesting permissions only when necessary. **Requesting Background Permissions directly** If you call [`requestBackgroundPermissionsAsync`](#locationrequestbackgroundpermissionsasync) without first requesting foreground permissions, iOS treats it as a request for both `When In Use` and `Always` authorization. The system will then prompt the user for `When In Use` access, and the `Always` authorization prompt will be displayed when the system determines that `Always` authorization is required. Remember that the user has the option of granting your app `When In Use` authorization instead. You must always be prepared to run with `When In Use` permission. ## Deferred locations When using background locations, you can configure the location manager to defer updates. This helps save battery by reducing update frequency. You can set updates to trigger only after the device has moved a certain distance or after a specified time interval. Deferred updates are configured through [`LocationTaskOptions`](#locationtaskoptions) using the [`deferredUpdatesDistance`](#locationtaskoptions), [`deferredUpdatesInterval`](#locationtaskoptions) and [`deferredTimeout`](#locationtaskoptions) properties. > Deferred locations apply only when the app is in the background. ## Usage If you're using the Android Emulator or iOS Simulator, ensure that [Location is enabled](#enable-emulator-location). ```tsx /* @hide */ /* @end */ const [location, setLocation] = useState<Location.LocationObject | null>(null); const [errorMsg, setErrorMsg] = useState<string | null>(null); useEffect(() => { async function getCurrentLocation() { /* @hide */ if (Platform.OS === 'android' && !Device.isDevice) { setErrorMsg( 'Oops, this will not work on Snack in an Android Emulator. Try it on your device!' ); return; } /* @end */ let { status } = await Location.requestForegroundPermissionsAsync(); if (status !== 'granted') { setErrorMsg('Permission to access location was denied'); return; } let location = await Location.getCurrentPositionAsync({}); setLocation(location); } getCurrentLocation(); }, []); let text = 'Waiting...'; if (errorMsg) { text = errorMsg; } else if (location) { text = JSON.stringify(location); } return ( <View style={styles.container}> <Text style={styles.paragraph}>{text}</Text> </View> ); } const styles = StyleSheet.create({ container: { flex: 1, alignItems: 'center', justifyContent: 'center', padding: 20, }, paragraph: { fontSize: 18, textAlign: 'center', }, }); ``` ## Enable emulator location ### Android Emulator Open Android Studio, and launch the Android Emulator. Inside it, go to **Settings** > **Location** and enable **Use location**. If you don't receive the locations in the emulator, you may have to turn off the **Improve Location Accuracy** setting. This will turn off Wi-Fi location and only use GPS. Then you can manipulate the location with GPS data through the emulator. For Android 12 and higher, go to **Settings** > **Location** > **Location Services** > **Google Location Accuracy**, and turn off **Improve Location Accuracy**. For Android 11 and lower, go to **Settings** > **Location** > **Advanced** > **Google Location Accuracy**, and turn off **Google Location Accuracy**. ### iOS Simulator With Simulator open, go to **Features** > **Location** and choose any option besides **None**. ## API ```js ``` ## Permissions ### Android > **warning** Foreground and background services are not available in Expo Go for Android. Instead, we recommend using a [development build](/develop/development-builds/introduction/) to avoid limitations. When you install the `expo-location` module, it automatically adds the following permissions: - `ACCESS_COARSE_LOCATION`: for approximate device location - `ACCESS_FINE_LOCATION`: for precise device location The following permissions are optional: - `FOREGROUND_SERVICE` and `FOREGROUND_SERVICE_LOCATION`: to be able to access location while the app is open but backgrounded. `FOREGROUND_SERVICE_LOCATION` is only required as of Android 14. When you enable this in a new build, you will need to [submit your app for review and request access to use the foreground service permission](https://support.google.com/googleplay/android-developer/answer/13392821?hl=en). - `ACCESS_BACKGROUND_LOCATION`: to be able to access location while the app is backgrounded or closed. When you enable this in a new build, you will need to [submit your app for review and request access to use the background location permission](https://support.google.com/googleplay/android-developer/answer/9799150?hl=en). #### Excluding a permission > **Note**: Excluding a **required permission** from a module in your app can break the functionality corresponding to that permission. Always make sure to include all permissions a module is dependent on. When your Expo project doesn't benefit from having particular permission included, you can omit it. For example, if your application doesn't need access to the precise location, you can exclude the `ACCESS_FINE_LOCATION` permission. Another example can be stated using [available location accuracies](#accuracy). Android defines the approximate location accuracy estimation within about 3 square kilometers, and the precise location accuracy estimation within about 50 meters. For example, if the location accuracy value is [Low](#low), you can exclude `ACCESS_FINE_LOCATION` permission. To learn more about levels of location accuracies, see [Android documentation](https://developer.android.com/training/location/permissions#accuracy). To learn more on how to exclude permission, see [Excluding Android permissions](/guides/permissions/#excluding-android-permissions). ### iOS The following usage description keys are used by this library: **NSLocationAlwaysUsageDescription** and **NSLocationWhenInUseUsageDescription** are deprecated in favor of **NSLocationAlwaysAndWhenInUseUsageDescription** from iOS 11.