This page uses v1.4.2 of the Mapbox Navigation SDK. A newer version of the SDK is available. Learn about the latest version, v2.19.0, in the Navigation SDK documentation.
The Mapbox Navigation SDK gives you all the tools you need to add turn-by-turn navigation to your application. It takes only 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.
Structure of the SDK
The Navigation SDK is divided into two frameworks: the Mapbox Core Navigation framework (MapboxCoreNavigation) and the Mapbox Navigation framework (MapboxNavigation).
Mapbox Core Navigation
The Mapbox Core Navigation framework (MapboxCoreNavigation) contains the logic that allows you to receive user location updates, determine their relation to the route line, and get notifications that show the current state of the application in the form of a RouteProgress object.
You can use MapboxCoreNavigation directly in your project to build a completely custom navigation UI or use it via the Mapbox Navigation framework (MapboxNavigation), which is powered by MapboxCoreNavigation.
Mapbox Navigation
The Mapbox Navigation framework (MapboxNavigation) is the ready-made turn-by-turn navigation user interface (UI). Use MapboxNavigation to get up and running quickly with an in-app navigation experience. With a few lines of code, add a drop-in UI, automatic day-to-night map switching, and automatic rerouting in traffic. Adjust the style of various elements of the ready-made UI, react to location-related events as they occur, and adjust various aspects of the map view’s appearance.
Requirements
The Mapbox Navigation SDK and Core Navigation are compatible with applications written in Swift 5 in Xcode 10.2 and above. The Mapbox Navigation and Mapbox Core Navigation frameworks run on iOS 10.0 and above.
Available resources
For further details, consult the guides and examples included with this API reference. Documentation for the Mapbox Navigation SDK for iOS comes in the form of:
We welcome your bug reports, feature requests, and contributions. If you can't find what you're looking for, reach out to our support team.