基础库 2.8.3 开始支持，低版本需做兼容处理。
以 Promise 风格 调用：支持
需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然
微信小程序插件：不支持
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
隐藏返回首页按钮。微信7.0.7版本起，当用户打开的微信小程序最底层页面是非首页时，默认展示“返回首页”按钮，开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
以 Promise 风格 调用：支持
需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然
微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0
在微信小程序插件中使用时，只能在当前插件的页面中调用
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
在当前页面隐藏导航条加载动画
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
基础库 1.4.0 开始支持，低版本需做兼容处理。
以 Promise 风格 调用：支持
需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然
微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0
在微信小程序插件中使用时，只能在当前插件的页面中调用
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
设置页面导航条颜色
| 属性 | 类型 | 默认值 | 必填 | 说明 | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| frontColor | string | 是 | 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 | ||||||||||||||||||||||||||||||||||||
| backgroundColor | string | 是 | 背景颜色值，有效值为十六进制颜色 | ||||||||||||||||||||||||||||||||||||
| animation | Object | 否 | 动画效果 | ||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| success | function | 否 | 接口调用成功的回调函数 | ||||||||||||||||||||||||||||||||||||
| fail | function | 否 | 接口调用失败的回调函数 | ||||||||||||||||||||||||||||||||||||
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | ||||||||||||||||||||||||||||||||||||
wx.setNavigationBarColor({
frontColor: '#ffffff',
backgroundColor: '#ff0000',
animation: {
duration: 400,
timingFunc: 'easeIn'
}
})
以 Promise 风格 调用：支持
需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然
微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0
在微信小程序插件中使用时，只能在当前插件的页面中调用
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
动态设置当前页面的标题
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| title | string | 是 | 页面标题 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
wx.setNavigationBarTitle({
title: '当前页面'
})
以 Promise 风格 调用：支持
需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然
微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0
在微信小程序插件中使用时，只能在当前插件的页面中调用
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
在当前页面显示导航条加载动画
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
基础库 2.12.0 开始支持，低版本需做兼容处理。
以 Promise 风格 调用：不支持
微信小程序插件：不支持
相关文档: 开启监听 wx.enableAlertBeforeUnload
关闭微信小程序页面返回询问对话框。
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
基础库 2.12.0 开始支持，低版本需做兼容处理。
以 Promise 风格 调用：不支持
微信小程序插件：不支持
微信 鸿蒙 OS 版：支持
相关文档: 取消监听 wx.disableAlertBeforeUnload
开启微信小程序页面返回询问对话框。
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| message | string | 是 | 询问对话框内容 | |
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
在开发者工具中预览效果
基础库 1.1.0 开始支持，低版本需做兼容处理。
以 Promise 风格 调用：支持
微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
隐藏 loading 提示框
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|---|
| noConflict | boolean | false | 否 | 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 | 2.22.1 |
| success | function | 否 | 接口调用成功的回调函数 | ||
| fail | function | 否 | 接口调用失败的回调函数 | ||
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
以 Promise 风格 调用：支持
微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
隐藏消息提示框
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|---|
| noConflict | boolean | false | 否 | 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 | 2.22.1 |
| success | function | 否 | 接口调用成功的回调函数 | ||
| fail | function | 否 | 接口调用失败的回调函数 | ||
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
以 Promise 风格 调用：支持
微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6
微信 Windows 版：支持
微信 Mac 版：支持
微信 鸿蒙 OS 版：支持
显示操作菜单
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|---|
| alertText | string | 否 | 警示文案 | 2.14.0 | |
| itemList | Array.<string> | 是 | 按钮的文字数组，数组长度最大为 6 | ||
| itemColor | string | #000000 | 否 | 按钮的文字颜色 | |
| success | function | 否 | 接口调用成功的回调函数 | ||
| fail | function | 否 | 接口调用失败的回调函数 | ||
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| 属性 | 类型 | 说明 |
|---|---|---|
| tapIndex | number | 用户点击的按钮序号，从上到下的顺序，从0开始 |
wx.showActionSheet({
itemList: ['A', 'B', 'C'],
success (res) {
console.log(res.tapIndex)
},
fail (res) {
console.log(res.errMsg)
}
})