@capacitor/share

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

分享 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: '与好友分享',
});

// 仅分享文本
await Share.share({
  text: '你真的需要立即查看这个很棒的东西',
});

// 仅分享 URL
await Share.share({
  url: 'http://ionicframework.com/',
});

// 使用 url 参数分享本地文件
const photo = await Camera.getPhoto(options);
await Share.share({
  url: photo.path,
});

// 使用 files 参数分享多个文件
const { photos } = await Camera.pickImages(options);
await Share.share({
  files: photos.map(photo => photo.path!),
});

每个平台使用不同的字段集,但你应该提供所有字段。

API

• canShare()
• share(...)
• Interfaces

canShare()

canShare() => Promise<CanShareResult>

检查是否支持分享。

Returns:

Promise<CanShareResult>

Since: 1.1.0

---

share(...)

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

显示分享模态框以与其他应用分享内容

Param	Type
options	ShareOptions

Returns:

Promise<ShareResult>

Since: 1.0.0

---

Interfaces

CanShareResult

Prop	Type	Description	Since
value	boolean	是否支持分享。	1.1.0

ShareResult

Prop	Type	Description	Since
activityType	string	接收分享操作的应用的标识符。在某些情况下可能为空字符串。在 Web 上将是 undefined。	1.0.0

ShareOptions

Prop	Type	Description	Since
title	string	为任何消息设置标题。如果分享到电子邮件,这将是主题	1.0.0
text	string	设置一些要分享的文本	1.0.0
url	string	设置要分享的 URL,可以是 http、https 或 file:// URL	1.0.0
files	string[]	要分享的文件的 file:// URL 数组。仅支持 iOS 和 Android。	4.1.0
dialogTitle	string	为分享模态框设置标题。此选项仅在 Android 上支持。	1.0.0