update adaptive samples to navigable scaffolds

.github/workflows/apply_spotless.yml

@@ -44,10 +44,13 @@ jobs:
     - name: Run spotlessApply
       run: ./gradlew :compose:spotlessApply --init-script gradle/init.gradle.kts --no-configuration-cache --stacktrace
 
+    - name: Run spotlessApply for Wear
+      run: ./gradlew :wear:spotlessApply --init-script gradle/init.gradle.kts --no-configuration-cache --stacktrace
+
+    - name: Run spotlessApply for Misc
+      run: ./gradlew :misc:spotlessApply --init-script gradle/init.gradle.kts --no-configuration-cache --stacktrace
+
     - name: Auto-commit if spotlessApply has changes
       uses: stefanzweifel/git-auto-commit-action@v5
       with:
-        commit_message: Apply Spotless
-
-    - name: Run spotlessApply for Wear
-      run: ./gradlew :wear:spotlessApply --init-script gradle/init.gradle.kts --no-configuration-cache --stacktrace
+        commit_message: Apply Spotless

.github/workflows/build.yml

@@ -45,3 +45,5 @@ jobs:
       run: ./gradlew :kotlin:build
     - name: Build Wear snippets
       run: ./gradlew :wear:build
+    - name: Build misc snippets
+      run: ./gradlew :misc:build

compose/snippets/src/main/AndroidManifest.xml

@@ -27,6 +27,7 @@
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
+        android:enableOnBackInvokedCallback="true"
         android:theme="@style/Theme.Snippets">
 <!--    [START android_compose_pip_manifest_entry]-->
         <activity

compose/snippets/src/main/java/com/example/compose/snippets/SnippetsActivity.kt

@@ -16,6 +16,7 @@
 
 package com.example.compose.snippets
 
+import NavigationDrawerExamples
 import android.os.Bundle
 import android.os.StrictMode
 import androidx.activity.ComponentActivity
@@ -33,24 +34,31 @@ import com.example.compose.snippets.components.AppBarExamples
 import com.example.compose.snippets.components.BadgeExamples
 import com.example.compose.snippets.components.ButtonExamples
 import com.example.compose.snippets.components.CardExamples
+import com.example.compose.snippets.components.CarouselExamples
 import com.example.compose.snippets.components.CheckboxExamples
 import com.example.compose.snippets.components.ChipExamples
 import com.example.compose.snippets.components.ComponentsScreen
 import com.example.compose.snippets.components.DatePickerExamples
 import com.example.compose.snippets.components.DialogExamples
 import com.example.compose.snippets.components.DividerExamples
 import com.example.compose.snippets.components.FloatingActionButtonExamples
+import com.example.compose.snippets.components.MenusExamples
 import com.example.compose.snippets.components.PartialBottomSheet
 import com.example.compose.snippets.components.ProgressIndicatorExamples
 import com.example.compose.snippets.components.ScaffoldExample
+import com.example.compose.snippets.components.SearchBarExamples
+import com.example.compose.snippets.components.SegmentedButtonExamples
 import com.example.compose.snippets.components.SliderExamples
+import com.example.compose.snippets.components.SwipeToDismissBoxExamples
 import com.example.compose.snippets.components.SwitchExamples
 import com.example.compose.snippets.components.TimePickerExamples
+import com.example.compose.snippets.components.TooltipExamples
 import com.example.compose.snippets.graphics.ApplyPolygonAsClipImage
 import com.example.compose.snippets.graphics.BitmapFromComposableFullSnippet
 import com.example.compose.snippets.graphics.BrushExamplesScreen
 import com.example.compose.snippets.images.ImageExamplesScreen
 import com.example.compose.snippets.landing.LandingScreen
+import com.example.compose.snippets.layouts.PagerExamples
 import com.example.compose.snippets.navigation.Destination
 import com.example.compose.snippets.navigation.TopComponentsDestination
 import com.example.compose.snippets.ui.theme.SnippetsTheme
@@ -85,6 +93,7 @@ class SnippetsActivity : ComponentActivity() {
                                     }
                                     Destination.ShapesExamples -> ApplyPolygonAsClipImage()
                                     Destination.SharedElementExamples -> PlaceholderSizeAnimated_Demo()
+                                    Destination.PagerExamples -> PagerExamples()
                                 }
                             }
                         }
