Description

Note

This package is in Beta until it reaches version 1.0. According tosemantic versioning, breaking changes may be introduced before 1.0.

Requirements

Important

Apply API restrictions to the API key to limit usage to "Navigation SDK, "Maps SDK for Android", and "Maps SDK for iOS" for enhanced security and cost management. This helps guard against unauthorized use of your API key.

Installation

flutter pub add google_navigation_flutter

Android

android {    defaultConfig {        minSdk23    }}

android {...    compileOptions {        coreLibraryDesugaringEnabledtrue...    }}dependencies {    coreLibraryDesugaring'com.android.tools:desugar_jdk_libs_nio:2.0.4'}

iOS

  # Set platform to 16.0 to enable latest Google Maps SDK  platform :ios, '16.0'

Set Google Maps API Key

Usage

Add a navigation view

import'package:flutter/material.dart';import'package:google_navigation_flutter/google_navigation_flutter.dart';classNavigationSampleextendsStatefulWidget {constNavigationSample({super.key});@overrideState<NavigationSample>createState()=>_NavigationSampleState();}class_NavigationSampleStateextendsState<NavigationSample> {GoogleNavigationViewController? _navigationViewController;bool _navigationSessionInitialized=false;@overridevoidinitState() {super.initState();_initializeNavigationSession();  }Future<void>_initializeNavigationSession()async {if (!awaitGoogleMapsNavigator.areTermsAccepted()) {awaitGoogleMapsNavigator.showTermsAndConditionsDialog('Example title','Example company',      );    }// Note: make sure user has also granted location permissions before starting navigation session.awaitGoogleMapsNavigator.initializeNavigationSession(taskRemovedBehavior:TaskRemovedBehavior.continueService);setState(() {      _navigationSessionInitialized=true;    });  }@overrideWidgetbuild(BuildContext context) {returnScaffold(      appBar:AppBar(title:constText('Google Maps Navigation Sample')),      body: _navigationSessionInitialized?GoogleMapsNavigationView(              onViewCreated: _onViewCreated,              initialNavigationUIEnabledPreference:NavigationUIEnabledPreference.disabled,// Other view initialization settings            ):constCenter(child:CircularProgressIndicator()),    );  }void_onViewCreated(GoogleNavigationViewController controller) {    _navigationViewController= controller;    controller.setMyLocationEnabled(true);// Additional setup can be added here.  }@overridevoiddispose() {if (_navigationSessionInitialized) {GoogleMapsNavigator.cleanup();    }super.dispose();  }}

Note

Route calculation is only available after the Navigation SDK has successfully acquired the user's location. If the location is not yet available when trying to set a destination, the SDK will return a NavigationRouteStatus.locationUnavailable status.

To avoid this, ensure that the SDK has provided a valid user location before calling the setDestinations function. You can do this by subscribing to the RoadSnappedLocationUpdatedEvent and waiting for the first valid location update.

Task Removed Behavior

Add a map view

@overrideWidgetbuild(BuildContext context) {returnScaffold(      appBar:AppBar(title:constText('Google Maps Navigation Sample')),      body: _navigationSessionInitialized?GoogleMapsMapView(              onViewCreated: _onViewCreated,              initialCameraPosition:CameraPosition(// Initialize map to user location.                target: _userLocation!,                zoom:15,              ),// Other view initialization settings            ):constCenter(child:CircularProgressIndicator()),    );  }

Requesting and handling permissions

Note

The management of these permissions falls outside the scope of the Navigation SDKs for Android and iOS. As a developer integrating these SDKs into your applications, you are responsible for requesting and obtaining the necessary permissions from the users of your app.

PermissionStatus _locationPermissionStatus=PermissionStatus.denied;// .../// Request permission for accessing the device's location.////// Android: Fine and Coarse Location/// iOS: CoreLocation (Always and WhenInUse)Future<void>_requestLocationPermission()async {finalPermissionStatus status=awaitPermission.location.request();setState(() {    _locationPermissionStatus= status;  });}// ...@overrideWidgetbuild(BuildContext context) {_requestLocationPermission();  ...}

Support for Android Auto and Apple CarPlay

Known issues

Compatibility with other libraries

Note

This package provides aGoogleMapsMapView widget, which can be used as a classic Google Maps view without navigation. SeeAdd a map view for details.

Contributing

Terms of Service

Support