跳过主要内容
返回插件
@capgo/capacitor-file-sharer
教程
由 github.com/Cap-go

文件共享

在 Android、iOS 和 Web 上从 base64 数据或本地路径共享和保存文件

指南

文件共享器教程

使用 @capgo/capacitor-file-sharer

从 base64 数据、数据 URL、本地文件路径、URL、Android、URI 和 __CAPGO_KEEP_0__ 中共享和保存文件 file:// 使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file-sharer content:// 从 base64 数据、数据 URL、本地文件路径、URL、Android、URI 和 Capacitor 中共享和保存文件 _capacitor_file_ URLs.

安装

bun add @capgo/capacitor-file-sharer
bunx cap sync

该插件暴露的内容

  • share - 在 Android 和 iOS 上打开原生分享sheet,或者在 Web 上下载文件。
  • save - 在 Android 上保存到公共收藏,打开 iOS 的保存/分享sheet,或者在 Web 上下载。
  • getPluginVersion - 返回平台实现版本。

示例用法

分享一个生成的文件

import { FileSharer } from '@capgo/capacitor-file-sharer';

await FileSharer.share({
  filename: 'report.pdf',
  contentType: 'application/pdf',
  base64Data: reportBase64,
  title: 'Quarterly report',
  text: 'Attached report',
});

分享一个本地文件

await FileSharer.share({
  filename: 'export.zip',
  contentType: 'application/zip',
  path: fileUri,
});

在 Android 上保存到下载

const result = await FileSharer.save({
  filename: 'backup.zip',
  contentType: 'application/zip',
  base64Data: zipBase64,
  android: {
    saveDirectory: 'downloads',
    relativePath: 'Download/My App',
  },
});

console.log(result.uri);

平台说明

  • Android 分享使用 FileProvider, ClipData,和 URI 权限允许预览和缩略图可以读取文件。
  • Android 保存使用 MediaStore 在 Android 10+ 和公共目录在 Android 9 以下。
  • iOS 分享支持两种 base64 后备临时文件和直接本地路径共享。
  • Web 分享和保存下载文件,使用大文件的分块 base64 转换。

完整参考

继续使用 @capgo/capacitor-file-sharer

如果您正在使用 使用 @capgo/capacitor-file-sharer 来规划存储和文件处理,连接它 @capgo/capacitor-file-sharer 为capgo实现细节在@capgo/capacitor-file-sharer, Getting Started 为__CAPGO_KEEP_0__实现细节在Getting Started, @capgo/capacitor-data-storage-sqlite 为capgo实现细节在@capgo/capacitor-data-storage-sqlite, 使用@capgo/capacitor-data-storage-sqlite 为capgo原生能力在使用@capgo/capacitor-data-storage-sqlite, 和 @capgo/capacitor-file 为capgo实现细节在@capgo/capacitor-file.