跳转至正文

照片库 Capacitor 插件

在设备相册中浏览、保存和管理照片和视频,并处理权限

安装

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

指南

如何在 Capacitor 中使用 Photo Library

使用 @capgo/capacitor-photo-library

Capacitor 插件可将照片库以网页形式展示,或显示为无法修改但无需授权的枯燥原生界面。

安装

bun add @capgo/capacitor-photo-library
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

API 概览

方法 描述
checkAuthorization 返回当前授权状态,不向用户弹出提示。
requestAuthorization 如需访问,则请求照片库权限。
getAlbums 获取可用的相册列表。
getLibrary 获取库中的资源及其可在 web view 中显示的 URL。
getPhotoUrl 获取资源全分辨率版本的显示 URL。如果你已经调用了 getLibrary 配合 includeFullResolutionData,通常不需要再调用此方法。
getThumbnailUrl 获取该资源缩放后缩略图的可显示 URL。
pickMedia 打开原生系统选择器,让用户无需授予完整的相册访问权限即可选择媒体文件。所选文件将被复制到应用缓存中,并以可移植 URL 的形式返回。

示例

checkAuthorization()

返回当前授权状态,不向用户弹出提示。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.checkAuthorization();
console.log(result);

requestAuthorization()

如需访问,则请求照片库权限。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.requestAuthorization();
console.log(result);

getAlbums()

获取可用的相册列表。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getAlbums();
console.log(result);

getLibrary()

获取库中的资源及其可在 WebView 中显示的 URL。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getLibrary();
console.log(result);

getPhotoUrl()

获取资源全分辨率版本的显示 URL。如果您已经调用了 getLibrary 配合 includeFullResolutionData,通常无需再调用此方法。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getPhotoUrl({ id: 'id-123' });
console.log(result);

getThumbnailUrl()

获取该资源缩放后缩略图的可显示 URL。

import { PhotoLibrary } from '@capgo/capacitor-photo-library';

const result = await PhotoLibrary.getThumbnailUrl({ id: 'id-123' });
console.log(result);

上表列出了 7 个核心方法。有关监听器、版本辅助函数以及每个方法的完整契约,请参阅 GitHub 仓库.

完整参考文档

继续阅读:使用 @capgo/capacitor-photo-library

如果你正在使用 使用 @capgo/capacitor-photo-library 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-photo-library 有关 @capgo/capacitor-photo-library 中的实现细节, 快速入门 有关“入门指南”中的实现细节, 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力, @capgo/capacitor-live-activities 关于 @capgo/capacitor-live-activities 中的实现细节,以及 使用 @capgo/capacitor-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力

常见问题

Photo Library 插件常见问题

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

运行 "bun add @capgo/capacitor-photo-library"(或 "npm install @capgo/capacitor-photo-library"),然后运行 "bunx cap sync",让 iOS 和 Android 项目获取到原生 code。然后在应用 code 中从 "@capgo/capacitor-photo-library" 导入。

@capgo/capacitor-photo-library 支持 React、Vue 和 Angular 吗?

支持。Photo Library 是一个 Capacitor 包,因此任何运行在 Capacitor 里的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-photo-library 支持哪个 Capacitor 版本?

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

@capgo/capacitor-photo-library 是免费且开源的吗?

是的。code 的源代码在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-photo-library/,并且可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我能否在不经过 App Store 审核的情况下更新使用 Photo Library 的 code?

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

发布 Photo Library 更新,无需等待应用审核

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

开始使用 Capgo