作者： Next

wx.enableAlertBeforeUnload(Object object)

基础库 2.12.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 鸿蒙 OS 版：支持

相关文档: 取消监听 wx.disableAlertBeforeUnload

功能描述

开启微信小程序页面返回询问对话框。

弹窗条件

  • 当用户在微信小程序内非首页页面/最底层页
  • 官方导航栏上的的返回
  • 全屏模式下自绘返回键
  • android 系统 back 键时

注意事项

  • 手势滑动返回时不做拦截
  • 在任何场景下，此功能都不应拦住用户退出微信小程序的行为

参数

Object object

属性 类型 默认值 必填 说明
message string 是 询问对话框内容
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

在开发者工具中预览效果

wx.hideLoading(Object object)

基础库 1.1.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏 loading 提示框

参数

Object object

属性 类型 默认值 必填 说明 最低版本
noConflict boolean false 否 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 2.22.1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.hideToast(Object object)

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏消息提示框

参数

Object object

属性 类型 默认值 必填 说明 最低版本
noConflict boolean false 否 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性 2.22.1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.showActionSheet(Object object)

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

显示操作菜单

参数

Object object

属性 类型 默认值 必填 说明 最低版本
alertText string 否 警示文案 2.14.0
itemList Array.<string> 是 按钮的文字数组，数组长度最大为 6
itemColor string #000000 否 按钮的文字颜色
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
tapIndex number 用户点击的按钮序号，从上到下的顺序，从0开始

示例代码

wx.showActionSheet({
  itemList: ['A', 'B', 'C'],
  success (res) {
    console.log(res.tapIndex)
  },
  fail (res) {
    console.log(res.errMsg)
  }
})

注意

  • Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 “fail cancel”；
  • Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑

wx.showLoading(Object object)

基础库 1.1.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框

参数

Object object

属性 类型 默认值 必填 说明
title string 是 提示的内容
mask boolean false 否 是否显示透明蒙层，防止触摸穿透
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.showLoading({
  title: '加载中',
})

setTimeout(function () {
  wx.hideLoading()
}, 2000)

注意

  • wx.showLoading 和 wx.showToast 同时只能显示一个
  • wx.showLoading 应与 wx.hideLoading 配对使用

wx.showModal(Object object)

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

显示模态对话框

参数

Object object

属性 类型 默认值 必填 说明 最低版本
title string 否 提示的标题
content string 否 提示的内容
showCancel boolean true 否 是否显示取消按钮
cancelText string 取消 否 取消按钮的文字，最多 4 个字符
cancelColor string #000000 否 取消按钮的文字颜色，必须是 16 进制格式的颜色字符串
confirmText string 确定 否 确认按钮的文字，最多 4 个字符
confirmColor string #576B95 否 确认按钮的文字颜色，必须是 16 进制格式的颜色字符串
editable boolean false 否 是否显示输入框 2.17.1
placeholderText string 否 显示输入框时的提示文本 2.17.1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
content string editable 为 true 时，用户输入的文本
confirm boolean 为 true 时，表示用户点击了确定按钮
cancel boolean 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） 1.1.0

示例代码

wx.showModal({
  title: '提示',
  content: '这是一个模态弹窗',
  success (res) {
    if (res.confirm) {
      console.log('用户点击确定')
    } else if (res.cancel) {
      console.log('用户点击取消')
    }
  }
})

注意

  • Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 “fail cancel”；
  • Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑
  • 自基础库 2.17.1 版本起，支持传入 editable 参数，显示带输入框的弹窗

wx.showToast(Object object)

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 1.9.6

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

显示消息提示框

参数

Object object

