Add bottom sheet recipe

README.md

@@ -5,29 +5,34 @@ use its APIs to implement common navigation use cases.
 ## Recipes
 These are the recipes and what they demonstrate. 
 
-**Basic API examples**
+### Basic API examples
 - **[Basic](app/src/main/java/com/example/nav3recipes/basic)**: Shows most basic API usage.
 - **[Saveable back stack](app/src/main/java/com/example/nav3recipes/basicsaveable)**: As above, with a persistent back stack.
 - **[Entry provider DSL](app/src/main/java/com/example/nav3recipes/basicdsl)**: As above, using the entryProvider DSL.
 
-**Layouts and animations**
-- **[Material adaptive](app/src/main/java/com/example/nav3recipes/scenes/materiallistdetail)**: Shows how to use a Material list-detail layout. 
+### Layouts and animations
 - **[Dialog](app/src/main/java/com/example/nav3recipes/dialog)**: Shows how to create a Dialog destination.
 - **[Custom Scene](app/src/main/java/com/example/nav3recipes/scenes/twopane)**: Shows how to create a custom layout using a `Scene` and `SceneStrategy` (see video of UI behavior below).
 - **[Animations](app/src/main/java/com/example/nav3recipes/animations)**: Override the default animations for all destinations and a single destination.
 
