NavDestination

作为子页面的根容器，用于显示Navigation的内容区。

说明：

该组件从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

该组件从API Version 11开始默认支持安全区避让特性(默认值为：expandSafeArea([SafeAreaType.SYSTEM], [SafeAreaEdge.TOP, SafeAreaEdge.BOTTOM]))，开发者可以重写该属性覆盖默认行为，API Version 11之前的版本需配合expandSafeArea属性实现安全区避让。

NavDestination组件必须配合Navigation使用，作为Navigation目的页面的根节点。

子组件

说明：

  • 子组件类型：系统组件和自定义组件，支持渲染控制类型（if/else、ForEach和LazyForEach）。
  • 子组件个数：多个。

接口

NavDestination()

属性

仅支持backgroundColor通用属性。

名称 参数类型 描述
title string | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle 页面标题。
说明：
使用NavigationCustomTitle类型设置height高度时，titleMode属性不会生效。
字符串超长时，如果不设置副标题，先缩小再换行2行后以...截断。如果设置副标题，先缩小后以...截断。
hideTitleBar boolean 是否隐藏标题栏。
默认值：false
true: 隐藏标题栏。
false: 显示标题栏。
mode 11+ NavDestinationMode NavDestination类型。
默认值: NavDestinationMode.STANDARD
backButtonIcon11+ ResourceStr | PixelMap 设置标题栏返回键图标。
名称 描述
STANDARD 标准模式的NavDestination。
DIALOG 默认透明，进出页面栈不影响下层NavDestination的生命周期，不支持系统转场动画。

事件

除支持通用事件外，还支持如下事件：

名称 功能描述
onShown(callback: () => void)10+ 当该NavDestination页面显示时触发此回调。
onHidden(callback: () => void)10+ 当该NavDestination页面隐藏时触发此回调。
onBackPressed(callback: () => boolean)10+ 当与Navigation绑定的页面栈中存在内容时，此回调生效。
当点击返回键时，触发该回调。
返回值为true时，表示重写返回键逻辑，返回值为false时，表示回退到上一个页面。
onReady(callback: Callback<NavDestinationContext>)11+ 当NavDestination即将构建子组件之前会触发此回调。
名称 类型 描述
pathInfo NavPathInfo 跳转NavDestination时指定的参数。
pathStack NavPathStack 当前NavDestination所处的页面栈。

示例

NavDestination用法可参考Navigation示例。