expo-navigation-bar 2.4.1 → 2.5.0

package/CHANGELOG.md

@@ -10,6 +10,16 @@
 
 ### 💡 Others
 
+## 2.5.0 — 2023-09-04
+
+### 🎉 New features
+
+- Added support for React Native 0.73. ([#24018](https://github.com/expo/expo/pull/24018) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Migrate to Expo Modules API. ([#23933](https://github.com/expo/expo/pull/23933) by [@alanjhughes](https://github.com/alanjhughes))
+
 ## 2.4.1 — 2023-08-02
 
 ### 🐛 Bug fixes

package/android/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
 group = 'host.exp.exponent'
-version = '2.4.1'
+version = '2.5.0'
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -53,13 +53,16 @@ afterEvaluate {
 android {
   compileSdkVersion safeExtGet("compileSdkVersion", 33)
 
-  compileOptions {
-    sourceCompatibility JavaVersion.VERSION_11
-    targetCompatibility JavaVersion.VERSION_11
-  }
+  def agpVersion = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION
+  if (agpVersion.tokenize('.')[0].toInteger() < 8) {
+    compileOptions {
+      sourceCompatibility JavaVersion.VERSION_11
+      targetCompatibility JavaVersion.VERSION_11
+    }
 
-  kotlinOptions {
-    jvmTarget = JavaVersion.VERSION_11.majorVersion
+    kotlinOptions {
+      jvmTarget = JavaVersion.VERSION_11.majorVersion
+    }
   }
 
   namespace "expo.modules.navigationbar"
@@ -67,7 +70,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 33)
     versionCode 1
-    versionName '2.4.1'
+    versionName '2.5.0'
   }
   lintOptions {
     abortOnError false

package/android/src/main/java/expo/modules/navigationbar/NavigationBarExceptions.kt

@@ -0,0 +1,6 @@
+package expo.modules.navigationbar
+
+import expo.modules.kotlin.exception.CodedException
+
+internal class NavigationBarException(message: String) :
+  CodedException(message)

package/android/src/main/java/expo/modules/navigationbar/NavigationBarModule.kt

@@ -1,7 +1,5 @@
 package expo.modules.navigationbar
 
-import android.app.Activity
-import android.content.Context
 import android.graphics.Color
 import android.os.Build
 import android.os.Bundle
@@ -9,145 +7,87 @@ import android.view.View
 import android.view.WindowInsets
 import androidx.core.view.ViewCompat
 import androidx.core.view.WindowInsetsControllerCompat
-import expo.modules.core.ExportedModule
-import expo.modules.core.ModuleRegistry
-import expo.modules.core.Promise
-import expo.modules.core.errors.CurrentActivityNotFoundException
-import expo.modules.core.interfaces.ActivityProvider
-import expo.modules.core.interfaces.ExpoMethod
-import expo.modules.core.interfaces.services.EventEmitter
+import expo.modules.kotlin.Promise
+import expo.modules.kotlin.exception.Exceptions
+import expo.modules.kotlin.functions.Queues
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+import expo.modules.navigationbar.singletons.NavigationBar
 
-class NavigationBarModule(context: Context) : ExportedModule(context) {
+class NavigationBarModule : Module() {
+  private val activity
+    get() = appContext.currentActivity
+      ?: throw Exceptions.MissingActivity()
 
-  private lateinit var mActivityProvider: ActivityProvider
-  private lateinit var mEventEmitter: EventEmitter
+  override fun definition() = ModuleDefinition {
+    Name("ExpoNavigationBar")
 
-  override fun getName(): String {
-    return NAME
-  }
-
-  override fun onCreate(moduleRegistry: ModuleRegistry) {
-    mActivityProvider = moduleRegistry.getModule(ActivityProvider::class.java)
-      ?: throw IllegalStateException("Could not find implementation for ActivityProvider.")
-    mEventEmitter = moduleRegistry.getModule(EventEmitter::class.java) ?: throw IllegalStateException("Could not find implementation for EventEmitter.")
-  }
+    Events(VISIBILITY_EVENT_NAME)
 
-  // Ensure that rejections are passed up to JS rather than terminating the native client.
-  private fun safeRunOnUiThread(promise: Promise, block: (activity: Activity) -> Unit) {
-    val activity = mActivityProvider.currentActivity
-    if (activity == null) {
-      promise.reject(CurrentActivityNotFoundException())
-      return
-    }
-    activity.runOnUiThread {
-      block(activity)
-    }
-  }
-
-  @ExpoMethod
-  fun setBackgroundColorAsync(color: Int, promise: Promise) {
-    safeRunOnUiThread(promise) {
-      NavigationBar.setBackgroundColor(it, color, { promise.resolve(null) }, { m -> promise.reject(ERROR_TAG, m) })
-    }
-  }
+    AsyncFunction("setBackgroundColorAsync") { color: Int, promise: Promise ->
+      NavigationBar.setBackgroundColor(activity, color, { promise.resolve(null) }, { m -> promise.reject(NavigationBarException(m)) })
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun getBackgroundColorAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      val color = colorToHex(it.window.navigationBarColor)
-      promise.resolve(color)
-    }
-  }
+    AsyncFunction("getBackgroundColorAsync") {
+      return@AsyncFunction colorToHex(activity.window.navigationBarColor)
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun setBorderColorAsync(color: Int, promise: Promise) {
-    safeRunOnUiThread(promise) {
-      NavigationBar.setBorderColor(it, color, { promise.resolve(null) }, { m -> promise.reject(ERROR_TAG, m) })
-    }
-  }
+    AsyncFunction("setBorderColorAsync") { color: Int, promise: Promise ->
+      NavigationBar.setBorderColor(activity, color, { promise.resolve(null) }, { m -> promise.reject(NavigationBarException(m)) })
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun getBorderColorAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
+    AsyncFunction("getBorderColorAsync") {
       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
-        val color = colorToHex(it.window.navigationBarDividerColor)
-        promise.resolve(color)
+        return@AsyncFunction colorToHex(activity.window.navigationBarDividerColor)
       } else {
-        promise.reject(ERROR_TAG, "'getBorderColorAsync' is only available on Android API 28 or higher")
+        throw NavigationBarException("'getBorderColorAsync' is only available on Android API 28 or higher")
       }
-    }
-  }
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun setButtonStyleAsync(buttonStyle: String, promise: Promise) {
-    safeRunOnUiThread(promise) {
+    AsyncFunction("setButtonStyleAsync") { buttonStyle: String, promise: Promise ->
       NavigationBar.setButtonStyle(
-        it, buttonStyle,
+        activity, buttonStyle,
         {
           promise.resolve(null)
         },
-        { m -> promise.reject(ERROR_TAG, m) }
+        { m -> promise.reject(NavigationBarException(m)) }
       )
-    }
-  }
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun getButtonStyleAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      WindowInsetsControllerCompat(it.window, it.window.decorView).let { controller ->
-        val style = if (controller.isAppearanceLightNavigationBars) "dark" else "light"
-        promise.resolve(style)
+    AsyncFunction("getButtonStyleAsync") {
+      WindowInsetsControllerCompat(activity.window, activity.window.decorView).let { controller ->
+        return@AsyncFunction if (controller.isAppearanceLightNavigationBars) "dark" else "light"
       }
-    }
-  }
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun setVisibilityAsync(visibility: String, promise: Promise) {
-    safeRunOnUiThread(promise) {
-      NavigationBar.setVisibility(it, visibility, { promise.resolve(null) }, { m -> promise.reject(ERROR_TAG, m) })
-    }
-  }
+    AsyncFunction("setVisibilityAsync") { visibility: String, promise: Promise ->
+      NavigationBar.setVisibility(activity, visibility, { promise.resolve(null) }, { m -> promise.reject(NavigationBarException(m)) })
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun getVisibilityAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
+    AsyncFunction("getVisibilityAsync") {
       val isVisible = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-        it.window.decorView.rootWindowInsets.isVisible(WindowInsets.Type.navigationBars())
+        activity.window.decorView.rootWindowInsets.isVisible(WindowInsets.Type.navigationBars())
       } else {
         @Suppress("DEPRECATION")
-        (View.SYSTEM_UI_FLAG_HIDE_NAVIGATION and it.window.decorView.systemUiVisibility) == 0
+        (View.SYSTEM_UI_FLAG_HIDE_NAVIGATION and activity.window.decorView.systemUiVisibility) == 0
       }
-      val visibility = if (isVisible) "visible" else "hidden"
-      promise.resolve(visibility)
-    }
-  }
+      return@AsyncFunction if (isVisible) "visible" else "hidden"
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun setPositionAsync(position: String, promise: Promise) {
-    safeRunOnUiThread(promise) {
-      NavigationBar.setPosition(it, position, { promise.resolve(null) }, { m -> promise.reject(ERROR_TAG, m) })
-    }
-  }
+    AsyncFunction("setPositionAsync") { position: String, promise: Promise ->
+      NavigationBar.setPosition(activity, position, { promise.resolve(null) }, { m -> promise.reject(NavigationBarException(m)) })
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun unstable_getPositionAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      val position = if (ViewCompat.getFitsSystemWindows(it.window.decorView)) "relative" else "absolute"
-      promise.resolve(position)
-    }
-  }
+    AsyncFunction("unstable_getPositionAsync") {
+      return@AsyncFunction if (ViewCompat.getFitsSystemWindows(activity.window.decorView)) "relative" else "absolute"
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun setBehaviorAsync(behavior: String, promise: Promise) {
-    safeRunOnUiThread(promise) {
-      NavigationBar.setBehavior(it, behavior, { promise.resolve(null) }, { m -> promise.reject(ERROR_TAG, m) })
-    }
-  }
+    AsyncFunction("setBehaviorAsync") { behavior: String, promise: Promise ->
+      NavigationBar.setBehavior(activity, behavior, { promise.resolve(null) }, { m -> promise.reject(NavigationBarException(m)) })
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun getBehaviorAsync(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      WindowInsetsControllerCompat(it.window, it.window.decorView).let { controller ->
+    AsyncFunction("getBehaviorAsync") {
+      WindowInsetsControllerCompat(activity.window, activity.window.decorView).let { controller ->
         val behavior = when (controller.systemBarsBehavior) {
           // TODO: Maybe relative / absolute
           WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE -> "overlay-swipe"
@@ -155,22 +95,20 @@ class NavigationBarModule(context: Context) : ExportedModule(context) {
           // WindowInsetsControllerCompat.BEHAVIOR_SHOW_BARS_BY_TOUCH -> "inset-touch"
           else -> "inset-touch"
         }
-        promise.resolve(behavior)
-      }
-    }
-  }
 
-  /* Events */
+        return@AsyncFunction behavior
+      }
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun startObserving(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      val decorView = it.window.decorView
+    // We are not using `OnStartObserving` and `OnStopObserving` here because when switching threads
+    // they will resolve the promise quicker and the JS won't wait for observer removal
+    AsyncFunction("startObserving") {
+      val decorView = activity.window.decorView
       @Suppress("DEPRECATION")
       decorView.setOnSystemUiVisibilityChangeListener { visibility: Int ->
-        var isNavigationBarVisible = (visibility and View.SYSTEM_UI_FLAG_HIDE_NAVIGATION) == 0
-        var stringVisibility = if (isNavigationBarVisible) "visible" else "hidden"
-        mEventEmitter.emit(
+        val isNavigationBarVisible = (visibility and View.SYSTEM_UI_FLAG_HIDE_NAVIGATION) == 0
+        val stringVisibility = if (isNavigationBarVisible) "visible" else "hidden"
+        sendEvent(
           VISIBILITY_EVENT_NAME,
           Bundle().apply {
             putString("visibility", stringVisibility)
@@ -178,24 +116,17 @@ class NavigationBarModule(context: Context) : ExportedModule(context) {
           }
         )
       }
-      promise.resolve(null)
-    }
-  }
+    }.runOnQueue(Queues.MAIN)
 
-  @ExpoMethod
-  fun stopObserving(promise: Promise) {
-    safeRunOnUiThread(promise) {
-      val decorView = it.window.decorView
+    AsyncFunction("stopObserving") {
+      val decorView = activity.window.decorView
       @Suppress("DEPRECATION")
       decorView.setOnSystemUiVisibilityChangeListener(null)
-      promise.resolve(null)
-    }
+    }.runOnQueue(Queues.MAIN)
   }
 
   companion object {
-    private const val NAME = "ExpoNavigationBar"
     private const val VISIBILITY_EVENT_NAME = "ExpoNavigationBar.didChange"
-    private const val ERROR_TAG = "ERR_NAVIGATION_BAR"
 
     fun colorToHex(color: Int): String {
       return String.format("#%02x%02x%02x", Color.red(color), Color.green(color), Color.blue(color))

package/android/src/main/java/expo/modules/navigationbar/NavigationBarPackage.kt

@@ -2,14 +2,10 @@ package expo.modules.navigationbar
 
 import android.content.Context
 import expo.modules.core.BasePackage
-import expo.modules.core.ExportedModule
 import expo.modules.core.interfaces.ReactActivityLifecycleListener
 
 class NavigationBarPackage : BasePackage() {
-  override fun createExportedModules(context: Context): List<ExportedModule> {
-    return listOf(NavigationBarModule(context) as ExportedModule)
-  }
   override fun createReactActivityLifecycleListeners(activityContext: Context): List<ReactActivityLifecycleListener> {
-    return listOf(NavigationBarReactActivityLifecycleListener(activityContext))
+    return listOf(NavigationBarReactActivityLifecycleListener())
   }
 }

package/android/src/main/java/expo/modules/navigationbar/NavigationBarReactActivityLifecycleListener.kt

@@ -5,46 +5,47 @@ import android.content.Context
 import android.os.Bundle
 import android.util.Log
 import expo.modules.core.interfaces.ReactActivityLifecycleListener
+import expo.modules.navigationbar.singletons.NavigationBar
 
 // this needs to stay for versioning to work
 // EXPO_VERSIONING_NEEDS_EXPOVIEW_R
 
-class NavigationBarReactActivityLifecycleListener(activityContext: Context) : ReactActivityLifecycleListener {
+class NavigationBarReactActivityLifecycleListener : ReactActivityLifecycleListener {
   override fun onCreate(activity: Activity, savedInstanceState: Bundle?) {
     // Execute static tasks before the JS engine starts.
     // These values are defined via config plugins.
 
-    var borderColor = getBorderColor(activity)
+    val borderColor = getBorderColor(activity)
     if (borderColor != null) {
       NavigationBar.setBorderColor(activity, borderColor)
     }
 
-    var visibility = getVisibility(activity)
-    if (visibility != "") {
+    val visibility = getVisibility(activity)
+    if (visibility.isNotBlank()) {
       NavigationBar.setVisibility(activity, visibility)
     }
 
-    var position = getPosition(activity)
-    if (position != "") {
+    val position = getPosition(activity)
+    if (position.isNotBlank()) {
       NavigationBar.setPosition(activity, position)
     }
 
-    var behavior = getBehavior(activity)
-    if (behavior != "") {
+    val behavior = getBehavior(activity)
+    if (behavior.isNotBlank()) {
       NavigationBar.setBehavior(activity, behavior)
     }
 
-    var legacyVisible = getLegacyVisible(activity)
-    if (legacyVisible != "") {
+    val legacyVisible = getLegacyVisible(activity)
+    if (legacyVisible.isNotBlank()) {
       NavigationBar.setLegacyVisible(activity, legacyVisible)
     }
   }
 
   private fun getBorderColor(context: Context): Int? {
-    var value = context.getString(R.string.expo_navigation_bar_border_color)
+    val value = context.getString(R.string.expo_navigation_bar_border_color)
 
-    var parsed = value.toIntOrNull()
-    if (value != null && value != "" && parsed == null) {
+    val parsed = value.toIntOrNull()
+    if (value.isNotBlank() && parsed == null) {
       Log.e(ERROR_TAG, "Invalid XML value \"$value\" for string \"expo_navigation_bar_border_color\". Expected a valid color int like \"-12177173\". Ensure the value of \"borderColor\" in the \"expo-navigation-bar\" config plugin is a valid CSS color. Skipping initial border color.")
     }
     return parsed

package/android/src/main/java/expo/modules/navigationbar/singletons/NavigationBar.kt

@@ -1,4 +1,4 @@
-package expo.modules.navigationbar
+package expo.modules.navigationbar.singletons
 
 import android.app.Activity
 import android.os.Build
@@ -7,15 +7,10 @@ import android.view.View
 import androidx.core.view.WindowCompat
 import androidx.core.view.WindowInsetsCompat
 import androidx.core.view.WindowInsetsControllerCompat
-import expo.modules.core.interfaces.SingletonModule
 
-object NavigationBar : SingletonModule {
+object NavigationBar {
   private const val TAG = "NavigationBar"
 
-  override fun getName(): String {
-    return "NavigationBar"
-  }
-
   fun setBackgroundColor(
     activity: Activity,
     color: Int,

package/expo-module.config.json

@@ -1,4 +1,7 @@
 {
   "name": "expo-navigation-bar",
-  "platforms": ["android"]
+  "platforms": ["android"],
+  "android": {
+    "modules": ["expo.modules.navigationbar.NavigationBarModule"]
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-navigation-bar",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Interact with the system navigation bar",
   "main": "build/NavigationBar.js",
   "types": "build/NavigationBar.d.ts",
@@ -43,5 +43,5 @@
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "2240630a92eb79a4e4bf73e1439916c394876478"
+  "gitHead": "79607a7325f47aa17c36d266100d09a4ff2cc544"
 }

package/plugin/build/withNavigationBar.d.ts

@@ -1,6 +1,6 @@
-import { NavigationBarVisibility, NavigationBarBehavior, NavigationBarPosition, NavigationBarButtonStyle } from 'expo-navigation-bar';
 import { ExpoConfig } from 'expo/config';
 import { ConfigPlugin, AndroidConfig } from 'expo/config-plugins';
+import { NavigationBarVisibility, NavigationBarBehavior, NavigationBarPosition, NavigationBarButtonStyle } from 'expo-navigation-bar';
 export type Props = {
     borderColor?: string;
     backgroundColor?: string | null;

package/plugin/src/withNavigationBar.ts

@@ -2,12 +2,6 @@
 import normalizeColor from '@react-native/normalize-color';
 // @ts-ignore
 import Debug from 'debug';
-import {
-  NavigationBarVisibility,
-  NavigationBarBehavior,
-  NavigationBarPosition,
-  NavigationBarButtonStyle,
-} from 'expo-navigation-bar';
 import { ExpoConfig } from 'expo/config';
 import {
   ConfigPlugin,
@@ -18,6 +12,12 @@ import {
   withAndroidColors,
   withAndroidStyles,
 } from 'expo/config-plugins';
+import {
+  NavigationBarVisibility,
+  NavigationBarBehavior,
+  NavigationBarPosition,
+  NavigationBarButtonStyle,
+} from 'expo-navigation-bar';
 
 const debug = Debug('expo:system-navigation-bar:plugin');