nuǝɯ pǝɥsᴉꞁod mǝu

    @react-native-community/geolocation
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.5 • Public • Published

    @react-native-community/geolocation

    npm Supports Android, iOS and web MIT License

    The Geolocation API 📍 module for React Native that extends the Geolocation web spec.

    Supports TurboModules ⚡️ and legacy React Native architecture.

    Fully compatible with TypeScript.

    Supports modern Play Services Location API.

    Supported platforms

    Platform Support
    iOS
    Android
    Web
    Windows
    macOS

    Getting started

    yarn add @react-native-community/geolocation

    or

    npm install @react-native-community/geolocation --save

    Configuration and Permissions

    Projects with Native Code Only

    This section only applies to projects made with react-native init or to those made with expo init or Create React Native App which have since ejected. For more information about ejecting, please see the guide on the Create React Native App repository.

    iOS

    You need to include NSLocationWhenInUseUsageDescription and NSLocationAlwaysAndWhenInUseUsageDescription in Info.plist to enable geolocation when using the app. If your app supports iOS 10 and earlier, the NSLocationAlwaysUsageDescription key is also required. If these keys are not present in the Info.plist, authorization requests fail immediately and silently. 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.

    IOS >= 15 Positions will also contain a mocked boolean to indicate if position was created from a mock provider / software.

    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" />

    or

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

    Android API >= 18 Positions will also contain a mocked boolean to indicate if position was created from a mock provider.

    Android API >= 23 Requires an additional step to check for, and request the ACCESS_FINE_LOCATION or ACCESS_COARSE_LOCATION permissions using the PermissionsAndroid API. Failure to do so may result in a hard crash.

    Migrating from the core react-native module

    This module was created when the Geolocation was split out from the core of React Native. As a browser polyfill, this API was available through the navigator.geolocation global - you didn't need to import it. To migrate to this module you need to follow the installation instructions above and change following code:

    navigator.geolocation.setRNConfiguration(config);

    to:

    import Geolocation from '@react-native-community/geolocation';
    
    Geolocation.setRNConfiguration(config);

    If you need to have geolocation API aligned with the browser (cross-platform apps), or want to support backward compatibility, please consider adding following lines at the root level, for example at the top of your App.js file (only for react native):

    navigator.geolocation = require('@react-native-community/geolocation');

    Usage

    Example

    import Geolocation from '@react-native-community/geolocation';
    
    Geolocation.getCurrentPosition(info => console.log(info));

    Check out the example project for more examples.

    Methods

    Summary


    Details

    setRNConfiguration()

    Sets configuration options that will be used in all location requests.

    Geolocation.setRNConfiguration(
      config: {
        skipPermissionRequests: boolean;
        authorizationLevel?: 'always' | 'whenInUse' | 'auto';
        locationProvider?: 'playServices' | 'android' | 'auto';
      }
    ) => void

    Supported options:

    • skipPermissionRequests (boolean) - Defaults to false. If true, you must request permissions before using Geolocation APIs.
    • authorizationLevel (string, iOS-only) - Either "whenInUse", "always", or "auto". Changes whether the user will be asked to give "always" or "when in use" location services permission. Any other value or auto will use the default behaviour, where the permission level is based on the contents of your Info.plist.
    • locationProvider (string, Android-only) - Either "playServices", "android", or "auto". Determines wether to use Google’s Location Services API or Android’s Location API. The "auto" mode defaults to android, and falls back to Android's Location API if play services aren't available.

    requestAuthorization()

    Request suitable Location permission.

      Geolocation.requestAuthorization(
        success?: () => void,
        error?: (
          error: {
            code: number;
            message: string;
            PERMISSION_DENIED: number;
            POSITION_UNAVAILABLE: number;
            TIMEOUT: number;
          }
        ) => void
      )

    On iOS if NSLocationAlwaysUsageDescription is set, it will request Always authorization, although if NSLocationWhenInUseUsageDescription is set, it will request InUse authorization.


    getCurrentPosition()

    Invokes the success callback once with the latest location info.

      Geolocation.getCurrentPosition(
        success: (
          position: {
            coords: {
              latitude: number;
              longitude: number;
              altitude: number | null;
              accuracy: number;
              altitudeAccuracy: number | null;
              heading: number | null;
              speed: number | null;
            };
            timestamp: number;
          }
        ) => void,
        error?: (
          error: {
            code: number;
            message: string;
            PERMISSION_DENIED: number;
            POSITION_UNAVAILABLE: number;
            TIMEOUT: number;
          }
        ) => void,
        options?: {
            timeout?: number;
            maximumAge?: number;
            enableHighAccuracy?: boolean;
        }
      )

    Supported options:

    • timeout (ms) - Is a positive value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. Defaults to 10 minutes.
    • maximumAge (ms) - Is a positive value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to Infinity the device will always return a cached position regardless of its age. Defaults to INFINITY.
    • enableHighAccuracy (bool) - Is a boolean representing if to use GPS or not. If set to true, a GPS position will be requested. If set to false, a WIFI location will be requested.

    watchPosition()

    Invokes the success callback whenever the location changes. Returns a watchId (number).

      Geolocation.watchPosition(
        success: (
          position: {
            coords: {
              latitude: number;
              longitude: number;
              altitude: number | null;
              accuracy: number;
              altitudeAccuracy: number | null;
              heading: number | null;
              speed: number | null;
            };
            timestamp: number;
          }
        ) => void,
        error?: (
          error: {
            code: number;
            message: string;
            PERMISSION_DENIED: number;
            POSITION_UNAVAILABLE: number;
            TIMEOUT: number;
          }
        ) => void,
        options?: {
          interval?: number;
          fastestInterval?: number;
          timeout?: number;
          maximumAge?: number;
          enableHighAccuracy?: boolean;
          distanceFilter?: number;
          useSignificantChanges?: boolean;
        }
      ) => number

    Supported options:

    • interval (ms) -- (Android only) The rate in milliseconds at which your app prefers to receive location updates. Note that the location updates may be somewhat faster or slower than this rate to optimize for battery usage, or there may be no updates at all (if the device has no connectivity, for example).
    • fastestInterval (ms) -- (Android only) The fastest rate in milliseconds at which your app can handle location updates. Unless your app benefits from receiving updates more quickly than the rate specified in interval, you don't need to set it.
    • timeout (ms) - Is a positive value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. Defaults to 10 minutes.
    • maximumAge (ms) - Is a positive value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. If set to Infinity the device will always return a cached position regardless of its age. Defaults to INFINITY.
    • enableHighAccuracy (bool) - Is a boolean representing if to use GPS or not. If set to true, a GPS position will be requested. If set to false, a WIFI location will be requested.
    • distanceFilter (m) - The minimum distance from the previous location to exceed before returning a new location. Set to 0 to not filter locations. Defaults to 100m.
    • useSignificantChanges (bool) - Uses the battery-efficient native significant changes APIs to return locations. Locations will only be returned when the device detects a significant distance has been breached. Defaults to FALSE.

    clearWatch()

    Clears watch observer by id returned by watchPosition()

    Geolocation.clearWatch(watchID: number);

    Maintainers

    This module is developed and maintained by michalchudziak.

    I owe a lot to the fantastic React & React Native community, and I contribute back with my free time 👨🏼‍💼💻 so if you like the project, please star it ⭐️!

    If you need any help with this module, or anything else, feel free to reach out to me! I provide boutique consultancy services for React & React Native. Just visit my website, or send me an email at hello@michalchudziak.dev 🙏🏻

    Contributors

    This module was extracted from react-native core. Please reffer to https://github.com/react-native-community/react-native-geolocation/graphs/contributors for the complete list of contributors.

    License

    The library is released under the MIT licence. For more information see LICENSE.

    Install

    npm i @react-native-community/geolocation

    DownloadsWeekly Downloads

    58,221

    Version

    3.0.5

    License

    MIT

    Unpacked Size

    233 kB

    Total Files

    69

    Last publish

    Collaborators

    • mattoakes
    • mike866