tt.hideHomeButton
收藏
我的收藏

基础库 1.48.0 开始支持本方法，这是一个异步方法。

隐藏返回首页按钮。基础库 1.48.0 版本起，当用户打开的小程序最底层页面是非首页时，默认展示【返回首页】按钮，开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。基础库 2.42.0 版本起，【返回首页】按钮 UI 改版，当用户打开小程序为一级页面，会露出小程序 logo，如果此时为非首页，点击 logo 会回到首页。此能力只能关闭返回首页的能力，但不影响左上角小程序 logo 按钮的露出。

语法

Plain Text复制
tt.hideHomeButton(options)

参数说明

options 为 object 类型，属性如下：

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

回调成功

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"hideHomeButton:ok"	1.48.0

回调失败

object 类型，属性如下：

属性名	类型	说明	最低支持版本
errMsg	string	"hideHomeButton:fail " + 详细错误信息	1.48.0

扫码体验

代码示例

开发者工具中预览

JavaScript复制
// 示例页
Page({
  data: {
    show: false,
  },
  hideHome() {
    tt.hideHomeButton({
      success: (res) => {
        console.log("hideHomeButton 调用成功", res);
        this.setData({
          show: !this.data.show,
        });
      },
      fail: (err) => {
        console.log("hideHomeButton 调用失败", err);
      },
      complete: (res) => {
        console.log("complete 调用", res);
      },
    });
  },
});

Plain Text复制
<view class="container">
  <view class="tips">
    当用户打开小程序为一级页面，会露出小程序 logo，如果此时为非首页，点击 logo 会回到首页。
    <br />
    开发者可在页面 onShow 中调用 hideHomeButton 关闭返回首页的能力，但不影响左上角小程序 logo 按钮的露出。
  </view>
  <view class="btn">
    <button type="primary" size="default" bindtap="hideHome" disabled="{{ show }}">
      禁用返回首页能力
    </button>
  </view>
</view>