页面路由


页面路由

icon-note.gif 说明:

  • 从API Version 8 开始,该接口不再维护,推荐使用新接口@ohos.router

  • 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import router from '@system.router';
1

router.push

push(options: RouterOptions): void

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

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

参数:

参数名 类型 必填 说明
options RouterOptions 页面路由参数,详细请参考RouterOptions。

示例:

// 在当前页面中
export default {
  pushPage() {
    router.push({
      uri: 'pages/routerpage2/routerpage2',
      params: {
        data1: 'message',
        data2: {
          data3: [123, 456, 789]
	},
      },
    });
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 在routerpage2页面中
export default {
  data: {
    data1: 'default',
    data2: {
      data3: [1, 2, 3]
    }
  },
  onInit() {
    console.info('showData1:' + this.data1);
    console.info('showData3:' + this.data2.data3);
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

icon-note.gif 说明: 页面路由栈支持的最大Page数量为32。

router.replace

replace(options: RouterOptions): void

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

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

参数:

参数名 类型 必填 说明
options RouterOptions 页面路由参数,详细请参考RouterOptions。

示例:

// 在当前页面中
export default {
  replacePage() {
    router.replace({
      uri: 'pages/detail/detail',
      params: {
        data1: 'message',
      },
    });
  }
}
1
2
3
4
5
6
7
8
9
10
11
// 在detail页面中
export default {
  data: {
    data1: 'default'
  },
  onInit() {
    console.info('showData1:' + this.data1)
  }
}
1
2
3
4
5
6
7
8
9

router.back

back(options?: BackRouterOptions): void

返回上一页面或指定的页面。

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

参数:

参数名 类型 必填 说明
options BackRouterOptions 详细请参考BackRouterOptions。

示例:

// index页面
export default {    
  indexPushPage() {        
    router.push({            
      uri: 'pages/detail/detail',        
    });        
  }
}
1
2
3
4
5
6
7
8
// detail页面
export default {    
  detailPushPage() {        
    router.push({            
      uri: 'pages/mall/mall',        
    });    
  }
}
1
2
3
4
5
6
7
8
// mall页面通过back,将返回detail页面
export default {    
  mallBackPage() {        
    router.back();    
  }
}
1
2
3
4
5
6
// detail页面通过back,将返回index页面
export default {    
  defaultBack() {        
    router.back();    
  }
}
1
2
3
4
5
6
// 通过back,返回到detail页面
export default {    
  backToDetail() {        
    router.back({uri:'pages/detail/detail'});    
  }
}
1
2
3
4
5
6

icon-note.gif 说明: 示例中的uri字段是页面路由,由配置文件中的pages列表指定。

router.getParams

getParams(): ParamsInterface

获取当前页面的参数信息。

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

返回值:

类型 说明
ParamsInterface 详细请参见ParamsInterface。

router.clear

clear(): void

清空页面栈中的所有历史页面,仅保留当前页面作为栈顶页面。

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

示例:

export default {    
  clearPage() {        
    router.clear();    
  }
}
1
2
3
4
5

router.getLength

getLength(): string

获取当前在页面栈内的页面数量。

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

返回值:

类型 说明
string 页面数量,页面栈支持最大数值是32。

示例:

export default {     
  getLength() {        
    var size = router.getLength();        
    console.log('pages stack size = ' + size);    
  }
}
1
2
3
4
5
6

router.getState

getState(): RouterState

获取当前页面的状态信息。

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

返回值:

参数类型 说明
RouterState 详细请参见RouterState。

示例:

export default {     
  getState() {        
    var page = router.getState();
    console.log('current index = ' + page.index);
    console.log('current name = ' + page.name);
    console.log('current path = ' + page.path);
  }
}
1
2
3
4
5
6
7
8

router.enableAlertBeforeBackPage6+

enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void

开启页面返回询问对话框。

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

参数:

参数名 类型 必填 说明
options EnableAlertBeforeBackPageOptions 详细请参见EnableAlertBeforeBackPageOptions。

示例:

export default {    
  enableAlertBeforeBackPage() {        
    router.enableAlertBeforeBackPage({            
      message: 'Message Info',            
      success: function() {                
        console.log('success');            
      },            
      fail: function() {                
        console.log('fail');            
      },        
    });    
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

router.disableAlertBeforeBackPage6+

disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void

禁用页面返回询问对话框。

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

参数:

参数名 类型 必填 说明
options DisableAlertBeforeBackPageOptions 详细请参见DisableAlertBeforeBackPageOptions。

示例:

export default {    
  disableAlertBeforeBackPage() {        
    router.disableAlertBeforeBackPage({            
      success: function() {                
        console.log('success');            
      },            
      fail: function() {                
        console.log('fail');            
      },        
    });    
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

RouterOptions

定义路由器的选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Lite

名称 参数类型 必填 说明
uri string 目标页面的uri,可以是以下的两种格式:
1. 页面的绝对路径,由config.json文件中的页面列表提供。例如:
- pages/index/index
-pages/detail/detail
2. 特定路径。如果URI为斜杠(/),则显示主页。
params Object 跳转时要同时传递到目标页面的数据,跳转到目标页面后,参数可以在页面中直接使用,如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段,则其值会被传入的字段值覆盖。

BackRouterOptions

定义路由器返回的选项。

系统能力: 以下各项对应的系统能力有所不同,详见下表。

名称 参数类型 必填 说明
uri string 返回到指定uri的界面,如果页面栈上没有uri页面,则不响应该情况。如果uri未设置,则返回上一页。
系统能力: SystemCapability.ArkUI.ArkUI.Full
params Object 跳转时要同时传递到目标页面的数据。
系统能力: SystemCapability.ArkUI.ArkUI.Lite

RouterState

定义路由器的状态。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称 参数类型 必填 说明
index number 表示当前页面在页面栈中的索引。从栈底到栈顶,index从1开始递增。
name string 表示当前页面的名称,即对应文件名。
path string 表示当前页面的路径。

EnableAlertBeforeBackPageOptions6+

定义EnableAlertBe beforeBackPage选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称 参数类型 必填 说明
message string 询问对话框内容。
success (errMsg: string) => void 弹出对话框时调用,errMsg表示返回信息。
fail (errMsg: string) => void 接口调用失败的回调函数,errMsg表示返回信息。
complete () => void 接口调用结束的回调函数。

DisableAlertBeforeBackPageOptions6+

定义DisableAlertBeforeBackPage参数选项。

系统能力: 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

名称 参数类型 必填 说明
success (errMsg: string) => void 弹出对话框时调用,errMsg表示返回信息。
fail (errMsg: string) => void 接口调用失败的回调函数,errMsg表示返回信息。
complete () => void 接口调用结束的回调函数。

ParamsInterface

名称 参数类型 说明
[key: string] Object 路由参数列表。