React Native Map Clustering

React Native module that handles map clustering for you.

Works with Expo and react-native-cli 🚀

This repo is proudly sponsored by:

NativeForms - Build forms, surveys and polls for React Native apps.

Demo

Installation

// clustering module
npm install react-native-map-clustering --save

// and only if you haven't installed it before
npm install react-native-maps --save

Full example

Example of how to use clustering.

import React from "react";
import MapView from "react-native-map-clustering";
import { Marker } from "react-native-maps";

const INITIAL_REGION = {
  latitude: 52.5,
  longitude: 19.2,
  latitudeDelta: 8.5,
  longitudeDelta: 8.5
};

const App = () => (
  <MapView region={INITIAL_REGION} style={{ flex: 1 }}>
    <Marker coordinate={{ latitude: 52.0, longitude: 18.2 }} />
    <Marker coordinate={{ latitude: 52.4, longitude: 18.7 }} />
    <Marker coordinate={{ latitude: 52.1, longitude: 18.4 }} />
    <Marker coordinate={{ latitude: 52.6, longitude: 18.3 }} />
    <Marker coordinate={{ latitude: 51.6, longitude: 18.0 }} />
    <Marker coordinate={{ latitude: 53.1, longitude: 18.8 }} />
    <Marker coordinate={{ latitude: 52.9, longitude: 19.4 }} />
    <Marker coordinate={{ latitude: 52.2, longitude: 21 }} />
  </MapView>
);

export default App;

Props

Name	Type	Default	Note
clusterColor	String	#00B386	Background color of cluster.
clusterTextColor	String	#FFFFFF	Color of text in cluster.
onClusterPress(cluster, children)	Function	() => {}	Allows you to control cluster on click event. Function returns information about cluster and its markers.
width	Number	window width	map's width.
height	Number	window height	map's height.
radius	Number	window.width * 6%	SuperCluster radius.
extent	Number	512	SuperCluster extent.
minZoom	Number	1	SuperCluster minZoom.
maxZoom	Number	20	SuperCluster maxZoom.
preserveClusterPressBehavior	Bool	false	If set to true, after clicking on cluster it will not be zoomed.
edgePadding	Object	{ top: 50, left: 50, bottom: 50, right: 50 }	Edge padding for react-native-maps's fitToCoordinates method, called in onClusterPress for fitting to pressed cluster children.
animationEnabled	Bool	true	Animate imploding/exploding of clusters' markers and clusters size change. Works only on iOS.
layoutAnimationConf	LayoutAnimationConfig	LayoutAnimation.Presets.spring	LayoutAnimation.Presets.spring
onRegionChangeComplete(region, markers)	Function	() => {}	Called when map's region changes. In return you get current region and markers data.
mapRef(ref)	Function	() => {}	Return reference to react-native-maps MapView component.
clusteringEnabled	Bool	true	Set true to enable and false to disable clustering.

Support

Feel free to create issues and pull requests. I will try to provide as much support as possible over Github. In case of questions or problems, contact me at: [email protected]

Happy Coding 💖