react-native-leaflet-kit

v1.0.4

Published

16 days ago

A professional, pluggable, and declarative Map library for React Native built on top of Leaflet, WebView, and OpenStreetMap tiles

0High
0Medium
0Low

ashpradhan01

react-native map leaflet openstreetmap maps navigation geolocation markers polyline webview

React Native Leaflet Kit 🗺️

A professional, pluggable, and declarative Map library for React Native built on top of Leaflet, WebView, and OpenStreetMap tiles. Designed with a Compound Component pattern for maximum flexibility and performance.

✨ Features

Declarative API: Build maps using clean, modular JSX components.
Compound Component Pattern: Easily compose layers, markers, and polylines.
Surgical Updates: Only modified elements are updated, preventing full map re-renders.
Premium User Location: Integrated high-performance user marker with direction cone and pulse animation.
TypeScript Support: Fully typed for a superior developer experience.
Theming: Seamless support for Light and Dark modes.

🚀 Installation

Install the library and its peer dependency:

npm install react-native-leaflet-kit react-native-webview
# or
yarn add react-native-leaflet-kit react-native-webview

🛠️ Quick Start

Wrap your map elements inside the MapContainer and add layers as needed.

import { MapContainer, TileLayer, Marker, Polyline } from 'react-native-leaflet-kit';

const MyMap = () => {
    return (
        <MapContainer 
            center={{ lat: 28.7041, lng: 77.1025 }} 
            zoom={13}
            isDark={true}
            fitBounds={true}
        >
            <TileLayer />
            
            <Marker 
                id="station-1"
                position={{ lat: 28.7041, lng: 77.1025 }}
                title="Delhi Station"
            />
        </MapContainer>
    );
};

🧩 Component Documentation

1. `<MapContainer />`

The primary wrapper that initializes the WebView and provides the Map Context.

| Prop | Type | Default | Description | | :--- | :--- | :--- | :--- | | center | LatLng | - | Initial center coordinates { lat, lng }. | | zoom | number | 13 | Initial zoom level. | | isDark | boolean | false | Toggles dark mode tiles filter. | | backgroundColor | string | #ffffff | WebView background color. | | fitBounds | boolean | false | Enables automatic framing of the map content. | | onMapReady | () => void | - | Called when the map is fully loaded. | | onUserGesture| () => void | - | Called when the user manually pans or zooms (disables fitBounds). | | onMapClick | (pos: LatLng) => void | - | Called when the map is tapped. |

Example:

<MapContainer 
  ref={mapRef}
  center={{ lat: 28.6139, lng: 77.2090 }}
  onMapClick={(pos) => console.log('Tapped at:', pos)}
>
  {/* Children go here */}
</MapContainer>

2. `<TileLayer />`

Defines the source of the map tiles.

Example (Default):

<TileLayer />

Example (Custom Source):

<TileLayer 
  url="https://{s}.tile.thunderforest.com/transport/{z}/{x}/{y}.png"
  attribution='&copy; Thunderforest'
/>

3. `<Marker />`

Adds a standard or custom icon marker to the map.

Example:

<Marker 
  id="main-pin"
  position={{ lat: 28.6139, lng: 77.2090 }}
  icon="⭐"
  title="New Delhi Capital"
  size={[40, 40]}
/>

4. `<Polyline />`

Draws paths or routes on the map.

Regular Example:

<Polyline 
  id="route-1"
  positions={pathCoordinates}
  color="#e74c3c"
  weight={5}
/>

Animated (Flowing) Example:

<Polyline 
  id="moving-route"
  positions={pathCoordinates}
  color="#2ecc71"
  isAnimated={true}
/>

5. `<UserMarker />`

A specialized premium component for real-time user positioning.

Example:

<UserMarker 
  position={userPos}
  heading={90}
  accuracy={25}
  markerColor="#2ecc71"
  style={{
    markerSize: 15,
    showPulse: true,
    pulseMaxScale: 3,
    showDirectionCone: true,
    coneOpacity: 0.4
  }}
/>

6. `<Popup />`

Enables rich HTML content and professional styling inside a Marker. Must be a child of <Marker />.

