You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat!: upgrade @googlemaps/react-native-navigation-sdk to v0.12.0 (#71)
* chore: upgrade dependencies to match the @googlemaps/react-native-navigation-sdk library
* feat: upgrade @googlemaps/react-native-navigation-sdk dependency version to ^0.12.0
BREAKING CHANGE: iOS header_dir changed to ReactNativeGoogleMapsDriver
BREAKING CHANGE: See navigation SDK v0.12.0 release notes: https://github.com/googlemaps/react-native-navigation-sdk/releases/tag/v0.12.0
Copy file name to clipboardExpand all lines: README.md
+86-27Lines changed: 86 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,31 @@ If your billing address is in the European Economic Area, effective on 8 July 20
8
8
9
9
This is the beta release of the Google Driver SDK package for React Native. It is an early look at the package and is intended for testing and feedback collection. The functionalities and APIs in this version are subject to change.
10
10
11
+
> [!NOTE]
12
+
> This package is in Beta until it reaches version 1.0. According to [semantic versioning](https://semver.org/#spec-item-4), breaking changes may be introduced before 1.0.
|**Minimum mobile OS supported**| SDK 23+ | iOS 16.0+ |
18
+
|**Minimum mobile OS supported**| SDK 24+ | iOS 16.0+ |
16
19
17
20
* A React Native project
18
-
* A Google Cloud project with the [Navigation SDK enabled](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project) and the [Maps SDK for iOS enabled](https://developers.google.com/maps/documentation/navigation/ios-sdk/config)
19
-
* An API key from the project above
21
+
* A Google Cloud project
22
+
* If you are a Mobility Services developer, you must contact Sales as described in [Mobility services documentation](https://developers.google.com/maps/documentation/transportation-logistics/mobility).
23
+
* If you are not a Mobility Services developer, refer to [Setup Google Cloud Project](https://developers.google.com/maps/documentation/navigation/android-sdk/cloud-setup) for instructions.
24
+
* An [API key](https://console.cloud.google.com/google/maps-apis/credentials) from the project above
25
+
* The API key must be configured for both Android and iOS. Refer to [Android Using Api Keys](https://developers.google.com/maps/documentation/navigation/android-sdk/get-api-key) and [iOS Using Api Keys](https://developers.google.com/maps/documentation/navigation/ios-sdk/get-api-key) respectively for instructions.
20
26
* If targeting Android, [Google Play Services](https://developers.google.com/android/guides/overview) installed and enabled
21
-
*[Attributions and licensing text](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project#include_the_required_attributions_in_your_app) added to your app.
22
-
* Install the [react-native-navigation-sdk](https://github.com/googlemaps/react-native-navigation-sdk) library on your application and set up a `NavigationView`.
27
+
*[Attributions and licensing text](https://developers.google.com/maps/documentation/navigation/android-sdk/set-up-project#include_the_required_attributions_in_your_app) added to your app
28
+
29
+
> [!IMPORTANT]
30
+
> [Apply API restrictions](https://developers.google.com/maps/api-security-best-practices#api-restriction) 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.
23
31
32
+
## React Native Compatibility
33
+
34
+
> [!IMPORTANT]
35
+
> This package does not yet support React Native's new architecture. Make sure the new architecture is disabled in your project configuration as shown in the [Installation](#installation) section.
24
36
25
37
## Installation
26
38
@@ -48,41 +60,88 @@ This is the beta release of the Google Driver SDK package for React Native. It i
48
60
49
61
### Android
50
62
51
-
1. Set the `minSdkVersion`in`android/app/build.gradle`:
63
+
64
+
#### Disable new architecture
65
+
66
+
This package does not yet support new architecture. Make sure new architecture is disabled in your `android/gradle.properties` file:
67
+
68
+
```groovy
69
+
newArchEnabled=false
70
+
```
71
+
72
+
#### Enable Jetifier
73
+
74
+
To ensure compatibility with AndroidX, enable Jetifier in your `android/gradle.properties` file:
75
+
76
+
```groovy
77
+
# Automatically convert third-party libraries to use AndroidX
78
+
android.enableJetifier=true
79
+
```
80
+
81
+
#### Enable Core Library Desugaring
82
+
83
+
Core library desugaring **must be enabled**for your Android project, regardless of your minSdkVersion.
84
+
85
+
To enable desugaring, update your `android/app/build.gradle` file:
To securely store your API key, it is recommended to use the [Google Maps Secrets Gradle Plugin](https://developers.google.com/maps/documentation/android-sdk/secrets-gradle-plugin). This plugin helps manage API keys without exposing them in your app's source code.
116
+
117
+
See example configuration for secrets plugin at example applications [build.gradle](./example/android/app/build.gradle) file.
80
118
81
119
### iOS
82
120
83
-
1. Set the iOS version in your application PodFile.
121
+
#### Disable new architecture
122
+
123
+
This package does not yet support new architecture. Make sure new architecture is disabled in your `ios/Podfile`:
84
124
85
-
`platform: ios, '16.0'`
125
+
```ruby
126
+
ENV['RCT_NEW_ARCH_ENABLED'] = '0'
127
+
```
128
+
129
+
#### Set Google Maps API Key
130
+
131
+
To set up, specify your API key in the application delegate `ios/Runner/AppDelegate.m`:
@@ -274,9 +333,9 @@ See the [Contributing guide](./CONTRIBUTING.md).
274
333
275
334
## Terms of Service
276
335
277
-
This package uses Google Maps Platform services, and any use of Google Maps Platform is subject to the [Terms of Service](https://cloud.google.com/maps-platform/terms).
336
+
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the [Google Maps Platform Terms of Service](https://cloud.google.com/maps-platform/terms).
278
337
279
-
For clarity, this package, and each underlying component, is not a Google Maps Platform Core Service.
338
+
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.
0 commit comments