Reference version

Archive Expo Snack Discord and Forums Newsletter

This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 52).

Expo Maps

GitHub

npm

A library that provides access to Google Maps on Android and Apple Maps on iOS.

Android

iOS

Expo Maps is currently in alpha and subject to breaking changes. It is not available in the Expo Go app.

Installation

Terminal

- npx expo install expo-maps

If you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.

Configuration

Expo Maps provides access to the platform native map APIs on Android and iOS.

Apple Maps (available on
iOS
only). No additional configuration is required to use it after installing this package.
Google Maps (available on
Android
only). While Google provides a Google Maps SDK for iOS, Expo Maps supports it exclusively on Android. If you want to use Google Maps on iOS, you can look into using an alternative library or writing your own.

Google Cloud API setup

Before you can use Google Maps on Android, you need to register a Google Cloud API project, enable the Maps SDK for Android, and add the associated configuration to your Expo project.

Set up Google Maps on Android

If you have already registered a project for another Google service on Android, such as Google Sign In, you enable the Maps SDK for Android on your project and jump to step 4.

Open your browser to the Google API Manager and create a project.
Once it's created, go to the project and enable the Maps SDK for Android.

Copy your app's SHA-1 certificate fingerprint

If you are deploying your app to the Google Play Store, you'll need to upload your app binary to Google Play console at least once. This is required for Google to generate your app signing credentials.
Go to the Google Play Console > (your app) > Release > Setup > App integrity > App Signing.
Copy the value of SHA-1 certificate fingerprint.

If you have already created a development build, your project will be signed using a debug keystore.
After the build is complete, go to your project's dashboard, then, under Configure > click Credentials.
Under Application Identifiers, click your project's package name and under Android Keystore copy the value of SHA-1 Certificate Fingerprint.

Create an API key

Go to Google Cloud Credential manager and click Create Credentials, then API Key.
In the modal, click Edit API key.
Under Key restrictions > Application restrictions, choose Android apps.
Under Restrict usage to your Android apps, click Add an item.
Add your android.package from app.json (for example: com.company.myapp) to the package name field.
Then, add the SHA-1 certificate fingerprint's value from step 2.
Click Done and then click Save.

Add the API key to your project

Copy your API Key into your app.json under the android.config.googleMaps.apiKey field.
Create a new development build, and you can now use the Google Maps API on Android with expo-maps.

Permissions

To display the user's location on the map, you need to declare and request location permission beforehand. You can configure this using the built-in config plugin if you use config plugins in your project (EAS Build 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.

Example app.json with config plugin

app.json

{
  "expo": {
    "plugins": [
      [
        "expo-maps",
        {
          "requestLocationPermission": "true",
          "locationPermission": "Allow $(PRODUCT_NAME) to use your location"
        }
      ]
    ]
  }
}

Configurable properties

Name	Default	Description
`requestLocationPermission`	`false`	A boolean to add permissions to AndroidManifest.xml and Info.plist.
`locationPermission`	`"Allow $(PRODUCT_NAME) to use your location"`	Only for: iOS A string to set the `NSLocationWhenInUseUsageDescription` permission message.

Usage

import { AppleMaps, GoogleMaps } from 'expo-maps';
import { Platform, Text } from 'react-native';

export default function App() {
  if (Platform.OS === 'ios') {
    return <AppleMaps.View style={{ flex: 1 }} />;
  } else if (Platform.OS === 'android') {
    return <GoogleMaps.View style={{ flex: 1 }} />;
  } else {
    return <Text>Maps are only available on Android and iOS</Text>;
  }
}

API

import { AppleMaps, GoogleMaps } from 'expo-maps';

// ApplesMaps.View and GoogleMaps.View are the React components

Components

`AppleMapsView`

iOS

Type: React.Element<AppleMapsViewProps>

AppleMapsViewProps

`annotations`

iOS

Optional • Type: AppleMapsAnnotation[]

The array of annotations to display on the map.

`cameraPosition`

iOS

Optional • Type: CameraPosition

The initial camera position of the map.

`markers`

iOS

Optional • Type: AppleMapsMarker[]

The array of markers to display on the map.

`onCameraMove`

