Google Maps Search Component for React Native

Customizable Google Places autocomplete component for iOS and Android React-Native apps

Sponsor

The financial management super app for expenses, corporate cards, and more.

Preview

Installation

Step 1.

npm install react-native-google-places-autocomplete --save

or

yarn add react-native-google-places-autocomplete

Step 2.

Get your Google Places API keys and enable "Google Places API Web Service" (NOT Android or iOS) in the console. Billing must be enabled on the account.

Step 3.

Enable "Google Maps Geocoding API" if you want to use GoogleReverseGeocoding for Current Location

Basic Example

Basic Address Search

1import React from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4const GooglePlacesInput = () => {
5  return (
6    <GooglePlacesAutocomplete
7      placeholder='Search'
8      onPress={(data, details = null) => {
9        // 'details' is provided when fetchDetails = true
10        console.log(data, details);
11      }}
12      query={{
13        key: 'YOUR API KEY',
14        language: 'en',
15      }}
16    />
17  );
18};
19
20export default GooglePlacesInput;

You can also try the basic example in a snack here

More Examples

Get Current Location

1import React from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4// navigator.geolocation = require('@react-native-community/geolocation');
5// navigator.geolocation = require('react-native-geolocation-service');
6
7const GooglePlacesInput = () => {
8  return (
9    <GooglePlacesAutocomplete
10      placeholder='Search'
11      onPress={(data, details = null) => {
12        // 'details' is provided when fetchDetails = true
13        console.log(data, details);
14      }}
15      query={{
16        key: 'YOUR API KEY',
17        language: 'en',
18      }}
19      currentLocation={true}
20      currentLocationLabel='Current location'
21    />
22  );
23};
24
25export default GooglePlacesInput;

Search with predefined option

1import React from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4const homePlace = {
5  description: 'Home',
6  geometry: { location: { lat: 48.8152937, lng: 2.4597668 } },
7};
8const workPlace = {
9  description: 'Work',
10  geometry: { location: { lat: 48.8496818, lng: 2.2940881 } },
11};
12
13const GooglePlacesInput = () => {
14  return (
15    <GooglePlacesAutocomplete
16      placeholder='Search'
17      onPress={(data, details = null) => {
18        // 'details' is provided when fetchDetails = true
19        console.log(data, details);
20      }}
21      query={{
22        key: 'YOUR API KEY',
23        language: 'en',
24      }}
25      predefinedPlaces={[homePlace, workPlace]}
26    />
27  );
28};
29
30export default GooglePlacesInput;

Limit results to one country

1import React from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4const GooglePlacesInput = () => {
5  return (
6    <GooglePlacesAutocomplete
7      placeholder='Search'
8      onPress={(data, details = null) => {
9        // 'details' is provided when fetchDetails = true
10        console.log(data, details);
11      }}
12      query={{
13        key: 'YOUR API KEY',
14        language: 'en',
15        components: 'country:us',
16      }}
17    />
18  );
19};
20
21export default GooglePlacesInput;

Use a custom Text Input Component

1import React from 'react';
2import { Text, View, Image } from 'react-native';
3import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
4import { Input } from 'react-native-elements';
5
6const GOOGLE_PLACES_API_KEY = 'YOUR_GOOGLE_API_KEY';
7
8const GooglePlacesInput = () => {
9  return (
10    <GooglePlacesAutocomplete
11      query={{
12        key: GOOGLE_PLACES_API_KEY,
13        language: 'en', // language of the results
14      }}
15      onPress={(data, details) => console.log(data, details)}
16      textInputProps={{
17        InputComp: Input,
18        leftIcon: { type: 'font-awesome', name: 'chevron-left' },
19        errorStyle: { color: 'red' },
20      }}
21    />
22  );
23};
24
25export default GooglePlacesInput;

Props

This list is a work in progress. PRs welcome!

Methods

You can access these methods using a ref.

Example

1import React, { useEffect, useRef } from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4const GooglePlacesInput = () => {
5  const ref = useRef();
6
7  useEffect(() => {
8    ref.current?.setAddressText('Some Text');
9  }, []);
10
11  return (
12    <GooglePlacesAutocomplete
13      ref={ref}
14      placeholder='Search'
15      onPress={(data, details = null) => {
16        // 'details' is provided when fetchDetails = true
17        console.log(data, details);
18      }}
19      query={{
20        key: 'YOUR API KEY',
21        language: 'en',
22      }}
23    />
24  );
25};
26
27export default GooglePlacesInput;

Styling

GooglePlacesAutocomplete can be easily customized to meet styles of your app. Pass styles props to GooglePlacesAutocomplete with style object for different elements (keys for style object are listed below)

Example

1<GooglePlacesAutocomplete
2  placeholder='Enter Location'
3  minLength={2}
4  autoFocus={false}
5  returnKeyType={'default'}
6  fetchDetails={true}
7  styles={{
8    textInputContainer: {
9      backgroundColor: 'grey',
10    },
11    textInput: {
12      height: 38,
13      color: '#5d5d5d',
14      fontSize: 16,
15    },
16    predefinedPlacesDescription: {
17      color: '#1faadb',
18    },
19  }}
20/>

Default Styles

