react-geolookup-v2

v2.1.7

Published

3 years ago

A React autosuggest / lookup component that can utilize the Google Maps Places API, Open Street Maps Nominatim service, or a custom Geocoding service.

Downloads

135

0High
0Medium
0Low

lampnik

react react-component google autosuggest places nominatim

React Geolookup

A React geolocation suggest component that supports Google Maps Places API, Open Street Maps Nominatim API, or your own customized Geocoding service. You can also define your own suggests as defaults. Works with Preact, too.

This component was based on a fork of the wonderful ubilabs.github.io/react-geosuggest. This fork adds several options to allow alternate geocoding services, such as Open Street Maps Nominatim, instead of the default Google Maps Places API.

Demo

Live demo: superdesk.github.io/react-geolookup

Installation

The easiest way to use geolookup is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-geolookup.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-geolookup --save

Google Places API (default):

By default this component uses the Google Maps Places API to get suggests. This requires you to include the Google Maps Places API in the <head> of your HTML:

<!DOCTYPE html>
  <html>
  <head>
    …
    <script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY_HERE&libraries=places"></script>
  </head>
  <body>
    …
  </body>
</html>

Visit the Google Developer Console to generate your API key. The API's that you have to enable in your Google API Manager Dashboard are Google Maps Geocoding API, Google Places API Web Service and [Google Maps Javascript API] (https://developers.google.com/maps/documentation/javascript/).

Open Street Maps Nominatim:

To use the Nominatim geocoding service you will need to install the nominatim-browser npm package, which you can install with:

npm install nominatim-browser --save

and import:

import * as Nominatim from 'nominatim-browser';

Then you can use the onSuggestsLookup, onGeocodeSuggest, and disableAuthLookup, or geocodeProvider options to override the default behavior.

Usage

The Geolookup works out of the box by just including it. However, you can customize the behaviour with the properties noted below.

ES6:

import Geolookup from 'react-geolookup';

<Geolookup />

ES5:

var Geolookup = require('react-geolookup').default;

<Geolookup />

Properties

placeholder

Type: String Default: Search places

The input field will get this placeholder text.

initialValue

Type: String Default: ''

An initial value for the input, when you want to prefill the suggest.

className

Type: String Default: ''

Add an additional class to the geolookup container.

style

Type: Object Default: { 'input': {}, 'suggests': {}, 'suggestItem': {} }

Add an additional style to Geolookup. This would support overriding/adding styles to the input suggestList and suggestItem.

inputClassName

Type: String Default: ''

Add an additional class to the input.

disabled

Type: Boolean Default: false

Defines whether the input is disabled.

location

Type: google.maps.LatLng Default: null

To get localized suggestions, define a location to bias the suggests.

radius

Type: Number Default: 0

The radius defines the area around the location to use for biasing the suggests. It must be accompanied by a location parameter.

bounds

Type: LatLngBounds Default: null

The bounds to use for biasing the suggests. If this is set, location and radius are ignored.

country

Type: String Default: null

Restricts predictions to the specified country (ISO 3166-1 Alpha-2 country code, case insensitive). E.g., us, br, au.

types

Type: Array Default: null

The types of predictions to be returned. Four types are supported: establishment for businesses, geocode for addresses, (regions) for administrative regions and (cities) for localities. If nothing is specified, all types are returned. Consult the Google Docs for up to date types.

fixtures

Type: Array Default: []

An array with fixtures (defaults). Each fixture has to be an object with a label key in it. Optionally provide a location, but the Geolookup will geocode the label if no location is provided.

You can also add a className key to a fixture. This class will be applied to the fixture item.

googleMaps

Type: Object Default: google.maps

In case you want to provide your own Google Maps object, pass it in as googleMaps. The default is the global google maps object.

disableAutoLookup

Type: Boolean Default: false

Set to true if you prefer to use a geocodeProvider that does not allow autocomplete lookups (Open Street Maps Nominatim service, for example). If set to true a 'Search' button will be added to the component to query for suggests.

geocodeProvider

Type: Object Default: null

Can be used to supply your own geocode provider. The provider must implement two functions:

lookup(userInput) that takes the userInput a returns a promise containing the suggestion results array. geocode(suggest) that takes a suggest object and returns a promise containing the suggestion with geocode data. This data is available in the suggest