iOS

Optional • Type:

(event: {
  bearing: number, 
  coordinates: Coordinates, 
  tilt: number, 
  zoom: number
}) => void

Lambda invoked when the map was moved by the user.

event: {
  bearing: number, 
  coordinates: Coordinates, 
  tilt: number, 
  zoom: number
}

`onMapClick`

iOS

Optional • Type:

(event: {
  coordinates: Coordinates
}) => void

Lambda invoked when the user clicks on the map. It won't be invoked if the user clicks on POI or a marker.

event: {
  coordinates: Coordinates
}

`onMarkerClick`

iOS

Optional • Type: (event: AppleMapsMarker) => void

Lambda invoked when the marker is clicked

event: AppleMapsMarker

`properties`

iOS

Optional • Type: AppleMapsProperties

The properties for the map.

`style`

iOS

Optional • Type: StyleProp<ViewStyle>

`uiSettings`

iOS

Optional • Type: AppleMapsUISettings

The MapUiSettings to be used for UI-specific settings on the map.

`GoogleMapsView`

Android

Type: React.Element<Omit<GoogleMapsViewProps, 'ref'>>

GoogleMapsViewProps

`cameraPosition`

Android

Optional • Type: CameraPosition

The initial camera position of the map.

`colorScheme`

Android

Optional • Type: GoogleMapsColorScheme

Defines the color scheme for the map.

`markers`

Android

Optional • Type: GoogleMapsMarker[]

The array of markers to display on the map.

`onCameraMove`

Android

Optional • Type:

(event: {
  bearing: number, 
  coordinates: Coordinates, 
  tilt: number, 
  zoom: number
}) => void

Lambda invoked when the map was moved by the user.

event: {
  bearing: number, 
  coordinates: Coordinates, 
  tilt: number, 
  zoom: number
}

`onMapClick`

Android

Optional • Type:

(event: {
  coordinates: Coordinates
}) => void

Lambda invoked when the user clicks on the map. It won't be invoked if the user clicks on POI or a marker.

event: {
  coordinates: Coordinates
}

`onMapLoaded`

Android

Optional • Type: () => void

Lambda invoked when the map is loaded.

`onMapLongClick`

Android

Optional • Type:

(event: {
  coordinates: Coordinates
}) => void

Lambda invoked when the user long presses on the map.

event: {
  coordinates: Coordinates
}

`onMarkerClick`

Android

Optional • Type: (event: GoogleMapsMarker) => void

Lambda invoked when the marker is clicked

event: GoogleMapsMarker

`onPOIClick`

Android

Optional • Type:

(event: {
  coordinates: Coordinates, 
  name: string
}) => void

Lambda invoked when a POI is clicked.

event: {
  coordinates: Coordinates, 
  name: string
}

`properties`

Android

Optional • Type: GoogleMapsProperties

The properties for the map.

`ref`

Android

Optional • Type: Ref<GoogleMapsViewType>

`style`

Android

Optional • Type: StyleProp<ViewStyle>

`uiSettings`

Android

Optional • Type: GoogleMapsUISettings

The MapUiSettings to be used for UI-specific settings on the map.

`userLocation`

Android

Optional • Type: GoogleMapsUserLocation

User location, overrides default behavior.

`GoogleStreetView`

Android

Type: React.Element<GoogleStreetViewProps>

GoogleStreetViewProps

`isPanningGesturesEnabled`

Android

Optional • Type: boolean

`isStreetNamesEnabled`

Android

Optional • Type: boolean

`isUserNavigationEnabled`

Android

Optional • Type: boolean

`isZoomGesturesEnabled`

Android

Optional • Type: boolean

`position`

Android

Optional • Type: Coordinates

`style`

Android

Optional • Type: StyleProp<ViewStyle>

Hooks

`useLocationPermissions(options)`

Android

iOS

Parameter	Type
options(optional)	`PermissionHookOptions<object>`

Check or request permissions to access the location. This uses both requestPermissionsAsync and getPermissionsAsync to interact with the permissions.

Returns:

[null | PermissionResponse, RequestPermissionMethod<PermissionResponse>, GetPermissionMethod<PermissionResponse>]