属性 类型 默认值 必填 说明 最低版本
title string 是 提示的内容
icon string success 否 图标
合法值 说明 最低版本
success 显示成功图标，此时 title 文本最多显示 7 个汉字长度
error 显示失败图标，此时 title 文本最多显示 7 个汉字长度 2.14.1
loading 显示加载图标，此时 title 文本最多显示 7 个汉字长度
none 不显示图标，此时 title 文本最多可显示两行，1.9.0及以上版本支持
image string 否 自定义图标的本地路径，image 的优先级高于 icon 1.1.0
duration number 1500 否 提示的延迟时间
mask boolean false 否 是否显示透明蒙层，防止触摸穿透
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.showToast({
  title: '成功',
  icon: 'success',
  duration: 2000
})

注意

  • wx.showLoading 和 wx.showToast 同时只能显示一个
  • wx.showToast 应与 wx.hideToast 配对使用

wx.authPrivateMessage(Object object)

基础库 2.13.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

相关文档: 微信小程序私密消息

功能描述

验证私密消息。用法详情见 微信小程序私密消息使用指南

参数

Object object

属性 类型 默认值 必填 说明
shareTicket string 是 shareTicket。可以从 wx.getEnterOptionsSync 中获取。详情 shareTicket
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
errMsg string 错误信息
valid boolean 验证是否通过
encryptedData string 经过加密的activityId，解密后可得到原始的activityId。若解密后得到的activityId可以与开发者后台的活动id对应上则验证通过，否则表明valid字段不可靠（被篡改） 详细见加密数据解密算法
iv string 加密算法的初始向量，详细见加密数据解密算法

示例代码

wx.authPrivateMessage({
  shareTicket: 'xxxxxx',
  success(res) {
    console.log('authPrivateMessage success', res)
    // res
    // {
    //   errMsg: 'authPrivateMessage:ok'
    //   valid: true
    //   iv: 'xxxx',
    //   encryptedData: 'xxxxxx'
    // }
  },
  fail(res) {
    console.log('authPrivateMessage fail', res)
  }
})

wx.getShareInfo(Object object)

从基础库 2.17.3 开始，本接口停止维护，请使用 wx.getGroupEnterInfo 代替

基础库 1.1.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

获取转发详细信息（主要是获取群ID）。 从群聊内的微信小程序消息卡片打开微信小程序时，调用此接口才有效。从基础库 v2.17.3 开始，推荐用 wx.getGroupEnterInfo 替代此接口。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
shareTicket string 是 shareTicket，详见获取更多转发信息
timeout number 否 超时时间，单位 ms 1.9.90
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明 最低版本
errMsg string 错误信息
encryptedData string 包括敏感数据在内的完整转发信息的加密数据，详细见加密数据解密算法
iv string 加密算法的初始向量，详细见加密数据解密算法
cloudID string 敏感数据对应的云 ID，开通云开发的微信小程序才会返回，可通过云调用直接获取开放数据，详细见云调用直接获取开放数据 2.7.0

示例代码

敏感数据获取方式 加密数据解密算法 。 获取得到的开放数据为以下 json 结构（其中 openGId 为当前群的唯一标识）：

{
 "openGId": "OPENGID"
}

Tips

  • 如需要展示群名称，微信小程序可以使用 开放数据组件
  • 小游戏可以通过 wx.getGroupInfo 接口获取群名称

wx.hideShareMenu(Object object)

基础库 1.1.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏当前页面的转发按钮

参数

Object object

属性 类型 默认值 必填 说明 最低版本
menus Array.<string> 否 本接口为 Beta 版本，暂只在 Android 平台支持。需要隐藏的转发按钮名称列表，默认[‘shareAppMessage’, ‘shareTimeline’]。按钮名称合法值包含 “shareAppMessage”、”shareTimeline” 两种 2.11.3
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

注意事项

  • “shareAppMessage”表示“发送给朋友”按钮，”shareTimeline”表示“分享到朋友圈”按钮
  • 隐藏“发送给朋友”按钮时必须同时隐藏“分享到朋友圈”按钮，隐藏“分享到朋友圈”按钮时则允许不隐藏“发送给朋友”按钮

示例代码

wx.hideShareMenu({
  menus: ['shareAppMessage', 'shareTimeline']
})