小程序API能力集成指南——界面导航栏API汇总

ty.setNavigationBarColor

设置页面导航条颜色

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

参数

Object object

属性	类型	默认值	必填	说明
frontColor	string		是	前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000
backgroundColor	string		是	背景颜色值，有效值为十六进制颜色
animation	NavigationBarColorAnimationInfo		是	动画效果
complete	function		否
success	function		否
fail	function		否

NavigationBarColorAnimationInfo

属性	类型	默认值	必填	说明
duration	number		否	动画变化时间，单位 ms
timingFunc	string		否	动画变化方式 'linear' 动画从头到尾的速度是相同的 'easeIn' 动画以低速开始 'easeOut' 动画以低速结束 'easeInOut' 动画以低速开始和结束

函数定义示例

/**
 * 设置页面导航条颜色
 */
export function setNavigationBarColor(params: {
  /** 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 */
  frontColor: string;
  /** 背景颜色值，有效值为十六进制颜色 */
  backgroundColor: string;
  /** 动画效果 */
  animation: NavigationBarColorAnimationInfo;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.setNavigationBarTitle

动态设置当前页面的标题

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

参数

Object object

属性	类型	默认值	必填	说明
title	string		是	页面标题
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 动态设置当前页面的标题
 */
export function setNavigationBarTitle(params: {
  /** 页面标题 */
  title: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.hideHomeButton

隐藏返回首页按钮

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

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 隐藏返回首页按钮
 */
export function hideHomeButton(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.showNavigationBarLoading

在当前页面显示导航条加载动画

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

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 在当前页面显示导航条加载动画
 */
export function showNavigationBarLoading(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 

ty.hideNavigationBarLoading

在当前页面隐藏导航条加载动画

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

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 在当前页面隐藏导航条加载动画
 */
export function hideNavigationBarLoading(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发。