react-native-leaflet-routing
A React Native component using WebView to provide a Leaflet Routing.
Overview
This package is based on :
For the map :
For the routing :
These packages have each a complete documentation that I recommend to read if you want to edit this component.
Install
npm install --save react-native-leaflet-routing
Usage
Import
;
Render
<Routing // optional: map layer mapLayer=mapLayer //optional : initial region displayed initialRegion=latitude longitude // optional: coordinates of the starting point from=latitude longitude // optional: coordinates of the arriving point to=latitude longitude // optional : event functions eventReceiver=eventReceiver // optional: url of routing server urlRouter=urlRouter // optional: own position ownPositionMarker=ownPositionMarker // optional: list of markers markers=markers />
Config
mapLayer
is an optional object :
name: 'OpenStreetMap' type: 'TileLayer' url: `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png` attribution: '&copy <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
latitude
and longitude
are optional numbers.
eventReceiver
is an optional object :
{} {} {} {} {} {} {} {} {} {} {} {} {} {} {} {} {} {} {}
urlRouter
is an optional string.
markers
is an optional array of Marker
(see below the format of Marker
).
ownPositionMarker
is an optional Marker
object (see below the format of Marker
).
Marker
is an object :
coords: latitude longitude // required. latitude and longitude are number icon: '❤️' // optional. Can be an html img or string size: width height // required if icon is setted. width and height are number
Demo
There is an react native app in the example/ folder.
Debug
Browser
You can debug the app in the browser. The source code is in the web/ folder. Feel free to edit it.
To launch the debug mode
npm run dev
To build the web app in order to use it in the WebView of your react-native app. The compiled source will be in the dist/ folder
npm run build
Mobile
To launch expo
npm run start
Infos
To get your own routing server, check out the Project ORSM. For tile server, check out OSM Server.
Thanks
Special thanks to reggie3, perliedman, PaulLeCam and contributors to these projects for their great works.
Licence
ISC © sgj0