uni.share(OBJECT)

分享到社交平台（微信、QQ、微博、短信、邮件等）

平台差异说明

OBJECT 参数说明

type 值说明

scene 值说明

miniProgram 值说明

注意事项：

• App端可调用手机的系统分享，实现所有注册分享的应用的呼起，比如短信、邮件等，具体参考plus.share.sendWithSystem的API文档
• 插件市场有一个封装好的分享菜单，直接弹出底部图标菜单，并且没有遮挡层级问题，推荐使用，https://ext.dcloud.net.cn/plugin?id=69
• uni.share API 仅用于 App 平台。小程序平台的分享，请参考 小程序分享指引。
• 分享到 QQ 必须含有 href 链接
• 分享文字到 QQ 时，title 必选
• 新浪微博仅支持分享本地音视频
• 仅支持分享微信小程序到微信聊天界面，想进入朋友圈需改为分享图片方式，在图片中包含小程序码
• 在 iOS 端，若未安装微博客户端，会启用微博的网页分享，此时不能分享图片
• 分享新浪微博不会返回正确的成功回调
• 不能直接分享到QQ空间，可以分享到QQ，然后在QQ的界面里选择QQ空间。
• 分享微信朋友圈多图，微信官方已经禁掉这个功能。可以考虑把多张图用canvas合并成一张图分享出去。

分享到微信聊天界面

分享文字

uni.share({
    provider: "weixin",
    scene: "WXSceneSession",
    type: 1,
    summary: "我正在使用HBuilderX开发uni-app，赶紧跟我一起来体验！",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

分享图片

uni.share({
    provider: "weixin",
    scene: "WXSceneSession",
    type: 2,
    imageUrl: "https://img-cdn-qiniu.dcloud.net.cn/uniapp/images/uni@2x.png",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

分享图文

href、imageUrl 为必选参数，title/summary 二选一，最好将这四个参数都选上。

uni.share({
    provider: "weixin",
    scene: "WXSceneSession",
    type: 0,
    href: "http://uniapp.dcloud.io/",
    title: "uni-app分享",
    summary: "我正在使用HBuilderX开发uni-app，赶紧跟我一起来体验！",
    imageUrl: "https://img-cdn-qiniu.dcloud.net.cn/uniapp/images/uni@2x.png",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

分享到微信朋友圈

分享文字

uni.share({
    provider: "weixin",
    scene: "WXSenceTimeline",
    type: 1,
    summary: "我正在使用HBuilderX开发uni-app，赶紧跟我一起来体验！",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

分享图片

uni.share({
    provider: "weixin",
    scene: "WXSenceTimeline",
    type: 2,
    imageUrl: "https://img-cdn-qiniu.dcloud.net.cn/uniapp/images/uni@2x.png",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

分享图文

href、imageUrl 为必选参数，title、summary 至少有一项。

uni.share({
    provider: "weixin",
    scene: "WXSenceTimeline",
    type: 0,
    href: "http://uniapp.dcloud.io/",
    title: "uni-app分享",
    summary: "我正在使用HBuilderX开发uni-app，赶紧跟我一起来体验！",
    imageUrl: "https://img-cdn-qiniu.dcloud.net.cn/uniapp/images/uni@2x.png",
    success: function (res) {
        console.log("success:" + JSON.stringify(res));
    },
    fail: function (err) {
        console.log("fail:" + JSON.stringify(err));
    }
});

App分享为微信小程序（App中分享一个内容到微信好友，对方微信中呈现的是一个小程序卡片）

uni.share({
    provider: 'weixin',
    type: 5,
    imageUrl: 'https://img-cdn-qiniu.dcloud.net.cn/uniapp/app/share-logo@3.png',
    title: '欢迎体验uniapp',
    miniProgram: {
        id: 'gh_abcdefg',
        path: 'pages/index/index',
        type: 0,
        webUrl: 'http://uniapp.dcloud.io'
    },
    success: ret => {
        console.log(JSON.stringify(ret));
    }
});

onShareAppMessage(OBJECT)

小程序中用户点击分享后，在 js 中定义 onShareAppMessage 处理函数（和 onLoad 等生命周期函数同级），设置该页面的分享信息。

• 用户点击分享按钮的时候会调用。这个分享按钮可能是小程序原生菜单自带的分享按钮，也可能是开发者在页面中放置的分享按钮（）；
• 此事件需要 return 一个Object，用于自定义分享内容。平台差异说明

此事件需要 return 一个 Object，用于自定义分享内容，其内容如下：

示例代码

export default {
  onShareAppMessage(res) {
    if (res.from === 'button') {// 来自页面内分享按钮
      console.log(res.target)
    }
    return {
      title: '自定义分享标题',
      path: '/pages/test/test?id=123'
    }
  }
}

uni.showShareMenu(OBJECT)

小程序的原生菜单中显示分享按钮

1.6.0 新增

平台差异说明

uni.hideShareMenu(OBJECT)

小程序的原生菜单中隐藏分享按钮

平台差异说明

代码示例

uni.hideShareMenu()

App 端各平台分享配置说明

• 第一步，打开 manifest.json -> App模块权限配置，勾选 Share(分享)；
• 第二步，按如下文档具体配置微信、微博、QQ的参数。

微信分享

在 manifest.json 的 App SDK 配置里，勾选微信消息及朋友圈，并填写相关 appkey，微信 appkey 申请步骤可参考：https://ask.dcloud.net.cn/article/208。

新浪微博分享

在 manifest.json 的 App SDK 配置里，勾选勾选新浪微博，并填写相关appkey，新浪微博 appkey 申请步骤可参考：https://ask.dcloud.net.cn/article/209。

QQ 分享

在 manifest.json 的 App SDK 配置里，勾选分享到QQ好友，并填写相关appkey，QQ分享 appkey 申请步骤：

• 前往 QQ 开放平台：https://connect.qq.com/index.html；
• 完成开发者注册；
• 创建应用，选择移动 App，填写相关信息，然后等待审核，审核通过后即可得到AppId。

这些配置需要打包生效，真机运行仍然是HBuilder基座的设置，可使用自定义基座包。离线打包请参考离线打包文档在原生工程中配置。

配置并打包后，通过uni.getProvider可以得到配置的结果列表，注意这里返回的是manifest配置的，与手机端是否安装微信、QQ、微博无关。

如果手机端未安装QQ、微博，调用时会启动这些平台的wap页面分享，如果已安装相应客户端，会启动它们的客户端分享。

FAQ

• Q：App端如何集成其他登陆SDK
• A：使用原生插件方式，可以集成三方sdk，原生插件开发文档见https://ask.dcloud.net.cn/article/35428。开发之前可以先去插件市场看下有没有做好的。

发现错误？想参与编辑？在 GitHub 上编辑此页面！