สูตรการตกแต่งฉากกล่องโต้ตอบ
สูตรนี้แสดงให้เห็นถึงแนวทางหนึ่งในการแสดงฉากภายในกล่องโต้ตอบ เช่น อาจใช้เพื่อแสดง UI การตั้งค่าแบบรายละเอียดรายการเป็นภาพซ้อนทับเมื่อแอปอยู่ในหน้าต่างแบบขยาย แต่เป็นหน้าจอแบบเต็มในกรณีอื่นๆ
วิธีการทำงาน
หากต้องการแสดงฉากภายในกล่องโต้ตอบ คุณต้องทำดังนี้
- สร้างกล่องโต้ตอบ
SceneDecorationStrategy: สูตรนี้กำหนดDialogSceneDecoratorStrategyรวมถึงDialogDecoratorSceneที่ใช้เพื่อแสดงอินพุตSceneภายในกล่องโต้ตอบ เมื่อกำหนดกลยุทธ์การตกแต่งฉากในกล่องโต้ตอบ ให้พิจารณาสิ่งต่อไปนี้- เมื่อใดที่ฉากจะแสดงในกล่องโต้ตอบได้ ในสูตรนี้ ระบบจะแสดงฉากในกล่องโต้ตอบก็ต่อเมื่อขยายความกว้างของหน้าต่างแล้วเท่านั้น
- ข้อมูลเมตาใดที่ควรระบุว่าฉากจะแสดงในกล่องโต้ตอบได้หรือไม่ ในสูตรนี้ ระบบจะแสดงฉากในกล่องโต้ตอบหากรายการแรกภายในฉากนั้นมีข้อมูลเมตา
DialogSceneMetadataKeyอีกวิธีหนึ่งที่อาจเหมาะสมกว่าคือการกำหนดให้รายการทั้งหมดภายในฉากมีข้อมูลเมตาเดียวกัน ทั้งนี้ขึ้นอยู่กับ Use Case ของคุณ - ลักษณะการปิดกล่องโต้ตอบเป็นอย่างไร ในสูตรนี้ การคลิกนอกกล่องโต้ตอบจะนำรายการทั้งหมดในฉากออก ในขณะที่ท่าทางสัมผัสย้อนกลับหรือการกดจะนำออกทีละรายการเท่านั้น สูตรนี้จะให้การกำหนดค่าสำหรับลักษณะการทำงานนี้ผ่านคลาส
DialogDecoratorSceneConfiguration
- ใช้กล่องโต้ตอบ
SceneDecorationStrategy: หากต้องการใช้กลยุทธ์การตกแต่งฉาก ให้ส่งไปยังNavDisplayเป็นส่วนหนึ่งของพารามิเตอร์sceneDecoratorStrategies- ข้อควรระวัง: เนื่องจาก
NavDisplayไม่ได้ตกแต่งอินสแตนซ์OverlaySceneคุณอาจต้องพิจารณาตำแหน่งของกลยุทธ์การตกแต่งฉากกล่องโต้ตอบภายในรายการsceneDecoratorStrategiesการตกแต่งฉากด้วยองค์ประกอบนี้จะป้องกันการตกแต่งโดยใช้กลยุทธ์การตกแต่งฉาก - ข้อควรระวัง: เมื่อใช้
onDismissAllโดยใช้contentKeyเพื่อระบุรายการที่จะปิด โปรดทราบว่าโดยค่าเริ่มต้นcontentKeyจะใช้key.toString()ในสูตรนี้ เราใช้backStack.removeAll { it.toString() in contentKeys }ซึ่งใช้ได้กับคีย์ออบเจ็กต์แบบง่าย แต่คุณอาจต้องปรับคีย์ที่ซับซ้อนกว่าหรือการติดตั้งใช้งานcontentKeyที่กำหนดเอง
- ข้อควรระวัง: เนื่องจาก
package com.example.nav3recipes.dialogscenedecorator import android.os.Bundle import androidx.activity.ComponentActivity import androidx.activity.compose.setContent import androidx.compose.animation.SharedTransitionLayout import androidx.compose.material3.Button import androidx.compose.material3.Text import androidx.lifecycle.compose.dropUnlessResumed import androidx.navigation3.runtime.NavKey import androidx.navigation3.runtime.entryProvider import androidx.navigation3.runtime.rememberNavBackStack import androidx.navigation3.ui.NavDisplay import com.example.nav3recipes.content.ContentBlue import com.example.nav3recipes.content.ContentGreen import com.example.nav3recipes.content.ContentYellow import com.example.nav3recipes.scenes.listdetail.ListDetailScene import com.example.nav3recipes.scenes.listdetail.rememberListDetailSceneStrategy import com.example.nav3recipes.ui.setEdgeToEdgeConfig import kotlinx.serialization.Serializable @Serializable private data object Main : NavKey @Serializable private data object SettingsList : NavKey @Serializable private data object SettingsDetail : NavKey class DialogSceneDecoratorActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setEdgeToEdgeConfig() setContent { val backStack = rememberNavBackStack(Main) val listDetailSceneStrategy = rememberListDetailSceneStrategy<NavKey>() val dialogSceneDecoratorStrategy = rememberDialogSceneDecoratorStrategy<NavKey>( onDismissAll = { entriesToDismiss -> // Caution: This relies on the default behavior of NavEntry using key.toString() // to define its contentKey property. entriesToDismiss.forEach { entry -> backStack .indexOfLast { it.toString() == entry.contentKey } .takeIf { it >= 0 } ?.let { backStack.removeAt(it) } } } ) SharedTransitionLayout { NavDisplay( backStack = backStack, onBack = { backStack.removeLastOrNull() }, sceneStrategies = listOf(listDetailSceneStrategy), sceneDecoratorStrategies = listOf(dialogSceneDecoratorStrategy), sharedTransitionScope = this, entryProvider = entryProvider { entry<Main> { ContentGreen("Welcome to Nav3") { Button(onClick = dropUnlessResumed { backStack.add(SettingsList) }) { Text("Click to open settings") } } } entry<SettingsList>( metadata = DialogSceneDecoratorStrategy.sceneDialog( DialogDecoratorSceneConfiguration( backDismissalBehavior = DismissalBehavior.Single ) ) + ListDetailScene.listPane() ) { ContentBlue( title = "Settings List", ) { Button(onClick = dropUnlessResumed { if (backStack.last() !is SettingsDetail) { backStack.add(SettingsDetail) } }) { Text("Open detail") } } } entry<SettingsDetail>( metadata = ListDetailScene.detailPane() ) { ContentYellow("Settings Detail") } } ) } } } }
package com.example.nav3recipes.dialogscenedecorator import androidx.activity.compose.BackHandler import androidx.compose.foundation.shape.RoundedCornerShape import androidx.compose.material3.Surface import androidx.compose.material3.adaptive.currentWindowAdaptiveInfoV2 import androidx.compose.runtime.Composable import androidx.compose.runtime.remember import androidx.compose.ui.graphics.Shape import androidx.compose.ui.unit.dp import androidx.compose.ui.window.Dialog import androidx.compose.ui.window.DialogProperties import androidx.compose.ui.window.SecureFlagPolicy import androidx.navigation3.runtime.NavEntry import androidx.navigation3.runtime.NavMetadataKey import androidx.navigation3.runtime.get import androidx.navigation3.runtime.metadata import androidx.navigation3.scene.OverlayScene import androidx.navigation3.scene.Scene import androidx.navigation3.scene.SceneDecoratorStrategy import androidx.navigation3.scene.SceneDecoratorStrategyScope import androidx.window.core.layout.WindowSizeClass fun DialogProperties.copy( dismissOnBackPress: Boolean = this.dismissOnBackPress, dismissOnClickOutside: Boolean = this.dismissOnClickOutside, securePolicy: SecureFlagPolicy = this.securePolicy, usePlatformDefaultWidth: Boolean = this.usePlatformDefaultWidth, decorFitsSystemWindows: Boolean = this.decorFitsSystemWindows, windowTitle: String = this.windowTitle ): DialogProperties = DialogProperties( dismissOnBackPress = dismissOnBackPress, dismissOnClickOutside = dismissOnClickOutside, securePolicy = securePolicy, usePlatformDefaultWidth = usePlatformDefaultWidth, decorFitsSystemWindows = decorFitsSystemWindows, windowTitle = windowTitle ) enum class DismissalBehavior { All, Single } /** * Configuration for the [DialogDecoratorScene]. * * @property dialogProperties The [DialogProperties] used to configure the dialog. * @property backDismissalBehavior Whether all entries in the scene should be dismissed when the * back button is pressed. This configuration only applies if the * [DialogProperties.dismissOnBackPress] is set to `true`. * */ class DialogDecoratorSceneConfiguration( val dialogProperties: DialogProperties = DialogProperties(), val backDismissalBehavior: DismissalBehavior = DismissalBehavior.Single, val shape: Shape = RoundedCornerShape(16.dp), ) { fun toDialogProperties(): DialogProperties { // If the desired behavior is to not dismiss all, the DialogProperties passed to the Dialog // needs to be configured to not handle the back press itself. if (dialogProperties.dismissOnBackPress && backDismissalBehavior != DismissalBehavior.All) { return dialogProperties.copy(dismissOnBackPress = false) } return dialogProperties } fun shouldDismissSingleOnBackPress() = dialogProperties.dismissOnBackPress && backDismissalBehavior == DismissalBehavior.Single override fun equals(other: Any?): Boolean { if (this === other) return true if (other == null || this::class != other::class) return false other as DialogDecoratorSceneConfiguration return dialogProperties == other.dialogProperties && backDismissalBehavior == other.backDismissalBehavior && shape == other.shape } override fun hashCode(): Int { return dialogProperties.hashCode() * 31 + backDismissalBehavior.hashCode() * 31 + shape.hashCode() * 31 } } /** * [DialogDecoratorScene] is an [OverlayScene] used by [DialogSceneDecoratorStrategy] to present * another [Scene] within a [Dialog]. * * @property scene The [Scene] to be displayed within the dialog. * @property overlaidEntries The [NavEntry]s that are overlaid by the dialog. * @property dialogDecoratorSceneConfiguration The [DialogDecoratorSceneConfiguration] used to * configure the dialog scene. * @property onBack The callback to be invoked when a back event should be handled * @property onDismissAll The callback to be invoked when the entire dialog stack should be dismissed **/ data class DialogDecoratorScene<T : Any>( private val scene: Scene<T>, override val overlaidEntries: List<NavEntry<T>>, private val dialogDecoratorSceneConfiguration: DialogDecoratorSceneConfiguration, private val onBack: () -> Unit, private val onDismissAll: () -> Unit ) : OverlayScene<T>, Scene<T> by scene { override val content: @Composable () -> Unit = { Dialog( onDismissRequest = onDismissAll, properties = dialogDecoratorSceneConfiguration.toDialogProperties() ) { Surface( shape = dialogDecoratorSceneConfiguration.shape ) { scene.content() } // Because back events are dispatched to the currently focused window, this back handler // must be contained within the dialog's content to receive the events. BackHandler(dialogDecoratorSceneConfiguration.shouldDismissSingleOnBackPress()) { onBack() } } } } @Composable fun <T : Any> rememberDialogSceneDecoratorStrategy( windowSizeClass: WindowSizeClass = currentWindowAdaptiveInfoV2().windowSizeClass, onDismissAll: ((List<NavEntry<T>>) -> Unit) ): DialogSceneDecoratorStrategy<T> = remember(windowSizeClass, onDismissAll) { DialogSceneDecoratorStrategy(windowSizeClass, onDismissAll = onDismissAll) } /** * A [SceneDecoratorStrategy] that wraps a [Scene] in a [DialogDecoratorScene] if the first * [NavEntry] within it has been marked with the [DialogSceneMetadataKey] and the window width * is at least [WindowSizeClass.WIDTH_DP_EXPANDED_LOWER_BOUND]. * * If you only need to display a single [NavEntry] in a [Dialog], using * [androidx.navigation3.scene.DialogSceneStrategy] instead may be preferable. * * @property windowSizeClass The current [WindowSizeClass] used to determine if dialogs should be used. * @property windowWidthDpBreakpoint the width in dp at or above which a dialog should be displayed. * @property onDismissAll callback invoked to dismiss all dialog entries, receives the entries that * are currently in the dialog. */ class DialogSceneDecoratorStrategy<T : Any>( private val windowSizeClass: WindowSizeClass, private val windowWidthDpBreakpoint: Int = WindowSizeClass.WIDTH_DP_EXPANDED_LOWER_BOUND, private val onDismissAll: (List<NavEntry<T>>) -> Unit ) : SceneDecoratorStrategy<T> { override fun SceneDecoratorStrategyScope<T>.decorateScene(scene: Scene<T>): Scene<T> { if (!windowSizeClass.isWidthAtLeastBreakpoint(windowWidthDpBreakpoint)) return scene val dialogDecoratorSceneConfiguration = scene.entries.firstOrNull()?.metadata[DialogSceneMetadataKey] ?: return scene // This is critical to ensure that the scenes rendered beneath the dialog don't contain // any entries that are in the dialog. val overlaidEntries = scene.previousEntries.dropLastWhile { it in scene.entries } return DialogDecoratorScene( scene, overlaidEntries, dialogDecoratorSceneConfiguration, onBack, onDismissAll = { onDismissAll.invoke(scene.entries) }) } companion object { object DialogSceneMetadataKey : NavMetadataKey<DialogDecoratorSceneConfiguration> fun sceneDialog(dialogDecoratorSceneConfiguration: DialogDecoratorSceneConfiguration = DialogDecoratorSceneConfiguration()): Map<String, Any> = metadata { put(DialogSceneMetadataKey, dialogDecoratorSceneConfiguration) } } }