@@ -109,6 +118,13 @@ class SnippetsActivity : ComponentActivity() {
                                     TopComponentsDestination.PartialBottomSheet -> PartialBottomSheet()
                                     TopComponentsDestination.TimePickerExamples -> TimePickerExamples()
                                     TopComponentsDestination.DatePickerExamples -> DatePickerExamples()
+                                    TopComponentsDestination.CarouselExamples -> CarouselExamples()
+                                    TopComponentsDestination.MenusExample -> MenusExamples()
+                                    TopComponentsDestination.TooltipExamples -> TooltipExamples()
+                                    TopComponentsDestination.NavigationDrawerExamples -> NavigationDrawerExamples()
+                                    TopComponentsDestination.SegmentedButtonExamples -> SegmentedButtonExamples()
+                                    TopComponentsDestination.SwipeToDismissBoxExamples -> SwipeToDismissBoxExamples()
+                                    TopComponentsDestination.SearchBarExamples -> SearchBarExamples()
                                 }
                             }
                         }

compose/snippets/src/main/java/com/example/compose/snippets/adaptivelayouts/SampleListDetailPaneScaffold.kt

@@ -17,7 +17,6 @@
 package com.example.compose.snippets.adaptivelayouts
 
 import android.os.Parcelable
-import androidx.activity.compose.BackHandler
 import androidx.compose.foundation.background
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.Column
@@ -30,33 +29,38 @@ import androidx.compose.material3.Card
 import androidx.compose.material3.ListItem
 import androidx.compose.material3.Text
 import androidx.compose.material3.adaptive.ExperimentalMaterial3AdaptiveApi
+import androidx.compose.material3.adaptive.WindowAdaptiveInfo
+import androidx.compose.material3.adaptive.currentWindowAdaptiveInfo
 import androidx.compose.material3.adaptive.layout.AnimatedPane
 import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffold
 import androidx.compose.material3.adaptive.layout.ListDetailPaneScaffoldRole
+import androidx.compose.material3.adaptive.layout.PaneScaffoldDirective
+import androidx.compose.material3.adaptive.navigation.BackNavigationBehavior
+import androidx.compose.material3.adaptive.navigation.NavigableListDetailPaneScaffold
+import androidx.compose.material3.adaptive.navigation.ThreePaneScaffoldPredictiveBackHandler
 import androidx.compose.material3.adaptive.navigation.rememberListDetailPaneScaffoldNavigator
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.rememberCoroutineScope
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import androidx.compose.ui.unit.sp
+import androidx.window.core.layout.WindowWidthSizeClass
+import kotlinx.coroutines.launch
 import kotlinx.parcelize.Parcelize
 
 @OptIn(ExperimentalMaterial3AdaptiveApi::class)
 @Composable
