react-map-gl | Docs

`react-map-gl` is a suite of [React](http://facebook.github.io/react/) components designed to provide a React API for [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js)-compatible libraries. More information in the online documentation. See our [Design Philosophy](docs/README.md#design-philosophy). ### Installation Using `react-map-gl` requires `react >= 16.3`. ```sh npm install --save react-map-gl mapbox-gl ``` ### Example ```js import * as React from 'react'; import Map from 'react-map-gl'; function App() { return ; } ``` ### 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](/docs/get-started/mapbox-tokens.md) 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 `mapboxAccessToken` 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` ### Contribute See [contribution guide](/CONTRIBUTING.md). ### Attributions react-map-gl is part of vis.gl, an [Urban Computing Foundation](https://uc.foundation) project. Development is also supported by

	Stars	Issues	Version	Updated	Created
google-maps	290	8	4.3.3	4 years ago	11 years ago
luma.gl	2,244	43	7.3.2	5 years ago	8 years ago
mapbox.js	1,910	91	3.3.1	4 years ago	12 years ago
openlayers			4.6.5	6 years ago	13 years ago
react-map-gl	7,592	81	7.1.7	5 months ago	9 years ago

google-maps vs luma.gl vs mapbox.js vs openlayers vs react-map-gl

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past