isFixture – Type Boolean – True if the suggestion is a fixture
label – Type String – The label name
placeId – Type String – If it is a preset, equals the label. Else it is the Google Maps or geocodeProvider placeID
raw – Type Object – The the raw results returned from the lookup provider

You can use the getSuggestLabel property to set the suggestion label field.

ignoreTab

Type: Boolean Default: false

When the tab key is pressed, the onSelect handler is invoked. Set to true to not invoke onSelect on tab press.

queryDelay

Type: Number Default: 250

Sets the delay in milliseconds after typing before a request will be sent to find suggestions. Specify 0 if you wish to fetch suggestions after every keystroke.

onFocus

Type: Function Default: function() {}

Gets triggered when the input field receives focus.

onBlur

Type: Function Default: function(value) {}

Gets triggered when input field loses focus.

onChange

Type: Function Default: function(value) {}

Gets triggered when input field changes the value.

onKeyPress

Type: Function Default: function(event) {}

Gets triggered when input field gets key press.

onGeocodeSuggest

Type: Function Default: function(suggest) {}

Can be used to override the default geocode behavior for a selected suggest. Should return the suggest with added geocoded data. This data is available:

isFixture – Type Boolean – True if the suggestion is a fixture
label – Type String – The label name
placeId – Type String – If it is a preset, equals the label. Else it is the Google Maps placeID
raw – Type Object – The the raw results returned from the lookup provider

onSuggestsLookup

Type: Function Default: function(userInput) {}

Can be used to override the default lookup behavior for user input. Gets triggered when user input changes, or when Search button is clicked if disableAutoLookup is set to true. Should return a promise containing lookup results array.

onSuggestSelect

Type: Function Default: function(suggest) {}

Gets triggered when a suggest got selected. Only parameter is an object with data of the selected suggest. This data is available:

label – Type String – The label name
placeId – Type String – If it is a preset, equals the label. Else it is the Google Maps placeID
location – Type Object – The location containing lat and lng
gmaps – Type Object – Optional! The complete response when there was a Google Maps geocode necessary (e.g. no location provided for presets). Check the Google Maps Reference for more information on it’s structure.

onActivateSuggest

Type: Function Default: function(suggest) {}

Gets triggered when a suggest is activated in the list. Only parameter is an object with data of the selected suggest. This data is available:

label – Type String – The label name
placeId – Type String – If it is a preset, equals the label. Else it is the Google Maps placeID

onSuggestResults

Type: Function Default: function(suggests) {}

Gets triggered when there suggest results are returned

onSuggestNoResults

Type: Function Default: function(userInput) {}

Gets triggered when there are no suggest results found

getSuggestLabel

Type: Function Default: function(suggest) { return suggest.description; }

Used to generate a custom label for a suggest. Only parameter is a suggest (google.maps.places.AutocompletePrediction). Check the Google Maps Reference for more information on it’s structure.

skipSuggest

Type: Function Default: function(suggest) {}

If the function returns true then the suggest will not be included in the displayed results. Only parameter is an object with data of the selected suggest. (See above)

autoActivateFirstSuggest

Type: Boolean Default: false

Automatically activate the first suggestion as you type. If false, the exact term(s) in the input will be used when searching and may return a result not in the list of suggestions.

label

Type: String Default: null

If the label and a id prop (see "Others") were supplied, a <label> tag with the passed label text will be rendered. The <label> element's for attribute will correctly point to the id of the <input> element.

suggestsHiddenClassName

Type: String Default: null

Additional className to toggle as the list of suggestions changes visibility.

suggestItemActiveClassName

Type: String, Default: null

Additional className to add when a suggestion item is active.

Others

All allowed attributes for input[type="text"] All DOM clipboard events.
All DOM mouse events except for drag & drop.

Exposed component functions

These functions are accessible by setting "ref" on the component (see example below)

focus()

Call focus to focus on the element. The suggest list will be expanded with the current suggestions.

blur()

Call blur to blur (unfocus) the element. The suggest list will be closed.

update(value)

It is possible to update the value of the input contained within the GeoLookup component by calling the update function with a new desired value of the type String.

clear()

It is also possible to clear the value of the input contained within the GeoLookup component by calling the clear function.

Google Places API Example

import React from 'react';
import ReactDOM from 'react-dom';
import Geolookup from 'react-geolookup';

