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';
import 'maplibre-gl/dist/maplibre-gl.css';
function App() {
return (
);
}
```
_or_
```js
// Using Mapbox
import * as React from 'react';
import Map from 'react-map-gl/mapbox';
import 'mapbox-gl/dist/mapbox-gl.css';
function App() {
return (
);
}
```
Learn more with in our [Getting Started](https://visgl.github.io/react-map-gl/docs/get-started) guide.
### 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
