Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow configuration of Android SDK variant #622

Merged
merged 3 commits into from
Jan 20, 2025
Merged

feat: allow configuration of Android SDK variant #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9132479
feat: allow configuration of Android SDK variant
KiwiKilian Jan 18, 2025
82d166a
style: format build.gradle
KiwiKilian Jan 18, 2025
30a09c2
docs: improve wording
KiwiKilian Jan 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions android/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def getExtOrDefault(name) {
}

def getConfigurableExtOrDefault(name) {
return rootProject.ext.has("org.maplibre.reactnative." + name) ? rootProject.ext.get("org.maplibre.reactnative." + name) : project.properties["org.maplibre.reactnative." + name]
return rootProject.ext.has("org.maplibre.reactnative." + name) ? rootProject.ext.get("org.maplibre.reactnative." + name) : project.properties["org.maplibre.reactnative." + name]
}

def getExtOrIntegerDefault(name) {
Expand Down Expand Up @@ -117,12 +117,18 @@ dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"

// MapLibre Native
implementation "org.maplibre.gl:android-sdk:${getConfigurableExtOrDefault('nativeVersion')}"
implementation "org.maplibre.gl:android-sdk-${getConfigurableExtOrDefault('nativeVariant')}:${getConfigurableExtOrDefault('nativeVersion')}"

// MapLibre Plugins
implementation "org.maplibre.gl:android-plugin-localization-v9:${getConfigurableExtOrDefault('pluginVersion')}"
implementation "org.maplibre.gl:android-plugin-annotation-v9:${getConfigurableExtOrDefault('pluginVersion')}"
implementation "org.maplibre.gl:android-plugin-markerview-v9:${getConfigurableExtOrDefault('pluginVersion')}"
implementation("org.maplibre.gl:android-plugin-localization-v9:${getConfigurableExtOrDefault('pluginVersion')}") {
exclude(group: "org.maplibre.gl", module: "android-sdk")
}
implementation("org.maplibre.gl:android-plugin-annotation-v9:${getConfigurableExtOrDefault('pluginVersion')}") {
exclude(group: "org.maplibre.gl", module: "android-sdk")
}
implementation("org.maplibre.gl:android-plugin-markerview-v9:${getConfigurableExtOrDefault('pluginVersion')}") {
exclude(group: "org.maplibre.gl", module: "android-sdk")
}

// Dependencies
implementation "org.maplibre.gl:android-sdk-turf:${getConfigurableExtOrDefault('turfVersion')}"
Expand Down
1 change: 1 addition & 0 deletions android/gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ org.maplibre.reactnative.ndkVersion=21.4.7075529

# MapLibre React Native
org.maplibre.reactnative.nativeVersion=11.8.0
org.maplibre.reactnative.nativeVariant=opengl
org.maplibre.reactnative.pluginVersion=3.0.2
org.maplibre.reactnative.turfVersion=6.0.1
org.maplibre.reactnative.okhttpVersion=4.9.0
Expand Down
26 changes: 18 additions & 8 deletions docs/content/setup/library-customizations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,16 @@ export default ({ config }: ConfigContext): ExpoConfig => ({

When using React Native, the customizations have to be applied differently for each platform.

### Android

On Android they are set in the `gradle.properties`, each of them prefixed with `org.maplibre.reactnative`. Example:

```diff
+ org.maplibre.reactnative.nativeVersion=x.x.x
```

### iOS

On iOS global variables in the `Podfile` are used, prefixed with `$MLRN`.

```diff
Expand All @@ -55,17 +59,23 @@ target "AppName" do

### Android

| Prop Key | Type | Description |
| ----------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------- |
| `nativeVersion` | `VersionString` | Version for [`org.maplibre.gl:android-sdk`](https://mvnrepository.com/artifact/org.maplibre.gl/android-sdk) |
| `pluginVersion` | `VersionString` | Version for `org.maplibre.gl:android-plugin-*-v9` |
| `turfVersion` | `VersionString` | Version for `org.maplibre.gl:android-sdk-turf` |
| `okhttpVersion` | `VersionString` | Version for `com.squareup.okhttp3:okhttp` |
| `locationEngine` | `"default" \| "google"` | [Location engine to be used](#location-engine) |
| `googlePlayServicesLocationVersion` | `VersionString` | Version for `com.google.android.gms:play-services-location`, only used with `locationEngine: "google"` |
| Prop Key | Type | Description |
| ----------------------------------- |-------------------------|---------------------------------------------------------------------------------------------------------------|
| `nativeVersion` | `VersionString` | Version for [`org.maplibre.gl:android-sdk-*`](https://mvnrepository.com/artifact/org.maplibre.gl/android-sdk) |
| `nativeVariant` | `"opengl" \| "vulkan"` | [Variant of `org.maplibre.gl:android-sdk-*`](#native-variant) |
| `pluginVersion` | `VersionString` | Version for `org.maplibre.gl:android-plugin-*-v9` |
| `turfVersion` | `VersionString` | Version for `org.maplibre.gl:android-sdk-turf` |
| `okhttpVersion` | `VersionString` | Version for `com.squareup.okhttp3:okhttp` |
| `locationEngine` | `"default" \| "google"` | [Location engine to be used](#location-engine) |
| `googlePlayServicesLocationVersion` | `VersionString` | Version for `com.google.android.gms:play-services-location`, only used with `locationEngine: "google"` |

For default values see [`gradle.properties` of the library](https://github.com/maplibre/maplibre-react-native/tree/main/android/gradle.properties).

#### Native Variant

You can choose between the current default OpenGL ES and the newer Vulkan rendering backend. Read more on the
[MapLibre Native Release introducing Vulkan](https://github.com/maplibre/maplibre-native/releases/tag/android-v11.7.0).

#### Location Engine

Two location engines are available on Android:
Expand Down
8 changes: 7 additions & 1 deletion src/plugin/MapLibrePluginProps.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,15 @@ export type MapLibrePluginProps =
*/
android?: {
/**
* Version for `org.maplibre.gl:android-sdk`
* Version for `org.maplibre.gl:android-sdk-*`
*/
nativeVersion?: VersionString;
/**
* Variant of `org.maplibre.gl:android-sdk-*`
*
* @default "vulkan"
*/
nativeVariant?: "opengl" | "vulkan";
/**
* Version for `org.maplibre.gl:android-plugin-*-v9`
*/
Expand Down
Loading