var App = React.createClass({
  /**
   * Render the example app
   */
  render: function() {
    var fixtures = [
      {label: 'Old Elbe Tunnel, Hamburg', location: {lat: 53.5459, lng: 9.966576}},
      {label: 'Reeperbahn, Hamburg', location: {lat: 53.5495629, lng: 9.9625838}},
      {label: 'Alster, Hamburg', location: {lat: 53.5610398, lng: 10.0259135}}
    ];

    return (
      <div>
        <Geolookup
          ref={el=>this._geoSuggest=el}
          placeholder="Start typing!"
          initialValue="Hamburg"
          fixtures={fixtures}
          onSuggestSelect={this.onSuggestSelect}
          location={new google.maps.LatLng(53.558572, 9.9278215)}
          radius="20" />

        {* Buttons to trigger exposed component functions *}
        <button onClick={()=>this._geoSuggest.focus()}>Focus</button>
        <button onClick={()=>this._geoSuggest.update('New Zeland')}>Update</button>
        <button onClick={()=>this._geoSuggest.clear()}>Clear</button>
      </div>
    )
  },

  /**
   * When a suggest got selected
   * @param  {Object} suggest The suggest
   */
  onSuggestSelect: function(suggest) {
    console.log(suggest);
  }
});

ReactDOM.render(<App />, document.getElementById('app'));

Nominatim Example:

import React from 'react';
import ReactDOM from 'react-dom';
import Geolookup from '../../src/Geolookup';
// IMPORTANT: nomintim-browser is only included in dev dependencies
import * as Nominatim from 'nominatim-browser';

var App = React.createClass({ 
  render: function() {
    return ( 
      <div>
        <Geolookup
          inputClassName="geolookup__input--nominatim"
          disableAutoLookup={true}
          onSuggestsLookup={this.onSuggestsLookup}
          onGeocodeSuggest={this.onGeocodeSuggest}
          getSuggestLabel={this.getSuggestLabel}
          radius="20" />
      </div>
    );
  },

  onSuggestsLookup: function(userInput) {
    return Nominatim.geocode({
      q: userInput,
      addressdetails: true
    });
  },

  onGeocodeSuggest: function(suggest) {
    let geocoded = {};
    if (suggest) {
      geocoded.nominatim = suggest.raw || {};
      geocoded.location = {
        lat: suggest.raw ? suggest.raw.lat : '',
        lon: suggest.raw ? suggest.raw.lon : ''
      };
      geocoded.placeId = suggest.placeId;
      geocoded.isFixture = suggest.isFixture;
      geocoded.label = suggest.raw ? suggest.raw.display_name : '';
    }
    return geocoded;
  },
  
  getSuggestLabel: function(suggest) {
    return suggest.display_name;
  }
});

ReactDOM.render(<App />, document.getElementById('app'));

Styling

This component uses BEM for namespacing the CSS classes. So styling should be easy and without conflicts. See the geolookup.css for an example styling.

Note:

The geolookup__suggests--hidden class is added to hide the suggestion list. You should copy the style below into your CSS file.

.geolookup__suggests--hidden {
  max-height: 0;
  overflow: hidden;
  border-width: 0;
}

The above class is added whenever the suggestion list needs to be hidden. This occurs when the user selects an item from the list or when the user triggers the blur event on the input.

Similarly, you need to have the class geolookup__item--active similar to this:

.geolookup__item--active {
  background: #267dc0;
  color: #fff;
}

to see what item is selected, f.ex. when using the arrow keys to navigate the suggestion list.

Contributing

Issues and pull requests are welcome!
Please read the guidelines in CONTRIBUTING.md before starting to work on a PR.

License

See LICENSE.md

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

React Geolookup

Demo

Installation

Google Places API (default):

Open Street Maps Nominatim:

Usage

ES6:

ES5:

Properties

placeholder

initialValue

className

style

inputClassName

disabled

location

radius

bounds

country

types

fixtures

googleMaps

disableAutoLookup

geocodeProvider

ignoreTab

queryDelay

onFocus

onBlur

onChange

onKeyPress

onGeocodeSuggest

onSuggestsLookup

onSuggestSelect

onActivateSuggest

onSuggestResults

onSuggestNoResults

getSuggestLabel

skipSuggest

autoActivateFirstSuggest

label

suggestsHiddenClassName

suggestItemActiveClassName

Others

Exposed component functions

focus()

blur()

update(value)

clear()

Google Places API Example

Nominatim Example:

Styling

Note:

Contributing

License