Package Exports
- react-map-gl
- react-map-gl/dist/mapbox/mapbox
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-map-gl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-map-gl | Docs
React Components Suite for Mapbox GL JS.
In addition to exposing MapboxGL functionality to React apps, react-map-gl also integrates seamlessly with deck.gl.
Installation
Using react-map-gl
requires node >= v4
and react >= 15.4
.
npm install --save react-map-gl
Example
import {Component} from 'react';
import ReactMapGL from 'react-map-gl';
class Map extends Component {
state = {
viewport: {
width: 400,
height: 400,
latitude: 37.7577,
longitude: -122.4376,
zoom: 8
}
};
render() {
return (
<ReactMapGL
{...this.state.viewport}
onViewportChange={(viewport) => this.setState({viewport})}
/>
);
}
}
About Mapbox Tokens
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:
- Modify the source directly
- Set the
MapboxAccessToken
environment variable - Provide it in the URL, e.g
?access_token=TOKEN
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.