小程序API能力集成指南——路由API汇总

ty.navigateBack

关闭当前页面，返回上一页面或多级页面

需引入MiniKit，且在>=2.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
delta	number		否	返回的页面数，如果 delta 大于现有页面数，则返回到首页
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 关闭当前页面，返回上一页面或多级页面
 */
export function navigateBack(params?: {
  /** 返回的页面数，如果 delta 大于现有页面数，则返回到首页 */
  delta?: number;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.navigateTo

路由到新页面

需引入MiniKit，且在>=2.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
url	string		是	页面路径
type	string		否	打开方式，支持全屏 full，半屏 half；默认全屏 full
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 路由到新页面
 */
export function navigateTo(params: {
  /** 页面路径 */
  url: string;
  /** 打开方式，支持全屏full，半屏half；默认全屏full */
  type?: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.redirectTo

关闭当前页面，跳转到应用内的某个页面

需引入MiniKit，且在>=2.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
url	string		是	页面路径
type	string		否	打开方式，支持全屏 full，半屏 half；默认全屏 full
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 关闭当前页面，跳转到应用内的某个页面
 */
export function redirectTo(params: {
  /** 页面路径 */
  url: string;
  /** 打开方式，支持全屏full，半屏half；默认全屏full */
  type?: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.reLaunch

关闭所有页面，打开到应用内的某个页面

需引入MiniKit，且在>=2.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
url	string		是	页面路径
type	string		否	打开方式，支持全屏 full，半屏 half；默认全屏 full
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 关闭所有页面，打开到应用内的某个页面
 */
export function reLaunch(params: {
  /** 页面路径 */
  url: string;
  /** 打开方式，支持全屏full，半屏half；默认全屏full */
  type?: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.switchTab

跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面

需引入MiniKit，且在>=2.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
url	string		是	页面路径
type	string		否	打开方式，支持全屏 full，半屏 half；默认全屏 full
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
 */
export function switchTab(params: {
  /** 页面路径 */
  url: string;
  /** 打开方式，支持全屏full，半屏half；默认全屏full */
  type?: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发。