0.0.7-beta • Published 12 months ago

@amraneze/osm-autocomplete v0.0.7-beta

Weekly downloads
-
License
ISC
Repository
github
Last release
12 months ago

npm version npm npm bundle size npm bundle size GitHub release (release name instead of tag name) build

React Autocomplete using OpenStreetMap

A React component to search for addresses using OpenStreetMap

Install

npm install @amraneze/osm-autocomplete
yarn add @amraneze/osm-autocomplete

How to use

import ReactDOM from 'react-dom';
import { OpeenStreetMap, OpenStreetMapAutocomplete } from '@amraneze/osm-autocomplete';

const responseInstagram = (response) => {
  console.log(response);
};

ReactDOM.render(
  <OpenStreetMapAutocomplete value={null} onChange={handleOnOptionSelected} />,
  document.getElementById("root")
);

Note: Here is a sandbox to play around.

Parameters

paramsvaluedefault value
valueOpeenStreetMapREQUIRED
onChangefunctionREQUIRED
debouncestring500
placeholderstring'Search'
noOptionNamestring'No locations found'
openStreetMapUrlstring'https://nominatim.openstreetmap.org'
classesOpenStreetMapAutocompleteStyle-
stylesOpenStreetMapAutocompleteStyle-

Where OpeenStreetMap is

interface OpeenStreetMap {
  lat: string;
  lon: string;
  type: string;
  class: string;
  osm_id: number;
  licence: string;
  osm_type: string;
  place_id: number;
  importance: number;
  display_name: string;
  boundingbox: string[];
}

and

interface OpenStreetMapAutocompleteStyle<T> {
  root: T;
  form: T;
  inputWrapper: T;
  input: T;
  divider: T;
  button: T;
  listWrapper: T;
  options: T;
}
<OpenStreetMapAutocomplete value={value} onChange={handleOnOptionSelected} />

Running the project

Locally

Before you will run the example to test lively the component, you should run these following commands:

On the root directory

yarn link

or

npm link

On the example directory

yarn link osm-autocomplete

or

npm link osm-autocomplete

And don't forget to build the project with:

yarn build

or

npm build

or if you want to keep watching the changes on the file

yarn build:watch

or

npm build:watch

Note: If you don't build the project, you will get the error Can't resolve osm-autocomplete

Production Bundle

yarn build

or

npm build

TODO

  • Add tests
  • Add templates for PR and Issues

Follow me on Twitter: @Amraneze

0.0.7-beta

12 months ago

0.0.6

2 years ago

0.0.5

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago