Add argument support for TwoPaneLayoutNav destinations (#60)

* Update release versions in main readme

* Update dependencies

* Bump version

* Store graphContent with destination keys instead of strings

* Make sure default arg values are used

* Suppress restricted api warnings

Author: khalp

README.md

@@ -38,13 +38,13 @@ A utility component that helps you easily get details about the window state of
 
 Helper functions that help you easily test your application on the dual-screen, foldable and large screen devices.
 
-#### Latest Update: [1.0.0-alpha08](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/composetesting_20230208_alpha08) (February 8th, 2023)
+#### Latest Update: [1.0.0-alpha09](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/composetesting_20230505_alpha09) (May 5th, 2023)
 
 ### [DragAndDrop](https://github.com/microsoft/surface-duo-compose-sdk/tree/main/DragAndDrop)
 
 A Compose component that helps you build drag and drop feature on any Android devices, especially dual-screen, foldable and large-screen devices.
 
-#### Latest Update: [1.0.0-alpha04](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/draganddrop_20230208_alpha04) (February 8th, 2023)
+#### Latest Update: [1.0.0-alpha05](https://github.com/microsoft/surface-duo-compose-sdk/releases/tag/draganddrop_20230505_alpha05) (May 5th, 2023)
 
 ## Social links
 

TwoPaneLayout/README.md

@@ -20,7 +20,7 @@ When the app is spanned across a separating vertical hinge or fold, or when the
 2. Add dependencies to the module-level **build.gradle** file (current version may be different from what's shown here).
 
     ```gradle
-    implementation "com.microsoft.device.dualscreen:twopanelayout:1.0.1-alpha06"
+    implementation "com.microsoft.device.dualscreen:twopanelayout:1.0.1-alpha07"
     ```
 
 3. Also ensure the compileSdkVersion is set to API 33 and the targetSdkVersion is set to API 32 or newer in the module-level **build.gradle** file.

TwoPaneLayout/dependencies.gradle

@@ -14,16 +14,16 @@ ext {
 
     // TwoPaneLayout library version code:
     // If you want to publish a new version, bump in one (1) the specific line(s)
-    twoPaneLayoutVersionCode = 22
+    twoPaneLayoutVersionCode = 23
 
     // TwoPaneLayout library version name:
     // If you want to publish a new version, bump the specific line
-    twoPaneLayoutVersionName = '1.0.1-alpha06'
+    twoPaneLayoutVersionName = '1.0.1-alpha07'
 
     // ----------------------------------
 
-    gradlePluginVersion = '7.3.0'
-    kotlinVersion = '1.8.0'
+    gradlePluginVersion = '8.0.0'
+    kotlinVersion = '1.8.21'
     compileSdkVersion = 33
     targetSdkVersion = 32
     minSdkVersion = 24
@@ -44,18 +44,18 @@ ext {
     ]
 
     // AndroidX dependencies
-    appCompatVersion = '1.6.0'
-    ktxCoreVersion = '1.9.0'
+    appCompatVersion = '1.6.1'
+    ktxCoreVersion = '1.10.0'
     androidxDependencies = [
             appCompat         : "androidx.appcompat:appcompat:$appCompatVersion",
             ktxCore           : "androidx.core:core-ktx:$ktxCoreVersion",
     ]
 
     // Compose dependencies
-    composeVersion = '1.3.3'
-    composeMaterialVersion = '1.3.1'
-    composeCompilerVersion = '1.4.0'
-    activityComposeVersion = '1.6.1'
+    composeVersion = '1.4.3'
+    composeMaterialVersion = '1.4.3'
+    composeCompilerVersion = '1.4.7'
+    activityComposeVersion = '1.7.1'
     navigationComposeVersion = '2.5.3'
     composeDependencies = [
             composeMaterial         : "androidx.compose.material:material:$composeMaterialVersion",
@@ -84,8 +84,8 @@ ext {
     ]
 
     // Microsoft dependencies
-    windowStateVersion = '1.0.0-alpha08'
-    composeTestingVersion = '1.0.0-alpha07'
+    windowStateVersion = '1.0.0-alpha09'
+    composeTestingVersion = '1.0.0-alpha09'
     microsoftDependencies = [
             windowState         : "com.microsoft.device.dualscreen:windowstate:$windowStateVersion",
             composeTesting      : "com.microsoft.device.dualscreen.testing:testing-compose:$composeTestingVersion",

TwoPaneLayout/gradle.properties

@@ -19,4 +19,6 @@ android.useAndroidX=true
 android.enableJetifier=true
 # Kotlin code style for this project: "official" or "obsolete":
 kotlin.code.style=official
-android.disableAutomaticComponentCreation=true
+android.defaults.buildfeatures.buildconfig=true
+android.nonTransitiveRClass=false
+android.nonFinalResIds=false

TwoPaneLayout/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Thu Apr 15 16:13:21 PDT 2021
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-all.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

TwoPaneLayout/library/src/main/java/com/microsoft/device/dualscreen/twopanelayout/twopanelayoutnav/TwoPaneBackStackEntry.kt

@@ -45,9 +45,7 @@ fun NavGraphBuilder.composable(
     deepLinks: List<NavDeepLink> = emptyList(),
     content: @Composable TwoPaneNavScope.(NavBackStackEntry) -> Unit
 ) {
-    graphContent[route] = content
-
-    addDestination(
+    val destination =
         ComposeNavigator.Destination(provider[ComposeNavigator::class]) { TwoPaneNavScopeInstance.content(it) }
             .apply {
                 this.route = route
@@ -58,5 +56,8 @@ fun NavGraphBuilder.composable(
                     addDeepLink(deepLink)
                 }
             }
-    )
+
+    graphDestinations[destination] = content
+
+    addDestination(destination)
 }

TwoPaneLayout/library/src/main/java/com/microsoft/device/dualscreen/twopanelayout/twopanelayoutnav/TwoPaneLayoutNavCore.kt

@@ -1,6 +1,8 @@
 package com.microsoft.device.dualscreen.twopanelayout.twopanelayoutnav
 
 import android.annotation.SuppressLint
+import android.content.Context
+import android.os.Bundle
 import androidx.activity.compose.BackHandler
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
@@ -10,11 +12,15 @@ import androidx.compose.runtime.saveable.rememberSaveable
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.layout.Layout
+import androidx.compose.ui.platform.LocalContext
+import androidx.core.net.toUri
 import androidx.navigation.NavBackStackEntry
+import androidx.navigation.NavDeepLinkRequest
 import androidx.navigation.NavDestination
 import androidx.navigation.NavGraph
 import androidx.navigation.NavHostController
 import androidx.navigation.NavOptionsBuilder
+import androidx.navigation.compose.ComposeNavigator
 import androidx.navigation.compose.NavHost
 import com.microsoft.device.dualscreen.twopanelayout.Screen
 import com.microsoft.device.dualscreen.twopanelayout.TwoPaneNavScope
@@ -32,27 +38,47 @@ internal var getPane1Destination: () -> String = { "" }
 internal var getPane2Destination: () -> String = { "" }
 internal var getSinglePaneDestination: () -> String = { "" }
 internal val backStack = mutableListOf<TwoPaneBackStackEntry>()
-internal val graphContent = mutableMapOf<String, @Composable TwoPaneNavScope.(NavBackStackEntry) -> Unit>()
+internal val graphDestinations =
+    mutableMapOf<ComposeNavigator.Destination, @Composable TwoPaneNavScope.(NavBackStackEntry) -> Unit>()
 
 internal fun isSinglePaneHandler(): Boolean {
     return isSinglePane
 }
 
-private fun verifyRoute(route: String) {
-    if (!graphContent.keys.contains(route))
-        throw IllegalArgumentException("Invalid route $route, not present in list of routes ${graphContent.keys}")
+@SuppressLint("RestrictedApi")
+private fun getDeepLinkMatchForRoute(route: String): NavDestination.DeepLinkMatch {
+    val navDeepLinkRequest = NavDeepLinkRequest.Builder.fromUri(NavDestination.createRoute(route).toUri()).build()
+    var match: NavDestination.DeepLinkMatch? = null
+
+    graphDestinations.keys.firstOrNull {
+        match = it.matchDeepLink(navDeepLinkRequest)
+        match != null
+    }
+        ?: throw IllegalArgumentException("Invalid route $route, not present in list of destinations ${graphDestinations.keys}")
+
+    return match!!.apply { removePlaceholderArgs() }
 }
 
-private fun findGraphContent(route: String): @Composable TwoPaneNavScope.() -> Unit {
-    verifyRoute(route)
+@SuppressLint("RestrictedApi")
+private fun NavDestination.DeepLinkMatch.removePlaceholderArgs() {
+    matchingArgs?.let {
+        for (argName in it.keySet()) {
+            if (it.getString(argName) == "{$argName}")
+                matchingArgs?.remove(argName)
+        }
+    }
+}
 
-    val content = graphContent[route]!!
+@SuppressLint("RestrictedApi")
+private fun findGraphContent(route: String, context: Context): @Composable TwoPaneNavScope.() -> Unit {
+    val match = getDeepLinkMatchForRoute(route)
+    val destination = match.destination
+    val content = graphDestinations[destination]!!
+    val args = destination.addInDefaultArgs(match.matchingArgs) ?: Bundle()
 
-    // REVISIT: passing in empty entry, may update in the future if arguments need to be passed through
-    @SuppressLint("RestrictedApi")
-    val emptyBackStackEntry = NavBackStackEntry.create(null, NavDestination(""))
+    val backStackEntry = NavBackStackEntry.create(context, destination, args)
 
-    return { content(emptyBackStackEntry) }
+    return { content(backStackEntry) }
 }
 
 @Composable
@@ -110,13 +136,13 @@ internal fun TwoPaneContainer(
     // Initialize navigation method handlers
     navigatePane1To = { route ->
         if (currentPane1 != route) {
-            verifyRoute(route)
+            getDeepLinkMatchForRoute(route)
             currentPane1 = route
         }
     }
     navigatePane2To = { route ->
         if (currentPane2 != route) {
-            verifyRoute(route)
+            getDeepLinkMatchForRoute(route)
             currentPane2 = route
         }
     }
@@ -126,8 +152,9 @@ internal fun TwoPaneContainer(
         backStack.initialize(pane1StartDestination, pane2StartDestination)
 
     // Find the destinations to display in each pane
-    val pane1 = findGraphContent(currentPane1)
-    val pane2 = findGraphContent(currentPane2)
+    val context = LocalContext.current
+    val pane1 = findGraphContent(currentPane1, context)
+    val pane2 = findGraphContent(currentPane2, context)
 
     val measurePolicy = twoPaneMeasurePolicy(
         windowMode = windowState.windowMode,