JSPM

react-native-algolia-places-extended

0.0.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q39865F
  • License MIT

React Native module to search places using Algolia Places API

Package Exports

  • react-native-algolia-places-extended

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-native-algolia-places-extended) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ReactNativeAlgoliaPlaces

ReactNativeAlgoliaPlaces is a module for React Native that helps you to create an address autocompletion based on Algolia Places. This is an enhanced version of the original react-native-algolia-places repo

Demo

Installation

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

Usage

Basic

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

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

Render Object

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

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
  • viewStyle Container Style
  • All react-native-search-box parameters, just append search before the prop name(eg. searchBeforeFocus), for more info visit React Native Search Box

Contributing

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

License

MIT