@mapbox/react-native-mapbox-gl/README.md

A Mapbox GL react native module for creating custom maps

<a href="https://www.mapbox.com">
  <img src="/assets/mapbox_logo.png" width="500"/>
</a>

# React Native Mapbox GL

_An official React Native component for building maps with the [Mapbox iOS SDK](https://www.mapbox.com/ios-sdk/) and [Mapbox Android SDK](https://www.mapbox.com/android-sdk/)_

[![npm version](https://badge.fury.io/js/%40mapbox%2Freact-native-mapbox-gl.svg)](https://badge.fury.io/js/%40mapbox%2Freact-native-mapbox-gl)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Freact-native-mapbox-gl.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Freact-native-mapbox-gl?ref=badge_shield)

## What is Mapbox?

Mapbox is the location data platform for mobile and web applications. We provide [building blocks](https://www.mapbox.com/products/) to add location features like maps, search, and navigation into any experience you create. Use our simple and powerful APIs & SDKs and our open source libraries for interactivity and control.

## Sign up for Mapbox

Not a Mapbox user yet? [Sign up for an account here](https://www.mapbox.com/signup/). Once you’re signed in, all you need to start building is a Mapbox access token. Use this same short code with all of our interactive mapping libraries, Python and JavaScript SDKs, and directly against our REST APIs. You can [create and manage your access tokens in Mapbox Studio](https://www.mapbox.com/studio/account/tokens/).


## Installation

**Dependencies**

* [node](https://nodejs.org)
* [npm](https://www.npmjs.com/)
* [React Native](https://facebook.github.io/react-native/) >= 0.47.1

**Git**
```
git clone git@github.com:mapbox/react-native-mapbox-gl.git
cd react-native-mapbox-gl
```

**Yarn**
```
yarn add @mapbox/react-native-mapbox-gl
```

**Npm**
```
npm install @mapbox/react-native-mapbox-gl --save
```

## Installation Guides

* [Android](/android/install.md)
* [iOS](/ios/install.md)
* [Example](/example/README.md)

## Documentation

### Components
* [MapView](/docs/MapView.md)
* [Light](/docs/Light.md)
* [StyleSheet](/docs/StyleSheet.md)
* [PointAnnotation](/docs/PointAnnotation.md)
* [Callout](/docs/Callout.md)

### Sources
* [VectorSource](/docs/VectorSource.md)
* [ShapeSource](/docs/ShapeSource.md)
* [RasterSource](/docs/RasterSource.md)

### Layers
* [BackgroundLayer](/docs/BackgroundLayer.md)
* [CircleLayer](/docs/CircleLayer.md)
* [FillExtrusionLayer](/docs/FillExtrusionLayer.md)
* [FillLayer](/docs/FillLayer.md)
* [LineLayer](/docs/LineLayer.md)
* [RasterLayer](/docs/RasterLayer.md)
* [SymbolLayer](/docs/SymbolLayer.md)

### Offline
* [OfflineManager](/docs/OfflineManager.md)

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Freact-native-mapbox-gl.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmapbox%2Freact-native-mapbox-gl?ref=badge_large)