Mapbox GL Javascript wrapper for ReactJS

Mapbox GL Javascript wrapper for ReactJS

react-mapbox-wrapper Mapbox GL Javascript wrapper for ReactJS

react-mapbox-wrapper

React wrapper for mapboxgl-js API.

Made with by MeilleursAgents

Usage

import React from 'react';
import MapboxMap from 'react-mapbox-wrapper';

export default function SimpleMap() {
  return (
    <div style={{ height: 400, width: 400 }}>
      <MapboxMap
        accessToken="<your acess token here>"
        coordinates={{ lat: 48.872198, lng: 2.3366308 }}
      />
    </div>
  );
}

SimpleMap.displayName = 'SimpleMap';

See examples folder for more example.

Getting started

Read carefully the getting started section of Mapbox GL API.

If you use Webpack, you should add the following parameter in order to properly build your app.

module: {
    noParse: /(mapbox-gl)\.js$/,
}

react-mapbox-wrapper import the corresponding CSS stylesheet from Javascript, you don't have to do it.

API

MapboxMap

React Component that render a Mapbox Map. Extra props are directly passed to the Map constructor. Following props are handled by wrapper for updating or handling behavior in the React philosophy.

Wrapper is CSS flex-ready for width but you have to set a height for having visible Mapbox.

Props Type Default Description
accessToken String required Mapbox Access Token (find it here)
coordinates Object required Coordinates of the map center
According to the LngLatLike model
className string '' className added to map's wrapper. Your should provide a height in order to render the map (default at 0)
children Node null Rendered children, typically a Marker and/or Circle
minZoom number undefined The minimum zoom level of the map (0-24).
maxZoom number undefined The maximum zoom level of the map (0-24).
zoom number 15 The viewport zoom
onChange func undefined Callback function called on every viewport change (moveend, zoomend)

Callback receive param with the following shape { zoom: 15, coordinates: { lng: 3.4, lat: 1.2 } } | | onClick | func | undefined | Callback function called on map's click | | onLoad | func | undefined | Callback function called on map's load with current Mapbox instance param | | onZoomStart | func | undefined | Callback function called on map's zoomstart | | onZoomEnd | func | undefined | Callback function called on map's zoomend with a debounce of 300ms in order to avoid too many render() call | | renderNotSupported | func | Simple message | Callback function called when browser does not support mapbox-gl | | mapboxStyle | String | | Mapbox style layer | | withCompass | bool | false | Show compass Navigation Control | | withFullscreen | bool | false | Show Fullscreen Control | | withZoom | bool | false | Show zoom Navigation Control | | fullscreenControlPosition | string | top-right | Set Fullscreen Control position | | navigationControlPosition | string | bottom-right | Set Navigation Control position |

Marker

React Component that render a Marker. Extra props are directly passed to the Marker constructor

Props Type Default Description
children Node null Marker HTML DOM, default marker will be used if not provided
coordinates Object required Coordinates of the marker
According to the LngLatLike model
draggable bool false Allow user to drag'n'drop Marker
getRef func Callback function called with marker's ref (useful for calling #moveToTop() function)
map Object required Mapbox Map where marker will be added (can be obtained with MapboxMap#onLoad props fn)
onDragEnd func Callback function called on marker's dragend
onMouseOut func Callback function called on marker or popup mouseOut
onMouseOver func Callback function called on marker or popup mouseOver
popup Node Popup attached to the marker, displayed on click to marker
popupAnchor string bottom Popup anchor param
popupCloseButton bool false Popup closeButton param
popupOffset number Popup offset param
popupOnOver bool false Trigger popup show on mouse over (only available if children are provided, default marker cannot be bind)

Circle

React Component that render a Circle. Extra props are directly passed to the Marker constructor

Props Type Default Description
coordinates Object required Coordinates of the marker
According to the LngLatLike model
id string required Identifier of circle, used to name the underlying layer
map Object required Mapbox Map where marker will be added (can be obtained with MapboxMap#onLoad props fn)
onClick func Callback function called on circle's click
paint Object Paint option of the layer
radius number required Radius of circle, in kilometers
unit string kilometers Unit of the radius. values can be : kilometers, meters, miles, feet

Helpers

We provide some helpers for interacting with Mapbox Map object, all in Helpers import.

import { Helpers } from react-mapbox-wrapper;

Helpers.convertRadiusUnit(580, 'meters');
// > { radius: 0.58, unit: 'kilometers' }

Helpers.getCircleData({ lat: 48.868526, lng: 2.3434886 }, 800, 'meters')
// > Coordinates for drawing a circle with a 800meters radius at given coordinates

Helpers.coordinatesAreEqual({ lat: 48.868526, lng: 2.3434886 }, [2.3434886, 48.868526]);
// > Check if given coordinates are equal, even in different format

Helpers.newBounds(coordinatesSouthWest, coordinatesNorthEast);
// > Create a new LngLatBounds from Mapbox library

Helpers.newBound(coordinates);
// > Create a new LngLatLike from Mapbox library

Helpers.drawGeoJSON(map, 'foodTruck', data, { 'fill-opacity': 0.2 }, undefined, 'fill');
// > Draw a geoJSON with given data and type. Can be used to also update geoJSON if layer already exist

Helpers.removeGeoJSON(map, 'foodTruck');
// > Remove the layer previously added with #addGeoJSON method

Development

npm install && npm run peers # install both dependencies and peers

You can use npm link while developing new features on this repo for use in targeted repository.

npm link

Git hooks

You can use our pre-commit hook for ensuring consistent format and linting before committing by running command:

./tools/install_hooks.sh

Download Details:

Author: MeilleursAgents

Live Demo: https://meilleursagents.github.io/react-mapbox-wrapper/

GitHub: https://github.com/MeilleursAgents/react-mapbox-wrapper

javascript react reactjs

Bootstrap 5 Complete Course with Examples

Bootstrap 5 Tutorial - Bootstrap 5 Crash Course for Beginners

Nest.JS Tutorial for Beginners

Hello Vue 3: A First Look at Vue 3 and the Composition API

Building a simple Applications with Vue 3

Deno Crash Course: Explore Deno and Create a full REST API with Deno

How to Build a Real-time Chat App with Deno and WebSockets

Convert HTML to Markdown Online

HTML entity encoder decoder Online

How to Setup React Router v5 using React Hooks

React Router library makes the navigation experience of the client in your web page application more joyful, but how?! React Router, indeed, prevent the page from being refreshed. Thus the blank page resulted from a refreshed page is not...

React Fundamentals - ENTERING REACT AFTER LEARNING JAVASCRIPT

After all my teachings about React, be it online for a larger audience or on-site for companies transitioning to web development and React.

React Hooks: useState - Part 2

React Hooks: useState. In this blog, we are going to discuss the useState hook in detail. As this hook let us use state without writing a class. This hook is the equivalent of this.state/this.setState for functional components.

Top VSCode Extensions for React, React Native, JavaScript and Productivity

Bunch of VSCode Extensions that improve quality of your coding time no matter what stack you are using. In this post, you'll see Top VSCode Extensions for React, React Native, JavaScript and Productivity

React Tutorial for Beginners - Learn React in 1 Hour

React Tutorial for Beginners - Learn React in 1 Hour. The quick guide to learn basic concepts and workflow of how to build React App. In this course you will learn React in 1 hour. You will learn what react does, you will learn how react works, you will learn views, components, state, routing, react lifecycle and much more.