跳到主要内容
版本:v4

@capacitor/share

Share API 提供了在用户已安装的任何支持分享功能的应用程序中分享内容的方法。

Share API 支持 iOS、Android 和 Web 平台(使用新的 Web Share API),不过目前 Web 平台的支持尚不完善。

安装

npm install @capacitor/share
npx cap sync

Android

默认情况下,Capacitor 应用只允许分享缓存文件夹中的文件。要使其他 Android 文件夹可被分享,必须将它们添加到 android/app/src/main/res/xml/file_paths.xml 文件中。请查阅 FileProvider 文档 中的“指定可用文件”部分以了解可用的位置。

示例

import { Share } from '@capacitor/share';

await Share.share({
title: '查看酷炫内容',
text: '你现在就需要看看这个非常棒的东西',
url: 'http://ionicframework.com/',
dialogTitle: '分享给好友',
});

每个平台使用不同的字段集合,但建议您提供所有字段。

API

canShare()

canShare() => Promise<CanShareResult>

检查当前设备是否支持分享功能。

返回值:

Promise<CanShareResult>

自: 1.1.0


share(...)

share(options: ShareOptions) => Promise<ShareResult>

显示一个分享模态框,用于将内容分享到其他应用程序。

参数类型
options
ShareOptions

返回值:

Promise<ShareResult>

自: 1.0.0


接口

CanShareResult

属性类型描述
valueboolean指示当前设备是否支持分享功能。1.1.0

ShareResult

属性类型描述
activityTypestring接收分享操作的应用标识符。在某些情况下可能为空字符串。在 Web 平台上此值为 undefined。1.0.0

ShareOptions

属性类型描述
titlestring设置消息的标题。如果是分享到电子邮件,这将作为邮件主题1.0.0
textstring设置要分享的文本内容1.0.0
urlstring设置要分享的 URL,可以是 http、https 或 file:// 协议的 URL1.0.0
filesstring[]要分享的文件 URL 数组,仅支持 file:// 协议。目前仅支持 iOS 和 Android 平台。4.1.0
dialogTitlestring设置分享模态框的标题。此选项仅在 Android 平台上支持。1.0.0