指南
如何在Capacitor中使用文件选择器
使用@capgo/capacitor-file-picker
Capacitor文件选择器插件用于选择文件、图片、视频和目录。
安装
bun add @capgo/capacitor-file-picker
bunx cap sync
bunx cap sync 将插件的本地code复制到您的本地项目中。每次升级插件后,请重新运行它。
导入
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
API概览
| 方法 | 描述 |
|---|---|
pickFiles |
从设备中选择一个或多个文件。 |
pickImages |
从相册中选择一个或多个图片。仅限Android/iOS。 |
pickVideos |
从相册中选择一个或多个视频。仅限Android/iOS。 |
pickMedia |
从相册中选择一个或多个图片或视频。仅限Android/iOS。 |
pickDirectory |
从设备中选择一个目录。仅限Android/iOS。 |
convertHeicToJpeg |
将HEIC图片转换为JPEG格式。仅限iOS。 |
copyFile |
复制文件到新位置。 |
checkPermissions |
检查广泛存储或媒体权限状态。仅用于选择器流程的应用程序不应在 Android 13+ 上阻止此权限。 pickFiles(), pickImages(), pickVideos(), 或 pickMedia() 在 Android 13+ 上请求广泛存储或媒体权限。不要请求或声明 |
requestPermissions |
或 READ_MEDIA_IMAGES or READ_MEDIA_VIDEO 选择器方法来访问用户选择的文件、图像或视频。Android only。 @capgo/capacitor-file-picker 示例 |
从设备中选择一个或多个文件。
pickFiles()
从图库中选择一个或多个图像。Android/iOS only。
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.pickFiles({
types: ['application/pdf', 'image/*'],
limit: 5,
readData: false
});
console.log('Picked files:', result.files);
pickImages()
从图库中选择一个或多个视频。Android/iOS only。
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.pickImages({
limit: 10,
readData: false
});
console.log('Picked images:', result.files);
pickVideos()
从图库中选择一个或多个图像或视频。Android/iOS only。
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.pickVideos({
limit: 3,
skipTranscoding: true
});
console.log('Picked videos:', result.files);
pickMedia()
仅在选择器替代品不足以为核心应用程序功能提供支持时,Google Play 才允许这些权限。使用选择器方法来访问用户选择的文件、图像或视频。Android only.
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.pickMedia({
limit: 5,
readData: true
});
console.log('Picked media:', result.files);
pickDirectory()
选择设备上的目录。仅限 Android/iOS。
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.pickDirectory();
console.log('Selected directory:', result.path);
convertHeicToJpeg()
将 HEIC 图像转换为 JPEG 格式。仅限 iOS。
import { CapgoFilePicker } from '@capgo/capacitor-file-picker';
const result = await CapgoFilePicker.convertHeicToJpeg({
path: '/path/to/image.heic',
quality: 0.9
});
console.log('Converted file:', result.path);
上表列出了 9 个核心方法。请参阅每个方法的详细文档,包括监听器和版本帮助。每个方法的完整契约在以下仓库中有详细说明。 GitHub 仓库.
监听事件
addListener 返回句柄。调用 handle.remove() 当屏幕卸载时,或者 CapgoFilePicker.removeAllListeners() 清除所有监听器。
完整参考
继续使用 @capgo/capacitor-file-picker
如果您正在使用 使用 @capgo/capacitor-file-picker 以规划存储和文件处理,连接它与 @capgo/capacitor-文件选择器 查看 @capgo/capacitor-file-picker 获取开始 查看 Getting Started @capgo/capacitor-sqlite-数据存储 查看 @capgo/capacitor-data-storage-sqlite 使用 @capgo/capacitor-data-storage-sqlite 查看 Using @capgo/capacitor-data-storage-sqlite @capgo/capacitor文件 关于@capgo/capacitor文件的实现细节。