# react-map-gl-3
> A React wrapper for MapboxGL-js and overlay API.
Latest version **3.0.0-alpha.13** (published 2017-06-21) · MIT license · 0 weekly downloads
## Install
```sh
npm install react-map-gl-3
pnpm add react-map-gl-3
yarn add react-map-gl-3
bun add react-map-gl-3
```
## Health
**Score 35/100 (D)** — status: abandoned.
Positive: esm support; no vulnerabilities; high maintenance score.
Warnings: low downloads; no types.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 3.0.0-alpha.13 |
| Published | 2017-06-21 |
| First published | 2017-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 4 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8497 |
| Maintainers | jejay |
| Keywords | mapbox, mapbox-gl, react, react-mapbox-gl, react mapbox |
## Links
- npm: https://www.npmjs.com/package/react-map-gl-3
- Repository: https://github.com/uber/react-map-gl
- Homepage: https://github.com/uber/react-map-gl#readme
- Issues: https://github.com/uber/react-map-gl/issues
- npm.io page: https://npm.io/package/react-map-gl-3
## Dependencies (6)
- [bowser](https://npm.io/package/bowser.md) ^1.2.0
- [hammerjs](https://npm.io/package/hammerjs.md) ^2.0.8
- [immutable](https://npm.io/package/immutable.md) *
- [mapbox-gl](https://npm.io/package/mapbox-gl.md) 0.38.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.7
- [viewport-mercator-project](https://npm.io/package/viewport-mercator-project.md) ^4.0.1
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 3.0.0-alpha.13 (latest) — 2017-06-21
## README
react-map-gl | Docs
React friendly API wrapper around MapboxGL JS
## Installation
npm install --save react-map-gl
## Using with Browserify, Webpack etc
* `browserify` - react-map-gl is extensively tested with `browserify` and works without configuration.
* `webpack 2` - look at the [exhibit-webpack](https://github.com/uber/react-map-gl/tree/master/examples/exhibit-webpack)
folder, demonstrating a working demo using `webpack`.
In general, for non-browserify based environments, make sure you have read the instructions on the
[mapbox-gl-js README](https://github.com/mapboxmapbox-gl-js#using-mapbox-gl-js-with-other-module-systems).
## Example
```js
import MapGL from 'react-map-gl';
{
const {latitude, longitude, zoom} = viewport;
// Optionally call `setState` and use the state to update the map.
}}
/>
```
## Components
react-map-gl provides React-friendly components like `Marker`, `Popup` etc.
## Visualizing Geospatial Data
The main point of using a map is usuallt to visualize geospatial data on top of it. react-map-gl provides several solutions
### deck.gl Layers
[deck.gl](https://github.com/uber/deck.gl) is a companion module to `react-map-gl` that provide a number of classic data visualization overlays (scatterplots, choropleths etc) implemented in WebGL. These overlays are suitable for very large and/or dynamic data sets, and for use in perspective mode
applications.
## Overlays
react-map-gl provides a basic overlay API. You can use the built-in visualization overlays, or create your own.
## Perspective Mode
react-map-gl fully supports mapbox-gl perspective mode (pitch and bearing).
In addition, for a set of high-performance geospatial data visualiation overlays that are 100% compatible with mapbox-gl perspective mode, look at [deck.gl](https://github.com/uber/deck.gl).
## Transitions
TBD
## ImmutableJS
The `mapStyle` property of the `MapGL` as well as several of the built in
overlay properties must be provided as [ImmutableJS](https://facebook.github.io/immutable-js) objects. This allows the library to be fast since computing changes to props only involves checking if the immutable objects are the same instance.
## Development
Install project dependencies and check that the tests run
npm install
npm test
Note on yarn: `yarn` does not appear to be compatible with `mapbox-gl` v0.31,
in terms of installing correct versions of dependencies needed to run
test scripts in the folder.
While this is likely to change, for now it is recommended it is recommended to
use `npm install` in the root folder of `react-map-gl`. This restriction only
applies when installing in the root folder; `yarn` is still supported and
recommended when installing the examples in the `examples` folder.
Then start the main example in `examples/main` by running the shortcut
npm start
This should open a new tab in your browser with the examples.
To make the maps load, either:
* add `?access_token=TOKEN` to the URL where `TOKEN` is a valid Mapbox access token, or
* set the `MapboxAccessToken` environment variable before running `npm start`
## Testing
* **Unit Tests** - it is expected that any feature is accompanied by standard unit tests in [test folder](./test).
* **Run Unit Tests in Node** - Note that This component uses WebGL, but it still runs under Node.js (using headless-gl and jsdom). This is how the standard `npm test` script runs.
* **Run Unit Tests in Browser** - It is also important to run unit tests in the browser, via `npm run test-browser`.
* **Manual Testing** - In addition, please test drive new and existing features by running `npm start` and manually testing the demos.
## Contributing
Contributions are welcome. It can be helpful to check with maintainers before opening your PR, just open an issue and describe your proposal. Also, be aware that you will need to complete a short open source contribution form before your pull request can be accepted.
---
_Source: https://npm.io/package/react-map-gl-3 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._