-**Common use cases**
+### Material adaptive layouts
+Examples showing how to use the layouts provided by the [Compose Material3 Adaptive Navigation3 library](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#compose_material3_adaptive_navigation3_version_10_2)
+- **[List-Detail](app/src/main/java/com/example/nav3recipes/material/listdetail)**: Shows how to use a Material adaptive list-detail layout.
+- **[Supporting Pane](app/src/main/java/com/example/nav3recipes/material/supportingpane)**: Shows how to use a Material adaptive supporting pane layout.
+
+### Common use cases
 - **[Common navigation UI](app/src/main/java/com/example/nav3recipes/commonui)**: A common navigation toolbar where each item in the toolbar navigates to a top level destination.
 - **[Conditional navigation](app/src/main/java/com/example/nav3recipes/conditional)**: Switch to a different navigation flow when a condition is met. For example, for authentication or first-time user onboarding.
 
-**Architecture**
+### Architecture
 - **[Modularized navigation code](app/src/main/java/com/example/nav3recipes/modular/hilt)**: Demonstrates how to decouple navigation code into separate modules (uses Dagger/Hilt for DI). 
 
-**Passing navigation arguments to ViewModels**
-- **[Basic ViewModel](app/src/main/java/com/example/nav3recipes/passingarguments/basicviewmodels)**: Navigation arguments are passed to a ViewModel constructed using `viewModel()`
-- **[Hilt injected ViewModel](app/src/main/java/com/example/nav3recipes/passingarguments/injectedviewmodels)**: Navigation arguments are passed to a ViewModel constructed using `hiltViewModel()`
+### Passing navigation arguments to ViewModels
+- **[Basic ViewModel](app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/basic)**: Navigation arguments are passed to a ViewModel constructed using `viewModel()`
+- **[Hilt injected ViewModel](app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/hilt)**: Navigation arguments are passed to a ViewModel constructed using `hiltViewModel()`
+- **[Koin injected ViewModel](app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/koin)**: Navigation arguments are passed to a ViewModel constructed using `koinViewModel()`
 
-**Planned**
+### Planned
 - **Deeplinks**: Create and handle deeplinks to specific destinations
 - **Android XR**: Custom navigation and layout behavior for Android XR
 - **Returning a result from a destination**: Return a result to a previous destination

app/build.gradle.kts

@@ -80,9 +80,11 @@ dependencies {
     implementation(libs.androidx.hilt.navigation.compose)
     implementation(libs.androidx.lifecycle.viewmodel.navigation3)
     implementation(libs.androidx.material.icons.extended)
+    implementation(libs.androidx.navigation2)
 
     implementation(libs.hilt.android)
     ksp(libs.hilt.compiler)
+    implementation(libs.koin.compose.viewmodel)
 
     testImplementation(libs.junit)
     androidTestImplementation(libs.androidx.junit)
@@ -91,4 +93,5 @@ dependencies {
     androidTestImplementation(libs.androidx.ui.test.junit4)
     debugImplementation(libs.androidx.ui.tooling)
     debugImplementation(libs.androidx.ui.test.manifest)
+    testImplementation(kotlin("test"))
 }

app/src/androidTest/java/com/example/nav3recipes/MigrationActivityNavigationTest.kt

@@ -0,0 +1,177 @@
+package com.example.nav3recipes
+
+import androidx.activity.ComponentActivity
+import androidx.compose.ui.test.assertIsSelected
+import androidx.compose.ui.test.hasText
+import androidx.compose.ui.test.isSelectable
+import androidx.compose.ui.test.junit4.createAndroidComposeRule
+import androidx.compose.ui.test.onNodeWithText
+import androidx.compose.ui.test.performClick
+import androidx.test.espresso.Espresso
+import com.example.nav3recipes.migration.start.StartMigrationActivity
+import com.example.nav3recipes.migration.step2.Step2MigrationActivity
+import com.example.nav3recipes.migration.step3.Step3MigrationActivity
+import com.example.nav3recipes.migration.step4.Step4MigrationActivity
+import com.example.nav3recipes.migration.step5.Step5MigrationActivity
+import com.example.nav3recipes.migration.step6.Step6MigrationActivity
+import com.example.nav3recipes.migration.step7.Step7MigrationActivity
+import org.junit.Rule
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.junit.runners.Parameterized
+import org.junit.runners.Parameterized.Parameters
+
+/**
+ * Instrumented navigation tests for each of the migration steps.
+ */
+@RunWith(Parameterized::class)
+class MigrationActivityNavigationTest(activityClass: Class<out ComponentActivity>) {
+
+    @get:Rule(order = 0)
+    val composeTestRule = createAndroidComposeRule(activityClass)
+
+    companion object {
+        @JvmStatic
+        @Parameters(name = "{0}")
+        fun data(): Collection<Array<Any>> {
+            return listOf(
+                arrayOf(StartMigrationActivity::class.java),
+                arrayOf(Step2MigrationActivity::class.java),
+                arrayOf(Step3MigrationActivity::class.java),
+                arrayOf(Step4MigrationActivity::class.java),
+                arrayOf(Step5MigrationActivity::class.java),
+                arrayOf(Step6MigrationActivity::class.java),
+                arrayOf(Step7MigrationActivity::class.java)
+            )
+        }
+    }
+
+    @Test
+    fun firstScreen_isA() {
+        composeTestRule.apply {
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route A title").assertExists()
+        }
+    }
+
+    @Test
+    fun navigateToB_selectsB() {
+        composeTestRule.apply {
+            onNode(hasText("Route B") and isSelectable()).performClick()
+            onNode(hasText("Route B") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route B title").assertExists()
+        }
+    }
+
+    @Test
+    fun navigateToA1_keepsASelected() {
+        composeTestRule.apply {
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route A title").assertExists()
+            onNodeWithText("Go to A1").performClick()
+            onNodeWithText("Route A1 title").assertExists()
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+        }
+    }
+
+    @Test
+    fun navigateAtoBtoC_selectsCAndShowsContent() {
+        composeTestRule.apply {
+            onNode(hasText("Route B") and isSelectable()).performClick()
+            onNode(hasText("Route B") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route B title").assertExists()
+
+            onNode(hasText("Route C") and isSelectable()).performClick()
+            onNode(hasText("Route C") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route C title").assertExists()
+        }
+    }
+
+    @Test
+    fun navigateAtoB_pressBack_showsA() {
+        composeTestRule.apply {
+            onNode(hasText("Route B") and isSelectable()).performClick()
+            onNode(hasText("Route B") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route B title").assertExists()
+
+            Espresso.pressBack()
+
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route A title").assertExists()
+        }
+    }
+
+    @Test
+    fun navigateAtoA1_pressBack_showsAContent() {
+        composeTestRule.apply {
+            onNodeWithText("Go to A1").performClick()
+            onNodeWithText("Route A1 title").assertExists()
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+
+            Espresso.pressBack()
+
+            onNodeWithText("Route A title").assertExists()
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+        }
+    }
+
+    @Test
+    fun navigateAtoBtoC_thenBack_showsA() {
+        composeTestRule.apply {
+            onNode(hasText("Route B") and isSelectable()).performClick()
+            onNode(hasText("Route B") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route B title").assertExists()
+
+            onNode(hasText("Route C") and isSelectable()).performClick()
+            onNode(hasText("Route C") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route C title").assertExists()
+
+            Espresso.pressBack()
+
+            onNode(hasText("Route A") and isSelectable()).assertIsSelected()
+            onNodeWithText("Route A title").assertExists()
+            onNodeWithText("Route B title").assertDoesNotExist()
+        }
+    }
+
+    /**
+     * TODO: Investigate why these dialog tests sometimes fail.
+     */
+    @Test
+    fun navigateToDialogD_onA_showsDialogContentAndDismisses() {
+        composeTestRule.apply {
+
+            onNodeWithText("Open dialog D").performClick()
+            onNodeWithText("Route D title (dialog)").assertExists()
+            Espresso.pressBack()
+            onNodeWithText("Route A title").assertExists()
+        }
+    }
+
+    @Test
+    fun navigateToDialogD_onB_showsDialogContentAndDismisses() {
+        composeTestRule.apply {
+
+            onNode(hasText("Route B") and isSelectable()).performClick()
+
+            onNodeWithText("Open dialog D").performClick()
+            onNodeWithText("Route D title (dialog)").assertExists()
+            Espresso.pressBack()
+            onNodeWithText("Route B title").assertExists()
+        }
+    }
+
+
+    @Test
+    fun navigateToDialogD_onC_showsDialogContentAndDismisses() {
+        composeTestRule.apply {
+
+            onNode(hasText("Route C") and isSelectable()).performClick()
+
+            onNodeWithText("Open dialog D").performClick()
+            onNodeWithText("Route D title (dialog)").assertExists()
+            Espresso.pressBack()
+            onNodeWithText("Route C title").assertExists()
+        }
+    }
+}

app/src/main/AndroidManifest.xml

@@ -66,7 +66,15 @@
             android:exported="true"
             android:theme="@style/Theme.Nav3Recipes"/>
         <activity
-            android:name=".scenes.materiallistdetail.MaterialListDetailActivity"
+            android:name=".bottomsheet.BottomSheetActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".material.listdetail.MaterialListDetailActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".material.supportingpane.MaterialSupportingPaneActivity"
             android:exported="true"
             android:theme="@style/Theme.Nav3Recipes"/>
         <activity
@@ -82,18 +90,51 @@
             android:exported="true"
             android:theme="@style/Theme.Nav3Recipes"/>
         <activity
-            android:name=".passingarguments.basicviewmodels.BasicViewModelsActivity"
+            android:name=".passingarguments.viewmodels.basic.BasicViewModelsActivity"
             android:exported="true"
             android:theme="@style/Theme.Nav3Recipes"/>
         <activity
-            android:name=".passingarguments.injectedviewmodels.InjectedViewModelsActivity"
+            android:name=".passingarguments.viewmodels.hilt.HiltViewModelsActivity"
             android:exported="true"
             android:theme="@style/Theme.Nav3Recipes"/>
         <activity
             android:name=".modular.hilt.ModularActivity"
             android:exported="true"
             android:label="@string/app_name"
             android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".passingarguments.viewmodels.koin.KoinViewModelsActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.start.StartMigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step2.Step2MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step3.Step3MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step4.Step4MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step5.Step5MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step6.Step6MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
+        <activity
+            android:name=".migration.step7.Step7MigrationActivity"
+            android:exported="true"
+            android:theme="@style/Theme.Nav3Recipes"/>
     </application>
 
 </manifest>

app/src/main/java/com/example/nav3recipes/RecipePickerActivity.kt

@@ -29,13 +29,16 @@ import com.example.nav3recipes.animations.AnimatedActivity
 import com.example.nav3recipes.basic.BasicActivity
 import com.example.nav3recipes.basicdsl.BasicDslActivity
 import com.example.nav3recipes.basicsaveable.BasicSaveableActivity
+import com.example.nav3recipes.bottomsheet.BottomSheetActivity
 import com.example.nav3recipes.commonui.CommonUiActivity
 import com.example.nav3recipes.conditional.ConditionalActivity
 import com.example.nav3recipes.dialog.DialogActivity
 import com.example.nav3recipes.modular.hilt.ModularActivity
-import com.example.nav3recipes.passingarguments.basicviewmodels.BasicViewModelsActivity
-import com.example.nav3recipes.passingarguments.injectedviewmodels.InjectedViewModelsActivity
-import com.example.nav3recipes.scenes.materiallistdetail.MaterialListDetailActivity
+import com.example.nav3recipes.passingarguments.viewmodels.basic.BasicViewModelsActivity
+import com.example.nav3recipes.passingarguments.viewmodels.hilt.HiltViewModelsActivity
+import com.example.nav3recipes.passingarguments.viewmodels.koin.KoinViewModelsActivity
+import com.example.nav3recipes.material.listdetail.MaterialListDetailActivity
+import com.example.nav3recipes.material.supportingpane.MaterialSupportingPaneActivity
 import com.example.nav3recipes.scenes.twopane.TwoPaneActivity
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 
@@ -56,8 +59,11 @@ private val recipes = listOf(
     Recipe("Basic Saveable", BasicSaveableActivity::class.java),
 
     Heading("Layouts and animations"),
+    Recipe("Bottom Sheet", BottomSheetActivity::class.java),
     Recipe("Material list-detail layout", MaterialListDetailActivity::class.java),
+    Recipe("Material supporting-pane layout", MaterialSupportingPaneActivity::class.java),
     Recipe("Dialog", DialogActivity::class.java),
+    Recipe("Material list-detail layout", MaterialListDetailActivity::class.java),
     Recipe("Two pane layout (custom scene)", TwoPaneActivity::class.java),
     Recipe("Animations", AnimatedActivity::class.java),
 
@@ -68,9 +74,10 @@ private val recipes = listOf(
     Heading("Architecture"),
     Recipe("Modular Navigation", ModularActivity::class.java),
 
-    Heading("Passing navigation arguments"),
-    Recipe("Argument passing to basic ViewModel", BasicViewModelsActivity::class.java),
-    Recipe("Argument passing to injected ViewModel", InjectedViewModelsActivity::class.java),
+    Heading("Passing navigation arguments using ViewModels"),
+    Recipe("Basic", BasicViewModelsActivity::class.java),
+    Recipe("Using Hilt", HiltViewModelsActivity::class.java),
+    Recipe("Using Koin", KoinViewModelsActivity::class.java),
 )
 
 class RecipePickerActivity : ComponentActivity() {