react-native-maps
React Native Map components for iOS + Android
Installation
See Installation Instructions.
Compatibility
Due to the rapid changes being made in the React Native ecosystem, we are not officially going to
support this module on anything but the latest version of React Native. With that said, we will do
our best to stay compatible with older versions as much that is practical, and the peer dependency
of this requirement is set to "react-native": "*"
explicitly for this reason. If you are using
an older version of React Native with this module though, some features may be buggy.
General Usage
;
or
var MapView = ;
This MapView component is built so that features on the map (such as Markers, Polygons, etc.) are specified as children of the MapView itself. This provides an intuitive and react-like API for declaratively controlling features on the map.
Rendering a Map with an initial region
When you render a MapView, this one need to be in absolute position with the top, left, right and bottom props set. If not you gonna have a blank view.
Styles
const styles = StyleSheet;
MapView
<MapView = = />
Using a MapView while controlling the region as state
{ return latitude: 3778825 longitude: -1224324 latitudeDelta: 00922 longitudeDelta: 00421 ;} { this;} { return <MapView = = /> ;}
Rendering a list of markers on a map
<MapView = => thisstatemarkers</MapView>
Rendering a Marker with a custom view
<MapView.Marker => <MyCustomMarkerView /></MapView.Marker>
Rendering a Marker with a custom image
<MapView.Marker = =/>
Rendering a custom Marker with a custom Callout
<MapView.Marker => <MyCustomMarkerView /> <MapView.Callout> <MyCustomCalloutView /> </MapView.Callout></MapView.Marker>
Draggable Markers
<MapView => <MapView.Marker = = /></MapView>
Examples
MapView Events
The <MapView />
component and its child components have several events that you can subscribe to.
This example displays some of them in a log as a demonstration.
Tracking Region / Location
Programmatically Changing Region
One can change the mapview's position using refs and component methods, or by passing in an updated
region
prop. The component methods will allow one to animate to a given position like the native
API could.
Arbitrary React Views as Markers
Using the MapView with the Animated API
The <MapView />
component can be made to work with the Animated API, having the entire region
prop
be declared as an animated value. This allows one to animate the zoom and position of the MapView along
with other gestures, giving a nice feel.
Further, Marker views can use the animated API to enhance the effect.
Issue: Since android needs to render its marker views as a bitmap, the animations APIs may not be compatible with the Marker views. Not sure if this can be worked around yet or not.
Markers' coordinates can also be animated, as shown in this example:
Polygon Creator
Other Overlays
So far, <Circle />
, <Polygon />
, and <Polyline />
are available to pass in as children to the
<MapView />
component.
Default Markers
Default markers will be rendered unless a custom marker is specified. One can optionally adjust the
color of the default marker by using the pinColor
prop.
Custom Callouts
Callouts to markers can be completely arbitrary react views, similar to markers. As a result, they can be interacted with like any other view.
Additionally, you can fall back to the standard behavior of just having a title/description through
the <Marker />
's title
and description
props.
Custom callout views can be the entire tooltip bubble, or just the content inside of the system default bubble.
Image-based Markers
Markers can be customized by just using images, and specified using the image
prop.
Draggable Markers
Markers are draggable, and emit continuous drag events to update other UI during drags.
Component API
<MapView.Marker />
Component API
<MapView.Callout />
Component API
<MapView.Polygon />
Component API
<MapView.Polyline />
Component API
<MapView.Circle />
Component API
Using with the Animated API
The API of this Map has been built with the intention of it being able to utilize the Animated API.
In order to get this to work, you will need to modify the AnimatedImplementation.js
file in the
source of react-native with this one.
Ideally this will be possible in the near future without this modification.
Animated Region
The MapView can accept an Animated.Region
value as its region
prop. This allows you to utilize
the Animated API to control the map's center and zoom.
{ return region: latitude: LATITUDE longitude: LONGITUDE latitudeDelta: LATITUDE_DELTA longitudeDelta: LONGITUDE_DELTA ;} { thisstateregion;} { return <MapView.Animated = = /> ;}
Animated Marker Position
Markers can also accept an Animated.Region
value as a coordinate.
{ return coordinate: latitude: LATITUDE longitude: LONGITUDE ;} { return <MapView => <MapView.Marker.Animated = /> </MapView> ;}