文档管理中心
我的

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考应用框架ArkUI(方舟UI框架)ArkTS组件已停止维护的组件与接口Navigator

Navigator

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

路由容器组件,提供路由跳转能力。

说明

从API version 13开始,该组件不再维护,建议使用Navigation组件进行页面路由。

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

子组件

可以包含子组件。

接口

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

Navigator(value?: {target: string, type?: NavigationType})

说明

从API version 7开始支持,从API version 13开始废弃,建议使用NavPathInfo替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
target string 是 指定跳转目标页面的路径。
type NavigationType 否

指定路由方式。

默认值:NavigationType.Push

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

Navigator()

说明

从API version 7开始支持,从API version 13开始废弃,建议使用NavigationAttribute替代。NavigationAttribute为Navigation组件的属性。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

路由的跳转方式。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

展开
名称 值 说明
Push 1

跳转到应用内的指定页面。

说明:

从API version 7开始支持,从API version 13开始废弃,建议使用pushPath替代。

Replace 2

用应用内的某个页面替换当前页面,并销毁被替换的页面。

说明:

从API version 7开始支持,从API version 13开始废弃,建议使用replacePath替代。

Back 3

返回到指定的页面。指定的页面不存在栈中时不响应。未传入指定的页面时返回上一页。

说明:

从API version 7开始支持,从API version 13开始废弃,建议使用pop替代。

属性

active(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

active(value: boolean)

设置当前路由组件是否处于激活状态,处于激活状态时,会生效相应的路由操作。

说明

从API version 7开始支持,从API version 13开始废弃,建议使用Navigation替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
value boolean 是 路由组件是否处于激活状态。设置为true时,组件处于激活态。设置为false时,组件不处于激活态。

params(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

params(value: object)

设置跳转时传递到目标页面的数据。

说明

从API version 7开始支持,从API version 13开始废弃,建议使用param替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
value object 是 跳转时要同时传递到目标页面的数据,可在目标页面使用router.getParams()获得。

target(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

target(value: string)

设置跳转目标页面的路径。目标页面需加入main_pages.json文件中。

说明

从API version 7开始支持,从API version 13开始废弃,建议使用Navigation替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
value string 是 跳转目标页面的路径。

type(deprecated)

Phone12+PC/2in113+Tablet12+TV19+Wearable18+

type(value: NavigationType)

设置路由跳转方式。

说明

从API version 7开始支持,从API version 13开始废弃,建议使用Navigation替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

展开
参数名 类型 必填 说明
value NavigationType 是

路由跳转方式。

默认值:NavigationType.Push

示例

收起
自动换行
深色代码主题
复制
  1. // code.ets
  2. export interface NameObject {
  3. name: string;
  4. }
  5. export class TextObject {
  6. text: NameObject;
  7. constructor(text: NameObject) {
  8. this.text = text;
  9. }
  10. }
收起
自动换行
深色代码主题
复制
  1. import { NameObject, TextObject } from '../../code';
  2. @Entry
  3. @Component
  4. struct NavigatorExample {
  5. @State active: boolean = false
  6. @State name: NameObject = { name: 'news' }
  7. build() {
  8. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
  9. Navigator({ target: 'pages/container/navigator/Detail', type: NavigationType.Push }) {
  10. Text('Go to ' + this.name.name + ' page')
  11. .width('100%').textAlign(TextAlign.Center)
  12. }.params(new TextObject(this.name)) // 传参数到Detail页面
  13. Navigator() {
  14. Text('Back to previous page').width('100%').textAlign(TextAlign.Center)
  15. }.active(this.active)
  16. .onClick(() => {
  17. this.active = true
  18. })
  19. }.height(150).width(350).padding(35)
  20. }
  21. }
收起
自动换行
深色代码主题
复制
  1. import { NameObject } from '../../code';
  2. @Entry
  3. @Component
  4. struct DetailExample {
  5. // 接收Navigator.ets的传参
  6. params: Record<string, NameObject> = this.getUIContext().getRouter().getParams() as Record<string, NameObject>
  7. @State name: NameObject = this.params.text
  8. build() {
  9. Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Start, justifyContent: FlexAlign.SpaceBetween }) {
  10. Navigator({ target: 'pages/container/navigator/Back', type: NavigationType.Push }) {
  11. Text('Go to back page').width('100%').height(20)
  12. }
  13. Text('This is ' + this.name.name + ' page')
  14. .width('100%').textAlign(TextAlign.Center)
  15. }
  16. .width('100%').height(200).padding({ left: 35, right: 35, top: 35 })
  17. }
  18. }
收起
自动换行
深色代码主题
复制
  1. // Back.ets
  2. @Entry
  3. @Component
  4. struct BackExample {
  5. build() {
  6. Column() {
  7. Navigator({ target: 'pages/container/navigator/Navigator', type: NavigationType.Back }) {
  8. Text('Return to Navigator Page').width('100%').textAlign(TextAlign.Center)
  9. }
  10. }.width('100%').height(200).padding({ left: 35, right: 35, top: 35 })
  11. }
  12. }