Need help with react-map-gl?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

visgl
6.2K Stars 1.0K Forks Other 814 Commits 29 Opened issues

Description

React friendly API wrapper around MapboxGL JS

Services available

!
?

Need anything else?

Contributors list

version build downloads

react-map-gl | Docs

react-map-gl
is a suite of React components designed to provide a React API for Mapbox GL JS-compatible libraries. More information in the online documentation.

See our Design Philosophy.

Installation

Using

react-map-gl
requires
react >= 16.3
.
npm install --save react-map-gl

Example

import * as React from 'react';
import ReactMapGL from 'react-map-gl';

function Map() { const [viewport, setViewport] = React.useState({ latitude: 37.7577, longitude: -122.4376, zoom: 8 });

return ( setViewport(viewport)} /> ); }

Using Mapbox Tokens

Starting with v2.0, mapbox-gl requires a Mapbox token for any usage, with or without the Mapbox data service. See about Mapbox tokens for your options.

To show maps from a service such as Mapbox you will need to register on their website in order to retrieve an access token required by the map component, which will be used to identify you and start serving up map tiles. The service will be free until a certain level of traffic is exceeded.

There are several ways to provide a token to your app, as showcased in some of the example folders:

  • Provide a
    mapboxApiAccessToken
    prop to the map component
  • Set the
    MapboxAccessToken
    environment variable (or set
    REACT_APP_MAPBOX_ACCESS_TOKEN
    if you are using Create React App)
  • Provide it in the URL, e.g
    ?access_token=TOKEN
  • Provide
    mapboxApiUrl
    prop to the map component to override the default mapbox API URL

But we would recommend using something like dotenv and put your key in an untracked

.env
file, that will then expose it as a
process.env
variable, with much less leaking risks.

Limitations

This library provides convenient wrappers around initializing and (to some degree) tracking the state of a Mapbox WebGL map. Because most of the functionality of Mapbox's JS API depends on the use of HTML5 canvases and WebGL, which React is not built to manipulate, the React component does not mirror all the functionality of Mapbox GL JS's Map class. You may access the native Mapbox API exposed by the

getMap()
function in this library. However, proceed with caution as calling the native APIs may break the connection between the React layer props and the underlying map state.

Examples of replacing common native API calls with their React equivalents can be found on the FAQ page.

Contribute

See contribution guide.

Attributions

react-map-gl is part of vis.gl, an Urban Computing Foundation project.

Development is also supported by

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.