react-leaflet-cluster-layer
react-leaflet-cluster-layer provides a simple
Usage
API
The ClusterLayer
component takes the following props:
markers
: an array of objects that expose the properties defined in theMarker
typeclusterComponent
: (required) the React component to be rendered for each marker and cluster, this component will receive the following propscluster
: aCluster
object, as defined by the Cluster Flow typestyle
: a style object for positioningmap
: the Leaflet map object from thereact-leaflet
MapLayer
...propsForClusters
: the component will also receive the properties ofpropsForClusters
as props
propsForClusters
: props to pass on to marker and cluster componentsgridSize
: optional prop to control how bounds of clusters expand while being generated (default: 60)minClusterSize
: optional prop to enforce a minimum cluster size (default: 2)
Example
To try the example:
- Clone this repository
- run
npm install
in the root of your cloned repository - run
npm run example
- Visit localhost:8000