GettingStarted.md

Getting Started

Congratulations, you successfully installed maplibre-react-native! 🎉 This quickstart guide provides a zero-to-map intro, and from there you can check out the examples folder if you want to jump in the deep end.

Prerequisites

1. On Android we support API 23 and higher
2. You will need a vector tile source (such as Stadia Maps or MapTiler) for production use; a demonstration URL is used in the below example.

Dependencies

• node
• npm
• React Native (0.60+)

Installation

Set up a React Native project

If you don't have an existing React Native project, create one:

npx react-native init MyApp

Install Package

From your React Native project's root directory, add the package via either yarn or npm (pick one).

# install with Yarn
yarn add @maplibre/maplibre-react-native

# install with NPM
npm install @maplibre/maplibre-react-native --save

Review platform specific info

Check out the installation guide(s) for additional information about platform-specific setup, quirks, and steps required before running.

• Android
• iOS
• Expo

Adding a map

Here is an example minimal App.js

import React, {Component} from 'react';
import {StyleSheet, View} from 'react-native';
import MapLibreGL from '@maplibre/maplibre-react-native';

// Will be null for most users (only Mapbox authenticates this way).
// Required on Android. See Android installation notes.
MapLibreGL.setAccessToken(null);

const styles = StyleSheet.create({
  page: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  map: {
    flex: 1,
    alignSelf: 'stretch',
  },
});

export default class App extends Component {
  render() {
    return (
      <View style={styles.page}>
        <MapLibreGL.MapView
          style={styles.map}
          logoEnabled={false}
          styleURL="https://demotiles.maplibre.org/style.json"
        />
      </View>
    );
  }
}

Run it!

iOS

# Run with yarn
yarn run ios

# or Run with NPM
npm run ios

Android

# Run with yarn
yarn run android

# or Run with NPM
npm run android