lucalas / react-native-algolia-places

React Native module to search places using Algolia Places API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ReactNativeAlgoliaPlaces

ReactNativeAlgoliaPlaces is a module for React Native that helps you to create an address autocompletion based on Algolia Places

Demo

Installation

npm i react-native-algolia-places --save

Usage

Basic

import ReactNativeAlgoliaPlaces from 'react-native-algolia-places'

render() {
    <ReactNativeAlgoliaPlaces appId={"appId"} appKey={"appKey"} />
}

Render Object

import ReactNativeAlgoliaPlaces from 'react-native-algolia-places'

render() {
    <ReactNativeAlgoliaPlaces appId={"appId"} appKey={"appKey"} 
      itemList={(item, i, textSearch) => 
           <Text key={i + "item"}>item.locale_names[0]</Text>
      }/>
}

Properties

  • appId The Places application ID to use
  • appKey The Places search API key to use
  • onSearchError When api request return an error
  • itemList(item, i, textSearch) Custom render object for items in list (recommended)
    • item = Item retrieved based on text searched
    • i = Counter of items
    • textSearch = Text searched
  • options (For detail see Algolia Places Documentation)
    • language
    • countries
    • hitsPerPage
    • type
    • aroundLatLng
    • aroundLatLngViaIP
    • aroundRadius
    • insideBoundingBox
    • insidePolygon
    • getRankingInfo

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

About

React Native module to search places using Algolia Places API

License:MIT License


Languages

Language:JavaScript 100.0%