-fun SampleListDetailPaneScaffoldParts() {
+fun SampleNavigableListDetailPaneScaffoldParts() {
     // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part02]
-    val navigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
-
-    BackHandler(navigator.canNavigateBack()) {
-        navigator.navigateBack()
-    }
+    val scaffoldNavigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
+    val scope = rememberCoroutineScope()
     // [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part02]
 
     // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part03]
-    ListDetailPaneScaffold(
-        directive = navigator.scaffoldDirective,
-        value = navigator.scaffoldValue,
+    NavigableListDetailPaneScaffold(
+        navigator = scaffoldNavigator,
         // [START_EXCLUDE]
         listPane = {},
         detailPane = {},
@@ -65,16 +69,21 @@ fun SampleListDetailPaneScaffoldParts() {
     // [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part03]
 
     // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part04]
-    ListDetailPaneScaffold(
-        directive = navigator.scaffoldDirective,
-        value = navigator.scaffoldValue,
+    NavigableListDetailPaneScaffold(
+        navigator = scaffoldNavigator,
         listPane = {
             AnimatedPane {
                 MyList(
                     onItemClick = { item ->
                         // Navigate to the detail pane with the passed item
-                        navigator.navigateTo(ListDetailPaneScaffoldRole.Detail, item)
-                    }
+                        scope.launch {
+                            scaffoldNavigator
+                                .navigateTo(
+                                    ListDetailPaneScaffoldRole.Detail,
+                                    item
+                                )
+                        }
+                    },
                 )
             }
         },
@@ -85,16 +94,14 @@ fun SampleListDetailPaneScaffoldParts() {
     // [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part04]
 
     // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_part05]
-    ListDetailPaneScaffold(
-        directive = navigator.scaffoldDirective,
-        value = navigator.scaffoldValue,
-        listPane =
+    NavigableListDetailPaneScaffold(
+        navigator = scaffoldNavigator,
         // [START_EXCLUDE]
-        {},
+        listPane = {},
         // [END_EXCLUDE]
         detailPane = {
             AnimatedPane {
-                navigator.currentDestination?.content?.let {
+                scaffoldNavigator.currentDestination?.contentKey?.let {
                     MyDetails(it)
                 }
             }
@@ -106,39 +113,100 @@ fun SampleListDetailPaneScaffoldParts() {
 @OptIn(ExperimentalMaterial3AdaptiveApi::class)
 @Preview
 @Composable
-fun SampleListDetailPaneScaffoldFull() {
-// [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_full]
-    val navigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
+fun SampleNavigableListDetailPaneScaffoldFull() {
+    // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_full]
+    val scaffoldNavigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
+    val scope = rememberCoroutineScope()
 
-    BackHandler(navigator.canNavigateBack()) {
-        navigator.navigateBack()
-    }
+    NavigableListDetailPaneScaffold(
+        navigator = scaffoldNavigator,
+        listPane = {
+            AnimatedPane {
+                MyList(
+                    onItemClick = { item ->
+                        // Navigate to the detail pane with the passed item
+                        scope.launch {
+                            scaffoldNavigator.navigateTo(
+                                ListDetailPaneScaffoldRole.Detail,
+                                item
+                            )
+                        }
+                    },
+                )
+            }
+        },
+        detailPane = {
+            AnimatedPane {
+                // Show the detail pane content if selected item is available
+                scaffoldNavigator.currentDestination?.contentKey?.let {
+                    MyDetails(it)
+                }
+            }
+        },
+    )
+    // [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_full]
+}
+
+@OptIn(ExperimentalMaterial3AdaptiveApi::class)
+@Composable
+fun SampleListDetailPaneScaffoldWithPredictiveBackFull() {
+    // [START android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_with_pb_full]
+    val scaffoldNavigator = rememberListDetailPaneScaffoldNavigator<MyItem>()
+    val customScaffoldDirective = customPaneScaffoldDirective(currentWindowAdaptiveInfo())
+    val scope = rememberCoroutineScope()
+
+    ThreePaneScaffoldPredictiveBackHandler(
+        navigator = scaffoldNavigator,
+        backBehavior = BackNavigationBehavior.PopUntilContentChange
+    )
 
     ListDetailPaneScaffold(
-        directive = navigator.scaffoldDirective,
-        value = navigator.scaffoldValue,
+        directive = customScaffoldDirective,
+        scaffoldState = scaffoldNavigator.scaffoldState,
         listPane = {
             AnimatedPane {
                 MyList(
                     onItemClick = { item ->
                         // Navigate to the detail pane with the passed item
-                        navigator.navigateTo(ListDetailPaneScaffoldRole.Detail, item)
+                        scope.launch {
+                            scaffoldNavigator.navigateTo(
+                                ListDetailPaneScaffoldRole.Detail,
+                                item
+                            )
+                        }
                     },
                 )
             }
         },
         detailPane = {
             AnimatedPane {
                 // Show the detail pane content if selected item is available
-                navigator.currentDestination?.content?.let {
+                scaffoldNavigator.currentDestination?.contentKey?.let {
                     MyDetails(it)
                 }
             }
         },
     )
-// [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_full]
 }
 
+fun customPaneScaffoldDirective(currentWindowAdaptiveInfo: WindowAdaptiveInfo): PaneScaffoldDirective {
+    val horizontalPartitions =
+        when (currentWindowAdaptiveInfo.windowSizeClass.windowWidthSizeClass) {
+            WindowWidthSizeClass.COMPACT -> 1
+            WindowWidthSizeClass.MEDIUM -> 2
+            else -> 3
+        }
+
+    return PaneScaffoldDirective(
+        maxHorizontalPartitions = horizontalPartitions,
+        horizontalPartitionSpacerSize = 16.dp,
+        maxVerticalPartitions = 1,
+        verticalPartitionSpacerSize = 8.dp,
+        defaultPanePreferredWidth = 320.dp,
+        excludedBounds = emptyList()
+    )
+}
+// [END android_compose_adaptivelayouts_sample_list_detail_pane_scaffold_with_pb_full]
 @Composable
 fun MyList(
     onItemClick: (MyItem) -> Unit,