Skip to content

Latest commit

 

History

History
156 lines (98 loc) · 6.25 KB

README.md

File metadata and controls

156 lines (98 loc) · 6.25 KB
Raw

MapLibre Native for iOS

GitHub Action build status GitHub Action build status

A library based on MapLibre Native for embedding interactive map views with scalable, customizable vector maps into iOS Applications.

Getting Started

MapLibre Native for iOS is distributed using the Swift Package Index. To add it to your project, follow the steps below.

  1. To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL. You can also navigate to your target’s General pane, and in the “Frameworks, Libraries, and Embedded Content” section, click the + button, select Add Other, and choose Add Package Dependency.

  2. Either add MapLibre GitHub distribution URL https://github.com/maplibre/maplibre-gl-native-distribution or search for maplibre-native package.

  3. Choose "Next". Xcode should clone the distribution repository and download the binaries.

  4. To create a minimal app, update ContentView.swift (which should have been automatically created when you initalized the new XCode project) with the following contents:

import SwiftUI
import Mapbox

struct ContentView: View {
    var body: some View {
        MapView().edgesIgnoringSafeArea(.all)
    }
}

struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView()
    }
}

struct MapView: UIViewRepresentable {
    func makeUIView(context: Context) -> MGLMapView {
        // Build the style URL
        let styleURL = URL(string: "https://demotiles.maplibre.org/style.json")

        // Create the map view
        let mapView = MGLMapView(frame: .zero, styleURL: styleURL)

        mapView.logoView.isHidden = true

        mapView.setCenter(
            CLLocationCoordinate2D(
                latitude: 23.16, longitude: -109.50), animated: false)

        mapView.setZoomLevel(4, animated: false)
        return mapView

    }

    func updateUIView(_ mapView: MGLMapView, context: Context) {
        // Update the view if needed
    }
}

There is a an open bounty to extend this Getting Started guide (#809). In the meantime, refer to one of these external guides:

Developing

The following are instructions on how to build MapLibre Native for development purposes.

Downloading Source

Download the source and install all submodules if you have not already, by running the following from the root of the repository.

git clone --recurse-submodules git@github.com:maplibre/maplibre-native.git
cd maplibre-native

Bazel

Bazel can be used to build the project.

You can generate an Xcode project thanks to rules_xcodeproj intergration.

You need to install bazelisk, which is a wrapper around Bazel which ensures that the version specified in .bazelversion is used.

brew install bazelisk

Creating config.bzl

You may want to configure Bazel, otherwise the default config gets used.

cp platform/darwin/bazel/example_config.bzl platform/darwin/bazel/config.bzl

You need to set your BUNDLE_ID_PREFIX to be unique (ideally use a domain that you own in reverse domain name notation).

You can keep leave the APPLE_MOBILE_PROVISIONING_PROFILE_NAME alone.

Set the Team ID to the Team ID of your Apple Developer Account (paid or unpaid both work). If you do not know your Team ID, go to your Apple Developer account, log in, and scroll down to find your Team ID.

If you don't already have a developer account, continue this guide and let Xcode generate a provisioning profile for you. You will need to update the Team ID later once a certificate is generated.

If you are encountering build errors due to provisioning profiles, skip down to the troubleshooting section.

Create the Xcode Project

These instructions are for XCode 14.3.1

bazel run //platform/ios:xcodeproj --@rules_xcodeproj//xcodeproj:extra_common_flags="--//:renderer=metal"
xed platform/ios/MapLibre.xcodeproj

Then once in Xcode, click on "MapLibre" on the left, then "App" under Targets, then "Signing & Capabilities" in the tabbed menu. Confirm that no errors are shown:

image

Try to run the example App in the simulator and on a device to confirm your setup works.

Troubleshooting Provisioning Profiles

If you get a Python KeyError when processing provisioning profiles, you probably have some really old or corrupted profiles. Have a look through ~/Library/MobileDevice/Provisioning\ Profiles and remove any expired profiles.

Using Bazel from the Command Line

It is also possible to build and run the test application in a simulator from the command line without opening Xcode.

bazel run //platform/ios:App

If you want to build your own XCFramework, see the 'Build XCFramework' step in the iOS CI workflow.

Render Tests

To run the render tests, run the RenderTest target from iOS.

When running in a simulator, use

# check for 'DataContainer' of the app with `*.maplibre.RenderTestApp` id
xcrun simctl listapps booted

to get the data directory of the render test app. This allows you to inspect test results. When adding new tests, the generated expectations and actual.png file can be copied into the source directory from here.

Documentation