目录

路由事件

has.onAppRoute

has.onAppRoute(function callback)

监听路由事件下发后,执行路由逻辑后的事件监听。目标页面onLoad、onShow生命周期执行完之后,返回res数据给用户。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
callback function 是 路由事件的监听函数。

res返回值:

Object类型,包含以下字段。

参数 类型 描述
path string 目标页面路径,取自页面实例page.path。
query Object 跳转至目标页面的路由参数,无参数时为空对象{}。
renderer string 渲染引擎,当前固定为`'webview'。
openType string 目标页面路由打开类型,包含navigateTo、navigateBack、redirectTo、switchTab、reLaunch、appLaunch。
webviewId string 目标页面id。
timeStamp number onAppRoute触发时的时间戳(毫秒)。
routeEventId string 路由事件唯一标识,格式为{webviewId}_{timeStamp}。
page Object 目标页面的相关配置。
source string 路由事件来源,见下方合法值。

[h2]source合法值

合法值 描述
api JS直接调用has.navigateTo/has.switchTab等路由API。
navigator <navigator>组件触发。
web H5页面经web-view组件调用路由API。
system 系统内部行为,如TabBar点击、返回键。
launch 元服务冷启动时页面加载。

示例:

const onAppRouteFn = function(res) {
  console.info('onAppRoute callback triggered', res);
};
has.onAppRoute(onAppRouteFn);

has.offAppRoute

has.offAppRoute(function callback)

移除路由事件的监听函数。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
callback function 否 需移除的监听函数。不传此参数,则移除onAppRoute的所有监听函数。

示例:

const onAppRouteFn = function(res) {
  console.info('onAppRoute callback triggered', res);
};
has.onAppRoute(onAppRouteFn);
// 移除指定监听,需要传入同一个函数对象
has.offAppRoute(onAppRouteFn);
// 移除所有监听
has.offAppRoute();

has.onBeforeAppRoute

has.onBeforeAppRoute(function callback)

监听路由事件下发后,执行路由逻辑前的事件监听。返回res数据给用户。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
callback function 是 路由事件的监听函数。

res返回值:

Object类型,包含以下字段。

参数 类型 描述
path string 目标页面路径,取自页面实例page.path。
query Object 跳转至目标页面的路由参数,无参数时为空对象{}。
renderer string 渲染引擎,当前固定为'webview'。
openType string 目标页面路由打开类型,包含navigateTo、navigateBack、redirectTo、switchTab、reLaunch、appLaunch。
webviewId string 目标页面 id。
routeEventId string 路由事件唯一标识,格式为{webviewId}_{timeStamp}。
page Object 目标页面的相关配置。
source string 路由事件来源,同onAppRoute。

示例:

const onBeforeAppRouteFn = function(res) {
  console.info('onBeforeAppRoute callback triggered', res);
};
has.onBeforeAppRoute(onBeforeAppRouteFn);

has.offBeforeAppRoute

has.offBeforeAppRoute(function callback)

移除路由事件(执行前)的监听函数。

起始版本: 2.0.6

参数:

参数 类型 必填 描述
callback function 否 需移除的监听函数。不传此参数,则移除onBeforeAppRoute的所有监听函数。

示例:

const onBeforeAppRouteFn = function(res) {
  console.info('onBeforeAppRoute callback triggered', res);
};
has.onBeforeAppRoute(onBeforeAppRouteFn);
// 移除指定监听,需要传入同一个函数对象
has.offBeforeAppRoute(onBeforeAppRouteFn);
// 移除所有监听
has.offBeforeAppRoute();