https://visgl.github.io/react-map-gl/

React friendly API wrapper around MapboxGL JS
https://visgl.github.io/react-map-gl/

data-visualization map mapbox-gl mapbox-gl-js react uber webgl

Last synced: about 4 hours ago
JSON representation

React friendly API wrapper around MapboxGL JS

• Host: GitHub
• URL: https://visgl.github.io/react-map-gl/
• Owner: visgl
• License: other
• Created: 2015-10-08T16:56:26.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-01-06T06:52:53.000Z (6 days ago)
• Last Synced: 2025-01-06T15:05:57.365Z (6 days ago)
• Topics: data-visualization, map, mapbox-gl, mapbox-gl-js, react, uber, webgl
• Language: TypeScript
• Homepage: http://visgl.github.io/react-map-gl/
• Size: 30.5 MB
• Stars: 7,918
• Watchers: 1,940
• Forks: 1,355
• Open Issues: 74
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

• React-Toolkit - React Map GL

README

        


  

    

  

  

    

  

    

  



react-map-gl | Docs



`react-map-gl` is a suite of [React](https://react.dev/) components designed to provide a React API for [mapbox-gl](https://github.com/mapbox/mapbox-gl-js) or [maplibre-gl](https://maplibre.org/maplibre-gl-js/docs/). 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

# Using Maplibre

npm install react-map-gl maplibre-gl

```

_or_

```sh

# Using Mapbox

npm install react-map-gl mapbox-gl

```

### Example

```js

// Using Maplibre

import * as React from 'react';

import Map from 'react-map-gl/maplibre';

function App() {

  return (

    

  );

}

```

_or_

```js

// Using Mapbox

import * as React from 'react';

import Map from 'react-map-gl';

function App() {

  return (

    

  );

}

```

Learn more with in our [Getting Started](https://visgl.github.io/react-map-gl/docs/get-started) guide.

### 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 [OpenJS Foundation](https://openjsf.org) project.

Development is also supported by