1{
2  container: {
3    flex: 1,
4  },
5  textInputContainer: {
6    flexDirection: 'row',
7  },
8  textInput: {
9    backgroundColor: '#FFFFFF',
10    height: 44,
11    borderRadius: 5,
12    paddingVertical: 5,
13    paddingHorizontal: 10,
14    fontSize: 15,
15    flex: 1,
16  },
17  poweredContainer: {
18    justifyContent: 'flex-end',
19    alignItems: 'center',
20    borderBottomRightRadius: 5,
21    borderBottomLeftRadius: 5,
22    borderColor: '#c8c7cc',
23    borderTopWidth: 0.5,
24  },
25  powered: {},
26  listView: {},
27  row: {
28    backgroundColor: '#FFFFFF',
29    padding: 13,
30    height: 44,
31    flexDirection: 'row',
32  },
33  separator: {
34    height: 0.5,
35    backgroundColor: '#c8c7cc',
36  },
37  description: {},
38  loader: {
39    flexDirection: 'row',
40    justifyContent: 'flex-end',
41    height: 20,
42  },
43}

Web Support

Web support can be enabled via the requestUrl prop, by passing in a URL that you can use to proxy your requests. CORS implemented by the Google Places API prevent using this library directly on the web. You will need to use a proxy server. Please be mindful of this limitation when opening an issue.

The requestUrl prop takes an object with two required properties: useOnPlatform and url, and an optional headers property.

The url property is used to set the url that requests will be made to. If you are using the regular google maps API, you need to make sure you are ultimately hitting https://maps.googleapis.com/maps/api.

useOnPlatform configures when the proxy url is used. It can be set to either web- will be used only when the device platform is detected as web (but not iOS or Android, or all - will always be used.

You can optionally specify headers to apply to your request in the headers object.

Example:

1import React from 'react';
2import { GooglePlacesAutocomplete } from 'react-native-google-places-autocomplete';
3
4const GooglePlacesInput = () => {
5  return (
6    <GooglePlacesAutocomplete
7      placeholder='Search'
8      onPress={(data, details = null) => {
9        // 'details' is provided when fetchDetails = true
10        console.log(data, details);
11      }}
12      query={{
13        key: 'YOUR API KEY',
14        language: 'en',
15      }}
16      requestUrl={{
17        useOnPlatform: 'web', // or "all"
18        url:
19          'https://cors-anywhere.herokuapp.com/https://maps.googleapis.com/maps/api', // or any proxy server that hits https://maps.googleapis.com/maps/api
20        headers: {
21          Authorization: `an auth token`, // if required for your proxy
22        },
23      }}
24    />
25  );
26};
27
28export default GooglePlacesInput;

Note: The library expects the same response that the Google Maps API would return.

Features

• Places autocompletion
• iOS and Android compatibility
• Places details fetching + ActivityIndicatorIOS/ProgressBarAndroid loaders
• Customizable using the styles parameter
• XHR cancellations when typing fast
• Google Places terms compliant
• Predefined places
• typescript types
• Current location

Compatibility

This library does not use the iOS, Android or JS SDKs from Google. This comes with some Pros and Cons.

Pros:

• smaller app size
• better privacy for your users (although Google still tracks server calls)
• no need to keep up with sdk updates

Cons:

• the library is not compatible with a Application key restrictions
• doesn't work directly on the web without a proxy server
• any Google API change can be a breaking change for the library.

Use Inside a <ScrollView/> or <FlatList/>

If you need to include this component inside a ScrolView or FlatList, remember to apply the keyboardShouldPersistTaps attribute to all ancestors ScrollView or FlatList (see this issue comment).

A word about the Google Maps APIs

Google Provides a bunch of web APIs for finding an address or place, and getting it’s details. There are the Google Places Web APIs (Place Search, Place Details, Place Photos, Place Autocomplete, Query Autocomplete) and the Google Geocode API .

The 5 Google Places Web APIs are:

• Place Autocomplete - automatically fills in the name and/or address of a place as users type.
• Place Details - returns more detailed information about a specific place (using a place_id that you get from Place Search, Place Autocomplete, or Query Autocomplete).
• Place Photos - provides access to the millions of place-related photos stored in Google's Place database (using a reference_id that you get from Place Search, Place Autocomplete, or Query Autocomplete).
• Place Search - returns a list of places based on a user's location or search string.
• Query Autocomplete - provides a query prediction service for text-based geographic searches, returning suggested queries as users type.

The Geocoding API allows you to convert an address into geographic coordinates (lat, long) and to "reverse geocode", which is the process of converting geographic coordinates into a human-readable address.

Which APIs does this library use?

Place Autocomplete API, Place Details API, Place Search API and the Geocoding API.

We use the Place Autocomplete API to get suggestions as you type. When you click on a suggestion, we use the Place Details API to get more information about the place.

We use the Geocoding API and the Place Search API to use your current location to get results.

Because the query parameters are different for each API, there are 4 different "query" props.

1. Autocomplete -> query (options)
2. Place Details -> GooglePlacesDetailsQuery (options)
3. Nearby Search -> GooglePlacesSearchQuery (options)
4. Geocode -> GoogleReverseGeocodingQuery (options)

Number 1 is used while getting autocomplete results.
Number 2 is used when you click on a result.
Number 3 is used when you select 'Current Location' to load nearby results.
Number 4 is used when nearbyPlacesAPI='GoogleReverseGeocoding' is set and you select 'Current Location' to load nearby results.

Changelog

Please see the releases tab for the changelog information.

License

MIT

Authors

• Farid Safi
• Maxim Yaskevich
• Guilherme Pontes