API - 分享 - 《支付宝小程序开发文档》

分享
- onShareAppMessage
- 页面内发起分享
my.hideShareMenu(Object)

onShareAppMessage

在 Page 中定义 onShareAppMessage 函数，设置该页面的分享信息。

每个 Page 页面的右上角菜单中默认会显示“分享”按钮，重写了 onShareAppMessage 函数，只是自定义分享内容。
用户点击分享按钮的时候会调用。
此事件需要 return 一个 Object，用于自定义分享内容。
扫码体验：

Object 参数说明

参数	类型	说明	最低版本
from	String	触发来源： `button`：页面页分享按钮触发； `menu`：右上角分享按钮触发。	1.10.0
target	Object	如果 `from` 值为 `button`，则 `target` 为触发这次分享的 `button`，否则为 `undefined`	1.10.0
webViewUrl	String	页面中包含`web-view`组件时，返回当前`web-view`的`URL`	1.6.0

onShareAppMessage执行完后必须返回一个分享对象，用于自定义分享内容，内容如下：

返回值

名称	类型	必填	描述	最低版本
title	String	是	自定义分享标题
desc	String	否	自定义分享描述由于分享到微博只支持最大长度 140 个字，因此建议长度不要超过该限制。
path	String	是	自定义分享页面的路径，path中的自定义参数可在小程序生命周期的onLoad方法中获取（参数传递遵循http get的传参规则）
content	String	否	自定义吱口令文案，最多28个字符	1.7.0
imageUrl	String	否	自定义分享图片 - 网络图片路径 - apFilePath路径 - 相对路径使用场景详见下方说明	1.4.0
bgImgUrl	String	否	自定义分享二维码的背景图，建议大小750*950 - 网络图片路径该字段为预览图片，使用场景详见下方说明	1.9.0
success	Function	否	分享成功后回调	1.4.0
fail	Function	否	分享失败后回调	1.4.0

代码示例

Page({
  onShareAppMessage() {
    return {
      title: '小程序示例',
      desc: '小程序官方示例Demo，展示已支持的接口能力及组件。',
      path: 'page/component/component-pages/view/view?param=123'
    };
  },
});

页面内发起分享

基础库版本 1.1.0 开始支持通过给 button 组件设置属性 open-type="share"，可以在用户点击按钮后触发Page.onShareAppMessage() 事件，并唤起分享面板，如果当前页面没有定义此事件，则点击后无效果。相关组件：button

my.hideShareMenu(Object)

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

隐藏分享按钮。

Object 参数说明

名称	类型	必填	描述
success	Function	否	调用成功的回调函数
fail	Function	否	分享失败的回调函数
complete	Function	否	调用结束的回调函数（调用成功、失败都会执行）示例代码

示例代码

my.hideShareMenu();

分享场景及字段说明

原文: https://docs.alipay.com/mini/api/share_app