跳转至正文
@capgo/capacitor-uploader 文件与存储 开源

上传器 Capacitor 插件

在后台可靠上传大文件,支持进度追踪和重试

安装

bun add @capgo/capacitor-uploader bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-uploader
  • pnpm add @capgo/capacitor-uploader
  • yarn add @capgo/capacitor-uploader

指南

如何在 Capacitor 中使用 Uploader

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Uploader 插件预览二维码 code

使用 @capgo/capacitor-uploader

Capacitor Uploader 插件,支持后台上传并可追踪进度。

安装

bun add @capgo/capacitor-uploader
bunx cap sync

插件暴露的内容

  • startUpload - 开始向服务器上传文件。
  • removeUpload - 取消并移除正在进行的上传。

用法示例

startUpload

开始向服务器上传文件。

import { Uploader } from '@capgo/capacitor-uploader';

const { id } = await Uploader.startUpload({
  filePath: 'file:///path/to/file.jpg',
  serverUrl: 'https://example.com/upload',
  headers: {
    'Authorization': 'Bearer token'
  },
  method: 'POST',
  uploadType: 'multipart',
  fileField: 'photo'
});
console.log('Upload started with ID:', id);

removeUpload

取消并移除正在进行的上传。

import { Uploader } from '@capgo/capacitor-uploader';

await Uploader.removeUpload({ id: 'upload-123' });

完整参考

继续阅读“使用 @capgo/capacitor-uploader”

如果你正在使用 使用 @capgo/capacitor-uploader 要规划迁移和企业运营,请将其与 @capgo/capacitor-uploader 有关 @capgo/capacitor-uploader 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 企业版 用于 Capgo Enterprise 中的产品工作流, Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流,以及 Capgo 替代方案 适用于 Capgo 产品工作流的替代方案。

常见问题

Uploader 插件常见问题

如何在 Capacitor 应用中安装 Uploader 插件?

运行 "bun add @capgo/capacitor-uploader"(或 "npm install @capgo/capacitor-uploader"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步 native code。最后在你的应用 code 中从 "@capgo/capacitor-uploader" 导入即可。

@capgo/capacitor-uploader 是否支持 React、Vue 和 Angular?

支持。Uploader 是一个 Capacitor 包,因此它支持任何在 Capacitor 中运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

@capgo/capacitor-uploader 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-uploader 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-uploader/,也可以直接从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以不经过 App Store 审核,更新使用 Uploader 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可快速发布 Uploader 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo