onShareAppMessage
在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息。
- 只有定义了此事件处理函数,右上角菜单才会显示“分享”按钮
- 用户点击分享按钮的时候会调用
- 此事件需要 return 一个 Object,用于自定义分享内容
自定义分享字段
字段 | 说明 | 默认值 |
---|---|---|
title | 分享标题 | 当前小程序名称 |
path | 分享路径 | 当前页面 path ,必须是以 / 开头的完整路径 |
success | 分享成功的回调函数 | |
fail | 分享失败的回调函数 | |
complete | 分享结束的回调函数(分享成功、失败都会执行 |
回调结果:
回调类型 | errMsg | 说明 |
---|---|---|
success | shareAppMessage:ok | 分享成功 |
fail | shareAppMessage:fail cancel | 用户取消分享 |
fail | shareAppMessage:fail (detail message) | 分享失败,其中 detail message 为详细失败信息 |
示例代码:
Page({
onShareAppMessage: function () {
return {
title: '自定义分享标题',
path: '/page/user?id=123',
success: function(res) {
// 分享成功
},
fail: function(res) {
// 分享失败
}
}
}
})
wx.showShareMenu(OBJECT)
基础库版本 1.1.0 开始支持,低版本需做兼容处理
微信客户端 6.5.6 版本开始支持
显示分享按钮
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
wx.showShareMenu()
wx.hideShareMenu(OBJECT)
基础库版本 1.1.0 开始支持,低版本需做兼容处理
微信客户端 6.5.6 版本开始支持
隐藏分享按钮
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
wx.hideShareMenu()
Bug & Tip
-
tip
: 分享图片不能自定义;会取当前页面,从顶部开始,高度为 80% 屏幕宽度的图像作为分享图片。 -
tip
:Page.onShareAppMessage
的回调函数从 6.5.7 版本开始才支持