使用 Compose for Wear OS 进行导航


Android Jetpack 中的导航组件支持 Jetpack Compose 应用。您可以在可组合项之间自由导航,同时充分利用导航组件的底层基础设施与丰富功能。

本页介绍了与 Compose for Wear OS 上的 Jetpack Navigation 之间的差异。

设置

在应用模块的 build.gradle 文件中使用以下依赖项:

Kotlin

dependencies {
    def wear_compose_version = "1.7.2"
    implementation "androidx.wear.compose:compose-navigation:$wear_compose_version"
}

这用于替代 androidx.navigation:navigation-compose 工件,因为它提供了特定于 Wear OS 的替代实现。

创建导航控制器、导航主机和导航图

使用 Compose for Wear OS 进行导航需要的三个组件与非 Wear OS 应用相同:导航控制器、导航主机和导航图。

使用 rememberSwipeDismissableNavController() 创建一个 WearNavigator 实例,它是适用于 Wear OS 应用的 NavController 实现:

val navController = rememberSwipeDismissableNavController()

NavController 是用于在 Compose 应用中进行导航的主要 API。它用于控制导航宿主(在 Wear OS 中为 SwipeDismissableNavHost)中的可组合项之间的导航。

val navController = rememberSwipeDismissableNavController()
SwipeDismissableNavHost(
    navController = navController,
    startDestination = "message_list"
) {
    // TODO: build navigation graph
}

与 NavHost 可组合项类似,它接收一个导航控制器引用、起始目标路由以及导航图构建器(此处以尾随 lambda 形式呈现)。

在导航图构建器中,必须指定起始目标,同时配置所有可通过导航控制器访问的其他目标页面。

在 Wear OS 应用中,将 SwipeDismissableNavHost 声明为 AppScaffold 的内容,以支持时间、滚动或位置指示器和页面指示器等顶级组件。 在 SwipeDismissableNavHost 上方使用 AppScaffold 对象,并在屏幕层级配置 ScreenScaffold,这样可默认在屏幕中添加 TimeText 对象,确保屏幕切换时的动画效果流畅自然。 此外,ScreenScaffold 还会为可滚动内容添加 PositionIndicator。
    AppScaffold {
        val navController = rememberSwipeDismissableNavController()
        SwipeDismissableNavHost(
            navController = navController,
            startDestination = "message_list"
        ) {
            composable("message_list") {
                MessageList(onMessageClick = { id ->
                    navController.navigate("message_detail/$id")
                })
            }
            composable("message_detail/{id}") {
                MessageDetail(id = it.arguments?.getString("id")!!)
            }
        }
    }
}

// Implementation of one of the screens in the navigation
@Composable
fun MessageDetail(id: String) {
    // .. Screen level content goes here
    val scrollState = rememberTransformingLazyColumnState()
    val transformationSpec = rememberTransformationSpec()

    ScreenScaffold(
        scrollState = scrollState,
    ) { contentPadding ->
        // Screen content goes here
        // ...

显示对话框

如需在 Wear OS 上使用 Compose Material 3 显示对话框(例如 AlertDialog、ConfirmationDialog、OpenOnPhoneDialog 或 Dialog),请直接在打开该对话框的可组合项目的地中声明该对话框可组合项。为此,请完成以下步骤:

  1. 使用布尔值状态变量控制对话框的可见性,并将该状态传递给对话框的 visible 参数。使用 rememberSaveable 或提升到 ViewModel 的状态。
  2. 在 onDismissRequest 回调以及任何其他确认或关闭操作回调中,将状态变量设置为 false。这样,当用户滑动关闭对话框或选择操作时,对话框就会以动画形式退出并返回到底层屏幕。

如需了解详情,请参阅 AlertDialog、ConfirmationDialog 和 OpenOnPhoneDialog API 参考文档。

如需详细了解 Jetpack Navigation,请参阅使用 Compose 进行导航或完成 Jetpack Compose Navigation Codelab。