Mapbox Navigation SDK for iOS
The Mapbox Navigation SDK gives you all the tools you need to add turn-by-turn navigation to your application. It takes just a few minutes to drop a full-fledged turn-by-turn navigation view controller into your application. Or use the Core Navigation framework directly to build something truly custom.
The Mapbox Navigation SDK and Core Navigation are compatible with applications written in Swift 5 in Xcode 10.2. The Mapbox Navigation and Mapbox Core Navigation frameworks run on iOS 10.0 and above.
Installation
Using Swift Package Manager
To install the MapboxNavigation framework in an application using Swift Package Manager:
Go to your Mapbox account dashboard and create an access token that has the
DOWNLOADS:READ
scope. PLEASE NOTE: This is not the same as your production Mapbox API token. Make sure to keep it private and do not insert it into any Info.plist file. Create a file named.netrc
in your home directory if it doesn’t already exist, then add the following lines to the end of the file:machine api.mapbox.com login mapbox password PRIVATE_MAPBOX_API_TOKEN
where PRIVATE_MAPBOX_API_TOKEN is your Mapbox API token with the
DOWNLOADS:READ
scope.In Xcode, go to File ‣ Swift Packages ‣ Add Package Dependency.
Enter
https://github.com/mapbox/mapbox-navigation-ios.git
as the package repository and click Next.Set Rules to Version, Up to Next Major, and enter
2.10.0
as the minimum version requirement. Click Next.
To install the MapboxCoreNavigation framework in another package rather than an application, run swift package init
to create a Package.swift, then add the following dependency:
// Latest prerelease
.package(name: "MapboxNavigation", url: "https://github.com/mapbox/mapbox-navigation-ios.git", from: "2.10.0")
Using CocoaPods
To install the MapboxNavigation framework using CocoaPods:
Go to your Mapbox account dashboard and create an access token that has the
DOWNLOADS:READ
scope. PLEASE NOTE: This is not the same as your production Mapbox API token. Make sure to keep it private and do not insert it into any Info.plist file. Create a file named.netrc
in your home directory if it doesn’t already exist, then add the following lines to the end of the file:machine api.mapbox.com login mapbox password PRIVATE_MAPBOX_API_TOKEN
where PRIVATE_MAPBOX_API_TOKEN is your Mapbox API token with the
DOWNLOADS:READ
scope.Create a Podfile with the following specification:
# Latest stable release pod 'MapboxNavigation', '~> 2.10' # Latest prerelease pod 'MapboxCoreNavigation', :git => 'https://github.com/mapbox/mapbox-navigation-ios.git', :tag => 'v2.10.0' pod 'MapboxNavigation', :git => 'https://github.com/mapbox/mapbox-navigation-ios.git', :tag => 'v2.10.0'
Run
pod repo update && pod install
and open the resulting Xcode workspace.
Configuration
Mapbox APIs and vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom iOS Target Properties” section, set
MBXAccessToken
to your access token. You can obtain an access token from the Mapbox account page. Usage of Mapbox APIs is billed together based on monthly active users (MAU) rather than individually by HTTP request.In order for the SDK to track the user’s location as they move along the route, set
NSLocationWhenInUseUsageDescription
to:Shows your location on the map and helps improve the map.
Users expect the SDK to continue to track the user’s location and deliver audible instructions even while a different application is visible or the device is locked. Go to the Signing & Capabilities tab. Under the Background Modes section, enable “Audio, AirPlay, and Picture in Picture” and “Location updates”. (Alternatively, add the
audio
andlocation
values to theUIBackgroundModes
array in the Info tab.)
Now import the relevant modules and present a new NavigationViewController
. You can also push to a navigation view controller from within a storyboard if your application’s UI is laid out in Interface Builder.
import MapboxDirections
import MapboxCoreNavigation
import MapboxNavigation
// Define two waypoints to travel between
let origin = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.9131752, longitude: -77.0324047), name: "Mapbox")
let destination = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.8977, longitude: -77.0365), name: "White House")
// Set options
let routeOptions = NavigationRouteOptions(waypoints: [origin, destination])
// Request a route using MapboxDirections
Directions.shared.calculate(routeOptions) { [weak self] (session, result) in
switch result {
case .failure(let error):
print(error.localizedDescription)
case .success(let response):
guard let strongSelf = self else {
return
}
// Pass the generated route response to the the NavigationViewController
let viewController = NavigationViewController(for: response, routeIndex: 0, routeOptions: routeOptions)
viewController.modalPresentationStyle = .fullScreen
strongSelf.present(viewController, animated: true, completion: nil)
}
}
Starting points
This SDK is divided into two frameworks: the Mapbox Navigation framework (MapboxNavigation
) is the ready-made turn-by-turn navigation UI, while the Mapbox Core Navigation framework (MapboxCoreNavigation
) is responsible for the underlying navigation logic.
Mapbox Navigation
NavigationViewController
is the main class that encapsulates the entirety of the turn-by-turn navigation UI, orchestrating the map view, various UI elements, and the route controller. Your application would most likely present an instance of this class. The NavigationViewControllerDelegate
protocol allows your application to customize various aspects of the UI and react to location-related events as they occur.
NavigationMapView
is the map view at the center of the turn-by-turn navigation UI. You can also use this class independently of NavigationViewController
, for example to display a route preview map. The NavigationMapViewDelegate
protocol allows your application to customize various aspects of the map view’s appearance. PassiveLocationProvider
is an optional alternative to CLLocationManager
for use with any standalone MapView
or NavigationMapView
.
PreviewViewController
is the class that along with the ability to display a route preview map, also allows to present banners with additional information. Such banners should conform to Banner
protocol. The Mapbox Navigation SDK also provides default banners that allow to present address of the final destination (DestinationPreviewViewController
) and route information like estimated time of arrival, total duration and distance (RoutePreviewViewController
). The PreviewViewControllerDelegate
protocol allows to observe Banner
presentation and dismissal events. Seamless transition between PreviewViewController
and NavigationViewController
can be reached by using UIViewControllerTransitioningDelegate
and replacing existing NavigationViewController.navigationMapView
instance with the one that is used in PreviewViewController
.
CarPlayManager
is the class that manages the CarPlay screen if your application is CarPlay-enabled. It provides a main map for browsing, a search interface that can be powered by the Mapbox Search SDK for iOS or MapboxGeocoder.swift, and a turn-by-turn navigation UI similar to the one provided by NavigationViewController
. Your UIApplicationDelegate
subclass can conform to the CarPlayManagerDelegate
protocol to manage handoffs between NavigationViewController
and the CarPlay device, as well as to customize some aspects of the CarPlay navigation experience. To take advantage of CarPlay functionality, your application must have a CarPlay navigation application entitlement and be built in Xcode 10 or above, and the user’s iPhone or iPad must have iOS 12 or above installed.
Core Navigation
MapboxNavigationService
is responsible for receiving user location updates and determining their relation to the route line. If you build a completely custom navigation UI, this is the class your code would interact with directly. The NavigationServiceDelegate
protocol allows your application to react to location-related events as they occur. Corresponding Notification
s from the NavigationService
‘s RouteController
are also posted to the shared NotificationCenter
. These notifications indicate the current state of the application in the form of a RouteProgress
object.
For further details, consult the guides and examples included with this API reference. If you have any questions, please see our help page. We welcome your bug reports, feature requests, and contributions.
Changes in version 2.10.0
Packaging
- MapboxCoreNavigation now requires MapboxNavigationNative v123.x. (#4331)
- MapboxNavigation now requires MapboxMaps v10.10.x. (#4315)
- MapboxCoreNavigation now requires MapboxDirections v2.9.1. (#4336)
- Cocoapods podspec for MapboxCoreNavigation now references resources that will be copied into the application. (#4280)
Routing
- Added
RouterDelegate.router(:shouldProactivelyRerouteFrom:to:completion)
,NavigationServiceDelegate.navigationService(:shouldProactivelyRerouteFrom:to:completion)
andNavigationViewControllerDelegate.navigationViewController(:shouldProactivelyRerouteFrom:to:completion)
methods to inform and providing control over each individual proactive rerouting attempt. (#4229) - Added
RouteController.updateRouteLeg(to:completionHandler:)
method to allow switching route legs arbitrarily. (#4261) - Predictive cache optimization for reducing memory and CPU consumption on very long and complex routes. (#4283)
- Fixed reset of DR driving out of the tunnel for a brief moment. (#4283)
- Fix the issue where continuous alternative routes are not vanishied correctly. (#4283)
- Fixed an issue where switching to a coincident online route sometimes resulted in using a route with different geometry than the original one. (#4305)
Map
- The maneuver arrow now extends 50 points along the route before and after an intersection, compared to 30 points previously. (#4230)
- Fixed issue with simultaneous recognition of tap gesture. (#4283)
- Fixed label localization to properly handle Simplified and Traditional Chinese. (#4283)
- Allow simultaneous recognition of map- and annotation- handling gesture recognizers. (#4283)
- Fixed an issue where text in the route duration annotation was not centered correctly on devices with different screen sizes. (#4130)
- Added
CarPlayManagerDelegate.carPlayManager(_:willAdd:for:)
,NavigationMapViewDelegate.navigationMapView(_:willAdd:)
andNavigationViewControllerDelegate.navigationViewController(_:willAdd:)
to modify the properties of the default layer which will be added to the map view during navigation. (#4277) - Fixed issue where the traversed route layer doesn’t share the same width with the main route casing layer after developers providing their own layer or midfying the layer properties. (#4277)
- Added
NavigationMapView.showcase(_:routesPresentationStyle:legIndex:animated:duration:completion:)
andNavigationMapView.show(_:layerPosition:legIndex:)
methods to drawIndexedRouteResponse
data and populate view’sroutes
andcontinuousAlternatives
properties accordingly. (#4294) - Fixed an issue where map wouldn’t be loaded in active navigation session on CarPlay. (#4315)
Location tracking
- Fixed a rare crash that could happen during route simulation. (#4153)
CarPlay
- Added the ability to display a junction image for the maneuver on CarPlay. (#4324)
Other changes
- Fixed potential issue when rerouting and route refreshing happen simultaneously which could lead to old route restoration or even a crash. (#4238)
- Fixed an issue where the route progress could be incorrectly calculated for folding back route steps. (#4234)
NavigationView.init(frame:tileStoreLocation:navigationMapView:)
,NavigationView.navigationMapView
,NavigationView.floatingStackView
,NavigationView.floatingButtons
,NavigationView.wayNameView
,NavigationView.speedLimitView
,NavigationView.topBannerContainerView
andNavigationView.bottomBannerContainerView
are now publicly accessible. (#4249)- Fixed an issue where empty intersections of the current step could cause a crash. (#4260)
- Deprecated
NavigationSettings.initialize(directions:tileStoreConfiguration:routingProviderSource:alternativeRouteDetectionStrategy:utilizeSensorData:navigatorPredictionInterval:liveIncidentsOptions:statusUpdatingSettings:)
method in favor ofNavigationSettings.initialize(with:)
. (#4275) - Added new parameter that allows configuring logging level for Mapbox SDKs. Checkout new
NavigationSettings.initialize(with:)
method for more information. (#4275) - Fixed an issue where the
UserHaloCourseView
will be shown under reduced location accuracy mode withNavigationMapview.reducedAccuracyActivatedMode
asfalse
. Right nowUserHaloCourseView
will be applied in only one case: when user explicitly setsNavigationMapView.reducedAccuracyActivatedMode
totrue
, and thePrecise Location
property in the settings of current application is disabled by user. (#4285) - Fixed an issue where
ExitView
used dark style when using InstructionCardViewController instead of light style for both highlighted and default states of the instruction card. (#4160) - Added
ExitView.highlightColor
andGenericShield.highlightColor
properties that allow users to customize the highlight color ofExitView
andGenericShield
s to better fit their applicationStyle
. (#4160) SimulatedLocationManager
’s initializerSimulatedLocationManager.init(route:currentDistance:currentSpeed:)
is now public. (#4276)- Added a console message when a newer version of Navigation SDK is available. (#4280)
- Fixed an issue where
Bundle.string(forMapboxNavigationInfoDictionaryKey:)
andBundle.string(forMapboxCoreNavigationInfoDictionaryKey
returned values from the application bundle instead of the Navigation SDK when statically linking using Cocoapods. (#4280) - Added
IndexedRouteReponse.parseAlternativeRoutes
method to extractAlternativeRoute
s data from a response. (#4294)