跳过主要内容

相册 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

在设备上测试

下载Capgo应用,扫描QR code

相册插件预览QR code

使用@capgo/capacitor-photo-library

Capacitor插件显示相册图库作为网页,或者无需授权的native屏幕

安装

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视图中显示的URL。
getPhotoUrl 获取可显示的URL以获取资产的全分辨率版本。如果您已经调用了 getLibrary with 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()

获取图库资产及其可在Web视图中显示的URL。

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

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

getPhotoUrl()

获取一个可显示的完整分辨率版本的资产URL。如果您已经调用了 getLibrary ,通常不需要此方法。 includeFullResolutionData上表列出了7个核心方法。监听器和版本帮助,以及每个方法的完整契约,均在

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);

中文档 GitHub 仓库.

全参考

继续使用 @capgo/capacitor-photo-library

如果您正在使用 使用 @capgo/capacitor-photo-library 来规划原生媒体和界面行为,连接它与 @capgo/capacitor-相机图库 实现细节在 @capgo/capacitor-photo-library 开始 为 Getting Started 中的实现细节 使用 @capgo/capacitor-live-activities 为 Using @capgo/capacitor-live-activities 中的原生能力 使用 @capgo/capacitor-live-activities 为 @capgo/capacitor-live-activities 中的实现细节,以及 使用 @capgo/capacitor-video-player 为 Using @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 项目捕获 native code。从 "@capgo/capacitor-photo-library" 导入到您的应用 code。

@capgo/capacitor-photo-library 与 React、Vue 和 Angular 是否兼容?

是的。Photo Library 是一个 Capacitor 包,因此它与任何运行在 Capacitor 内的 web 框架兼容,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

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

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请求。

是否可以更新使用Photo Library的code而不需要App Store的审查?

安装或升级插件会改变native code,因此需要新的商店构建。之后,使用Capgo live updates的JavaScript、HTML和CSS更改可以立即发布。

无需等待应用商店审核即可推送Photo Library更新

一旦插件添加到您的应用商店构建中,Capgo即刻推送您的JavaScript、HTML和CSS更新到用户端

开始使用Capgo