`PopupStyle` Properties

Example:

<Marker id="premium-shop" position={pos}>
  <Popup 
    style={{
      backgroundColor: "#2c3e50",
      textColor: "#ecf0f1",
      borderRadius: 8,
      padding: 12,
      fontSize: 14
    }}
    offset={[0, 10]}
  >
    <b>Metride Premium Hub</b><br/>
    Authorized Reseller
  </Popup>
</Marker>

7. `<Circle />`

Highlights a circular radius on the map.

Example:

<Circle 
  id="danger-zone"
  center={{ lat: 28.7041, lng: 77.1025 }}
  radius={500}
  color="red"
  fillColor="rgba(255, 0, 0, 0.2)"
/>

8. `<Polygon />`

Defines a specific area or boundary.

Example:

<Polygon 
  id="danger-area"
  positions={dangerAreaCoordinates}
  color="blue"
  fillColor="rgba(0, 0, 255, 0.2)"
/>

9. `<GeoJSON />`

The standard for complex spatial data. Renders entire datasets (lines, points, polygons) from a single JSON.

Example:

<GeoJSON 
  id="metro-network"
  data={delhiMetroGeoJSON}
  style={{ color: '#ff7800', weight: 5, opacity: 0.65 }}
/>

10. `<MarkerCluster />`

Optimizes performance and readability by grouping nearby markers.

Example:

<MarkerCluster options={{ maxClusterRadius: 80 }}>
  {stations.map(s => <Marker key={s.id} {...s} />)}
</MarkerCluster>

11. `<Heatmap />`

Visualizes data density (e.g., peak hour congestion).

| Prop | Type | Description | | :--- | :--- | :--- | | id | string | Unique ID. | | points | LatlngIntensity[] | Array of { lat, lng, intensity }. | | radius | number | Size of the heat points. | | blur | number | Softness of the heat edges. |

Example:

<Heatmap 
  id="congestion-map"
  points={trafficData}
  radius={30}
  blur={15}
/>

🎨 Professional Customization (UserLocationStyle)

🎥 Camera & Interaction Model

Our map utilizes a professional state-driven camera system designed to balance automation with user control.

1. The Priority Priority Engine

When fitBounds is active, the map follows a context-aware hierarchy during initial load:

Priority 1: The Route (Hero) - If markers or paths exist, the map frames them perfectly while excluding the user (if distant) to keep the journey as the main focus.
Priority 2: The User (Fallback) - If the map is empty, it centers on the user at a comfortable street-level zoom (Level 15).

2. Gesture-Aware Automation

Auto-Pause: If a user performs a manual gesture (pan, zoom, pinch), the map immediately disables automatic camera movements to prevent "fighting" the user.
Recenter Pattern: Developers can use the onUserGesture callback to show a "Recenter" button. When clicked, setting fitBounds={true} will snap the camera back to the optimal view.

3. Debounced Handshake

To prevent "jitter" during data loading, the camera wait 200ms after the first piece of data arrives before performing the initial fit. This ensures that all markers and polylines have registered through the bridge for a perfect single-frame fit.

📜 License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

React Native Leaflet Kit 🗺️

✨ Features

🚀 Installation

🛠️ Quick Start

🧩 Component Documentation

1. <MapContainer />

2. <TileLayer />

3. <Marker />

4. <Polyline />

5. <UserMarker />

6. <Popup />

PopupStyle Properties

7. <Circle />

8. <Polygon />

9. <GeoJSON />

10. <MarkerCluster />

11. <Heatmap />

🎨 Professional Customization (UserLocationStyle)

🎥 Camera & Interaction Model

1. The Priority Priority Engine

2. Gesture-Aware Automation

3. Debounced Handshake

📜 License

1. `<MapContainer />`

2. `<TileLayer />`

3. `<Marker />`

4. `<Polyline />`

5. `<UserMarker />`

6. `<Popup />`

`PopupStyle` Properties

7. `<Circle />`

8. `<Polygon />`

9. `<GeoJSON />`

10. `<MarkerCluster />`

11. `<Heatmap />`