Example

const [status, requestPermission] = useLocationPermissions();

Methods

`Maps.getPermissionsAsync()`

Android

iOS

Checks user's permissions for accessing location.

Returns:

Promise<PermissionResponse>

A promise that fulfills with an object of type PermissionResponse.

`Maps.requestPermissionsAsync()`

Android

iOS

Asks the user to grant permissions for location.

Returns:

Promise<PermissionResponse>

A promise that fulfills with an object of type PermissionResponse.

Types

`AppleMapsAnnotation`

iOS

Type: AppleMapsMarker extended by:

Property	Type	Description
backgroundColor(optional)	`string`	The background color of the annotation.
icon(optional)	`SharedRefType<'image'>`	The custom icon to display in the annotation.
text(optional)	`string`	The text to display in the annotation.
textColor(optional)	`string`	The text color of the annotation.

`AppleMapsMarker`

iOS

Property	Type	Description
coordinates(optional)	`Coordinates`	The coordinates of the marker.
systemImage(optional)	`string`	The SF Symbol to display for the marker.
tintColor(optional)	`string`	The tint color of the marker.
title(optional)	`string`	The title of the marker, displayed in the callout when the marker is clicked.

`AppleMapsProperties`

iOS

Property	Type	Description
isTrafficEnabled(optional)	`boolean`	Whether the traffic layer is enabled on the map.
mapType(optional)	`AppleMapsMapType`	Defines which map type should be used.
selectionEnabled(optional)	`boolean`	If true, the user can select a location on the map to get more information.

`AppleMapsUISettings`

iOS

Property	Type	Description
compassEnabled(optional)	`boolean`	Whether the compass is enabled on the map. If enabled, the compass is only visible when the map is rotated.
myLocationButtonEnabled(optional)	`boolean`	Whether the my location button is visible.
scaleBarEnabled(optional)	`boolean`	Whether the scale bar is displayed when zooming.
togglePitchEnabled(optional)	`boolean`	Whether the user is allowed to change the pitch type.

`CameraPosition`

Android

iOS

Property	Type	Description
coordinates(optional)	`Coordinates`	The middle point of the camera.
zoom(optional)	`number`	The zoom level of the camera. For some view sizes, lower zoom levels might not be available.

`Coordinates`

Android

iOS

Property	Type	Description
latitude(optional)	`number`	The latitude of the coordinate.
longitude(optional)	`number`	The longitude of the coordinate.

`GoogleMapsMarker`

Android

Property	Type	Description
coordinates(optional)	`Coordinates`	The coordinates of the marker.
draggable(optional)	`boolean`	Whether the marker is draggable.
icon(optional)	`SharedRefType<'image'>`	The custom icon to display for the marker.
showCallout(optional)	`boolean`	Whether the callout should be shown when the marker is clicked.
snippet(optional)	`string`	The snippet of the marker, Displayed in the callout when the marker is clicked.
title(optional)	`string`	The title of the marker, displayed in the callout when the marker is clicked.

`GoogleMapsProperties`

Android

Property	Type	Description
isBuildingEnabled(optional)	`boolean`	Whether the building layer is enabled on the map.
isIndoorEnabled(optional)	`boolean`	Whether the indoor layer is enabled on the map.
isMyLocationEnabled(optional)	`boolean`	Whether finding the user's location is enabled on the map.
isTrafficEnabled(optional)	`boolean`	Whether the traffic layer is enabled on the map.
mapType(optional)	`GoogleMapsMapType`	Defines which map type should be used.
maxZoomPreference(optional)	`number`	The maximum zoom level for the map.
minZoomPreference(optional)	`number`	The minimum zoom level for the map.
selectionEnabled(optional)	`boolean`	If true, the user can select a location on the map to get more information.

`GoogleMapsUISettings`

Android

