Merge pull request #6 from uber/document-mapbox-api-prop

Add mapboxApiAccessToken as a prop to document it.
This commit is contained in:
Victor 2015-10-12 19:00:22 -07:00
commit 139ada45d2

View File

@ -100,13 +100,18 @@ var MapGL = React.createClass({
*/
zoom: React.PropTypes.number.isRequired,
/**
* The mapbox style the component should use. Can either be a string url
* The Mapbox style the component should use. Can either be a string url
* or a MapboxGL style Immutable.Map object.
*/
mapStyle: React.PropTypes.oneOfType([
React.PropTypes.string,
React.PropTypes.instanceOf(Immutable.Map)
]),
/**
* The Mapbox API access token to provide to mapbox-gl-js. This is required
* when using Mapbox provided vector tiles and styles.
*/
mapboxApiAccessToken: React.PropTypes.string,
/**
* `onChangeViewport` callback is fired when the user interacted with the
* map. The object passed to the callback containers `latitude`,