Better React Wrapper for Mapbox GL

Node.js Package npm version npm bundle size npm downloads TypeScript npm peer dependency version GitHub

This is a React wrapper for Mapbox GL JS. I created this wrapper for 2 reasons:

  1. Existing wrappers are not well maintained and are not up to date with the latest Mapbox GL JS API.
  2. I wanted to support [email protected] while still supporting [email protected] because it’s free.

video

Installation

npm install mapbox-react-wrapper

By default, this package will install [email protected]. If you want to use [email protected], you can install it like this:

npm install mapbox-react-wrapper [email protected]

Usage

import React from "react";
import { MapboxReact } from "mapbox-react-wrapper";

const App = () => {
  return (
    <MapboxReact
      accessToken={"YOUR_ACCESS_TOKEN"} // not required if you are on [email protected] and aren't using mapbox's map styles
      mapStyle="mapbox://styles/mapbox/streets-v11" // url or mapbox style object
      mapboxOptions={{
        center: [0, 0],
        zoom: 1.5,
      }}
    />
  );
};

export default App;

Props

Prop Type Description
accessToken string Mapbox access token. Required if you are using mapbox’s map styles.
mapStyle string or object Mapbox style object or url.
interactive boolean Whether the map is interactive.
height CSSProperties[‘height’] Height of the map.
width CSSProperties[‘height’] Width of the map.
mapboxOptions MapboxOptions Mapbox options.
idleSpin boolean Whether the map should spin when idle.
showMapControls boolean Whether to show map controls.
markers CustomMarkerProps[] Array of markers.
flyTo CustomFlyToOptions Fly to options.

Props supported in [email protected]

Prop Type Description
projection ProjectionLike Projection used by the map.
fog FogOptions Fog options.

Examples

3D Globe Projection

Works with [email protected]

import React from "react";
import { MapboxReact } from "mapbox-react-wrapper";

const App = () => {
  return (
    <MapboxReact
      accessToken={"YOUR_ACCESS_TOKEN"} // not required if you are on [email protected] and aren't using mapbox's map styles
      mapStyle="mapbox://styles/mapbox/streets-v11" // url or mapbox style object
      mapboxOptions={{
        center: [0, 0],
        zoom: 1.5,
        projection: {
          name: "globe",
        },
      }}
      fog={{
        range: [-1, 2],
        "horizon-blend": 0.3,
        color: "#242B4B",
        "high-color": "#161B36",
        "space-color": "#0B1026",
        "star-intensity": 0.8,
      }}
    />
  );
};

export default App;

Free Mapbox GL JS

Using open satellite layer from arcgis instead of mapbox map styles and [email protected] where you don’t need an access token if no mapbox APIs are being used. You can also use map style objects which follow Mapbox Style Spec like for example from ArcGIS, which you can store with your source code and import as a JSON Object. A good example of this is in Planet WebApp & Usage with react-mapbox-gl, Example Mapstyle Object. It requires a little bit of tweeking but it works. Maybe I can include support for ArcGIS styles in future versions. Best part is with [email protected] you can use it for free. Don’t forget to add proper attribution when using third party map styles.

import React from "react";
import { MapboxReact } from "mapbox-react-wrapper";

const App = () => {
  return (
    <MapboxReact
      mapboxOptions={{
        center: [0, 0],
        zoom: 1.5,
      }}
      // arcgis satellite layer
      rasterSourceLayers={[
        {
          source: {
            id: "satellite-source",
            type: "raster",
            tiles: [
              "https://wayback.maptiles.arcgis.com/arcgis/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}",
            ],
            tileSize: 256,
          },
          layers: [
            {
              id: "raster-layer",
              type: "raster",
              source: "satellite-source",
              minzoom: 0,
              maxzoom: 22,
            },
          ],
        },
      ]}
    />
  );
};

export default App;

Roadmap till v0.1.0

  • globe projection with [email protected]
  • free usage with [email protected]
  • custom map styles
  • default markers
  • partial support for raster layers
  • fly to options
  • idle spin
  • fog support with [email protected]
  • custom markers and popups
  • geojson layers
  • raster layers
  • vector layers
  • events
  • clustering

Contributing

Contributions are welcome! Please open an issue or a PR.

License

MIT

❤️ of Open Source

This project is part of the Open Source Initiative.

Open Source

Disclaimer

This project is not affiliated with Mapbox in any way. Mapbox is a registered trademark of Mapbox, Inc.. I am using Mapbox’s APIs and services in the spirit of Open Source. Any issues with the usage of Mapbox’s APIs and services should be directed to Mapbox, Inc..

GitHub

View Github