Property	Type	Description
compassEnabled(optional)	`boolean`	Whether the compass is enabled on the map. If enabled, the compass is only visible when the map is rotated.
indoorLevelPickerEnabled(optional)	`boolean`	Whether the indoor level picker is enabled .
mapToolbarEnabled(optional)	`boolean`	Whether the map toolbar is visible.
myLocationButtonEnabled(optional)	`boolean`	Whether the my location button is visible.
rotationGesturesEnabled(optional)	`boolean`	Whether rotate gestures are enabled.
scaleBarEnabled(optional)	`boolean`	Whether the scale bar is displayed when zooming.
scrollGesturesEnabled(optional)	`boolean`	Whether the scroll gestures are enabled.
scrollGesturesEnabledDuringRotateOrZoom(optional)	`boolean`	Whether the scroll gestures are enabled during rotation or zoom.
tiltGesturesEnabled(optional)	`boolean`	Whether the tilt gestures are enabled.
togglePitchEnabled(optional)	`boolean`	Whether the user is allowed to change the pitch type.
zoomControlsEnabled(optional)	`boolean`	Whether the zoom controls are visible.
zoomGesturesEnabled(optional)	`boolean`	Whether the zoom gestures are enabled.

`GoogleMapsUserLocation`

Android

Property	Type	Description
coordinates	`Coordinates`	User location coordinates.
followUserLocation	`boolean`	Should the camera follow the users' location.

`GoogleMapsViewType`

Android

Property	Type	Description
setCameraPosition	`(config: SetCameraPositionConfig) => void`	Update camera position. `config: SetCameraPositionConfig` New camera position config.

`SetCameraPositionConfig`

Android

Type: CameraPosition extended by:

Property	Type	Description
duration(optional)	`number`	The duration of the animation in milliseconds.

Enums

`AppleMapsMapType`

iOS

The type of map to display.

`HYBRID`

AppleMapsMapType.HYBRID ＝ "HYBRID"

A satellite image of the area with road and road name layers on top.

`IMAGERY`

AppleMapsMapType.IMAGERY ＝ "IMAGERY"

A satellite image of the area.

`STANDARD`

AppleMapsMapType.STANDARD ＝ "STANDARD"

A street map that shows the position of all roads and some road names.

`GoogleMapsColorScheme`

Android

`DARK`

GoogleMapsColorScheme.DARK ＝ "DARK"

`FOLLOW_SYSTEM`

GoogleMapsColorScheme.FOLLOW_SYSTEM ＝ "FOLLOW_SYSTEM"

`LIGHT`

GoogleMapsColorScheme.LIGHT ＝ "LIGHT"

`GoogleMapsMapType`

Android

The type of map to display.

`HYBRID`

GoogleMapsMapType.HYBRID ＝ "HYBRID"

Satellite imagery with roads and points of interest overlayed.

`NORMAL`

GoogleMapsMapType.NORMAL ＝ "NORMAL"

Standard road map.

`SATELLITE`

GoogleMapsMapType.SATELLITE ＝ "SATELLITE"

Satellite imagery.

`TERRAIN`

GoogleMapsMapType.TERRAIN ＝ "TERRAIN"

Topographic data.

Permissions

Android

To show the user's location on the map, the expo-maps library requires the following permissions:

ACCESS_COARSE_LOCATION: for approximate device location
ACCESS_FINE_LOCATION: for precise device location

Android Permission	Description
`ACCESS_COARSE_LOCATION`	Allows an app to access approximate location. Alternatively, you might want `ACCESS_FINE_LOCATION`.
`ACCESS_FINE_LOCATION`	Allows an app to access precise location. Alternatively, you might want `ACCESS_COARSE_LOCATION`.
`FOREGROUND_SERVICE`	Allows a regular application to use Service.startForeground. Allows a regular application to use `Service.startForeground`.
`FOREGROUND_SERVICE_LOCATION`	Allows a regular application to use Service.startForeground with the type "location". Allows a regular application to use `Service.startForeground` with the type "location".
`ACCESS_BACKGROUND_LOCATION`	Allows an app to access location in the background. If you're requesting this permission, you must also request either `ACCESS_COARSE_LOCATION` or `ACCESS_FINE_LOCATION`. Requesting this permission by itself doesn't give you location access.

iOS

The following usage description keys are used by this library:

Info.plist Key	Description
`NSLocationWhenInUseUsageDescription`	A message that tells the user why the app is requesting access to the user’s location information while the app is running in the foreground.