鸿蒙NEXT开发【@ohos.arkui.observer (无感监听)】 UI界面API
提供UI组件行为变化的无感监听能力。
说明
从API Version 11开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
导入模块
import { uiObserver as observer } from '@kit.ArkUI';
NavDestinationState
NavDestination组件状态。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| ON_SHOWN | 0 | NavDestination组件显示。卡片能力： 从API version 11开始，该接口支持在ArkTS卡片中使用。 |
| ON_HIDDEN | 1 | NavDestination组件隐藏。卡片能力： 从API version 11开始，该接口支持在ArkTS卡片中使用。 |
| ON_APPEAR12+ | 2 | NavDestination从组件树上挂载。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_DISAPPEAR12+ | 3 | NavDestination从组件树上卸载。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_WILL_SHOW12+ | 4 | NavDestination组件显示之前。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_WILL_HIDE12+ | 5 | NavDestination组件隐藏之前。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_WILL_APPEAR12+ | 6 | NavDestination挂载到组件树之前。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_WILL_DISAPPEAR12+ | 7 | NavDestination从组件树上卸载之前。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
| ON_BACKPRESS12+ | 100 | NavDestination组件返回。卡片能力： 从API version 12开始，该接口支持在ArkTS卡片中使用。 |
ScrollEventType12+
滚动事件的类型。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| SCROLL_START | 0 | 滚动事件开始。 |
| SCROLL_STOP | 1 | 滚动事件结束。 |
RouterPageState
routerPage生命周期触发时对应的状态。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| ABOUT_TO_APPEAR | 0 | page即将显示。 |
| ABOUT_TO_DISAPPEAR | 1 | page即将销毁。 |
| ON_PAGE_SHOW | 2 | page显示。 |
| ON_PAGE_HIDE | 3 | page隐藏。 |
| ON_BACK_PRESS | 4 | page返回时。 |
TabContentState12+
TabContent组件的状态。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 值 | 说明 |
|---|---|---|
| ON_SHOW | 0 | TabContent组件显示。 |
| ON_HIDE | 1 | TabContent组件隐藏。 |
NavDestinationInfo
NavDestination组件信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| navigationId | [ResourceStr] | 是 | 包含NavDestination组件的Navigation组件的id。 |
| name | [ResourceStr] | 是 | NavDestination组件的名称。 |
| state | [NavDestinationState] | 是 | NavDestination组件的状态。 |
| index12+ | number | 是 | NavDestination在页面栈中的索引。 |
| param12+ | Object | 否 | NavDestination组件的参数。 |
| navDestinationId12+ | string | 是 | NavDestination组件的唯一标识ID。 |
NavigationInfo12+
Navigation组件信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| navigationId | string | 是 | Navigation组件的id。 |
| pathStack | [NavPathStack] | 是 | Navigation组件的路由栈。 |
ScrollEventInfo12+
ScrollEvent滚动信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 滚动组件的id。 |
| uniqueId | number | 是 | 滚动组件的uniqueId。 |
| scrollEvent | [ScrollEventType] | 是 | 滚动事件的类型。 |
| offset | number | 是 | 滚动组件的当前偏移量。 |
ObserverOptions12+
Observer选项。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 是 | 组件的id。 |
RouterPageInfo
RouterPageInfo包含的信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | [UIAbilityContext] | [UIContext] | 是 |
| index | number | 是 | 触发生命周期的routerPage在栈中的位置。 |
| name | string | 是 | 触发生命周期的routerPage页面的名称。 |
| path | string | 是 | 触发生命周期的routerPage页面的路径。 |
| state | [RouterPageState] | 是 | 触发生命周期的routerPage页面的状态。 |
| pageId12+ | string | 是 | 触发生命周期的routerPage页面的唯一标识。 |
DensityInfo12+
屏幕像素密度变化回调包含的信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | [UIContext] | 是 | 屏幕像素密度变化时页面对应的上下文信息。 |
| density | number | 是 | 变化后的屏幕像素密度。 |
NavDestinationSwitchInfo12+
Navigation组件页面切换的信息。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| context | [UIAbilityContext] | [UIContext] | 是 |
| from | [NavDestinationInfo] | [NavBar] | 是 |
| to | [NavDestinationInfo] | [NavBar] | 是 |
| operation | [NavigationOperation] | 是 | 页面切换操作类型。 |
NavDestinationSwitchObserverOptions12+
Navigation组件页面切换事件的监听选项。
元服务API： 从API version 12开始，该接口支持在元服务中使用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| navigationId | [ResourceStr] | 是 | 指定需要监听的Navigation的ID |