1.0.4 • Published 11 months ago

@tasiodev/react-places-autocomplete v1.0.4

Weekly downloads
-
License
-
Repository
github
Last release
11 months ago

React Places Autocomplete

Component used as a field in a form to autocomplete a place, using the Google Maps API.

The place can be a city, a country, a street, or even an establishment.

alt text

Demo

https://react-places-autocomplete-demo.up.railway.app

Features

  • Map with the selected place
  • Limit the type of places you want to retrieve
  • Fully customizable

Requisites

To use this component, you will need a Google API key. Here is more information on how to obtain it: https://developers.google.com/maps/documentation/javascript/get-api-key

You will also need to enable these two APIs:

  • Places API
  • Maps JavaScript API

Exposing your API key in the front-end code of your application can pose significant security risks. Unauthorized access to your API key may lead to unauthorized usage.

Is highly recommended to store it in a separate configuration file, such as the .env file.

Additionally, we strongly recommend that you restrict the usage of your API key using the available configuration options. https://developers.google.com/maps/api-security-best-practices#restrict_apikey

Installation and Basic Example

  npm install @tasiodev/react-places-autocomplete
import { useState } from 'react'
import PlacesPicker from '@tasiodev/react-places-autocomplete'

function App() {
  const [value, setValue] = useState(null)
  return  <PlacesPicker
        gMapsKey='*******************'
        placeId={value}
        onChange={setValue}
      />
}

Props Reference

ParameterTypeDescription
gMapsKeystringRequired. Your API key
placeIdstringId used to load an initial or stored place
onChangefuncEvent triggered when user select a place or when user starts typing to search a place
onSelectPlacefuncEvent triggered when user select a place
placeholderstringPlaceholder for input
searchTypesarray[string]Limit the place types return in a search. See: https://developers.google.com/maps/documentation/places/web-service/supported_types
languagestringISO code for map and results language. Default: "en"
disableMapboolBoolean to disable place Map. Default: false
mapExpandedboolIf true, the map is always visible. Default: false
disabledboolBoolean to disable input
customStylesobjectObject to override styles of each element. See definitions

customStyles example

{
    container: { backgroundColor: 'black' },
    fieldInput: { color: 'red' },
    searchResultsContainer: { marginTop: 12 },
    searchResult: { padding: 6 },
    gmapContainer: { padding: 8, height: 400 },
}
1.0.2

11 months ago

1.0.1

11 months ago

1.0.4

11 months ago

1.0.3

11 months ago

1.0.0

11 months ago

0.1.9

11 months ago

0.1.8

11 months ago

0.1.7

11 months ago

0.1.6

11 months ago

0.1.5

11 months ago

0.1.4

11 months ago

0.1.3

11 months ago

0.1.2

11 months ago

0.1.1

11 months ago

0.1.0

11 months ago