Add Turn By Turn Navigation to Your Flutter Application Using MapBox. Never leave your app when you need to navigate your users to a location.

IOS 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 MGLMapboxAccessToken to your access token. You can obtain an access token from the Mapbox account page. 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 OpenStreetMap. 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 Capabilities tab. Under the Background Modes section, enable “Audio, AirPlay, and Picture in Picture” and “Location updates”. (Alternatively, add the audio and location values to the UIBackgroundModes array in the Info tab.)

Android Configuration #

Mapbox APIs and vector tiles require a Mapbox account and API access token. Add your token in strings.xml file of your android apps res/values/ path. The string key should be "mapbox_access_token". You can obtain an access token from the Mapbox account page.

<?xml version="1.0" encoding="utf-8"?> <resources> <string name="app_name">Navigation map</string> <string name="mapbox_access_token" translatable="false">ADD_MAPBOX_ACCESS_TOKEN_HERE</string> <string name="user_location_permission_explanation">This app needs location permissions to show its functionality.</string> <string name="user_location_permission_not_granted">You didn\'t grant location permissions.</string> </resources>

Add the following permission to the app level Android Manifest

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Declare an instance

MapboxNavigation _directions;

Initialize It

initState() { _directions = MapBoxNavigation(onRouteEvent: _onRouteEvent); }

Set Route Options

_options = MapBoxOptions( initialLatitude: 36.1175275, initialLongitude: -115.1839524, zoom: 13.0, tilt: 0.0, bearing: 0.0, enableRefresh: false, alternatives: true, voiceInstructionsEnabled: true, bannerInstructionsEnabled: true, allowsUTurnAtWayPoints: true, mode: MapBoxNavigationMode.drivingWithTraffic, units: VoiceUnits.imperial, simulateRoute: true, language: "en")

Listen for Events

Future<void> _onRouteEvent(e) async { _distanceRemaining = await _directions.distanceRemaining; _durationRemaining = await _directions.durationRemaining; switch (e.eventType) { case MapBoxEvent.progress_change: var progressEvent = e.data as RouteProgressEvent; _arrived = progressEvent.arrived; if (progressEvent.currentStepInstruction != null) _instruction = progressEvent.currentStepInstruction; break; case MapBoxEvent.route_building: case MapBoxEvent.route_built: _routeBuilt = true; break; case MapBoxEvent.route_build_failed: _routeBuilt = false; break; case MapBoxEvent.navigation_running: _isNavigating = true; break; case MapBoxEvent.on_arrival: _arrived = true; if (!_isMultipleStop) { await Future.delayed(Duration(seconds: 3)); await _controller.finishNavigation(); } else {} break; case MapBoxEvent.navigation_finished: case MapBoxEvent.navigation_cancelled: _routeBuilt = false; _isNavigating = false; break; default: break; } //refresh UI setState(() {}); }

Begin Navigating

final cityhall = WayPoint(name: "City Hall", latitude: 42.886448, longitude: -78.878372); final downtown = WayPoint(name: "Downtown Buffalo", latitude: 42.8866177, longitude: -78.8814924); var wayPoints = List<WayPoint>(); wayPoints.add(cityHall); wayPoints.add(downtown); await _directions.startNavigation(wayPoints: wayPoints, options: _options);

Embedding Navigation View #

Embedded iOS View Embedded Android View

Embedded Sample Code #

Declare Controller

MapBoxNavigationViewController _controller;

Add Navigation View to Widget Tree

Container( color: Colors.grey, child: MapBoxNavigationView( options: _options, onRouteEvent: _onRouteEvent, onCreated: (MapBoxNavigationViewController controller) async { _controller = controller; }), ),

Build Route

var wayPoints = List<WayPoint>(); wayPoints.add(_origin); wayPoints.add(_stop1); wayPoints.add(_stop2); wayPoints.add(_stop3); wayPoints.add(_stop4); wayPoints.add(_origin); _controller.buildRoute(wayPoints: wayPoints);

Start Navigation

_controller.startNavigation();

Additional IOS Configuration #

Add the following to your info.plist file

<dict> ... <key>io.flutter.embedded_views_preview</key> <true/> ... </dict>

iOS View Android View

To Do #