@capgo/capacitor-file-picker

Overview

Pick files, images, videos, and directories with full native support for iOS and Android including HEIC conversion

Start with pickFiles() and the other core methods listed below.

Platform support

Platform	Support	Notes
iOS	Yes	Native
Android	Yes	Native
Web	Partial	pickFiles / gallery picks via browser APIs; directory pick and HEIC conversion are native-only

Core Capabilities

• pickFiles - Pick one or more files from the device.
• pickImages - Pick one or more images from the gallery. Android/iOS only.
• pickVideos - Pick one or more videos from the gallery. Android/iOS only.
• pickMedia - Pick one or more images or videos from the gallery. Android/iOS only.

Public API

Method	Description
pickFiles	Pick one or more files from the device.
pickImages	Pick one or more images from the gallery. Android/iOS only.
pickVideos	Pick one or more videos from the gallery. Android/iOS only.
pickMedia	Pick one or more images or videos from the gallery. Android/iOS only.
pickDirectory	Pick a directory from the device. Android/iOS only.
convertHeicToJpeg	Convert a HEIC image to JPEG format. iOS only.
copyFile	Copy a file to a new location.
checkPermissions	Check permissions for reading files. Android only.
requestPermissions	Request permissions for reading files. Android only.
addListener	Add a listener for the picker dismissed event. iOS only.
removeAllListeners	Remove all listeners for this plugin.
getPluginVersion	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-file-picker.

Keep going from @capgo/capacitor-file-picker

If you are using @capgo/capacitor-file-picker to plan storage and file handling, connect it with Using @capgo/capacitor-file-picker for the native capability in Using @capgo/capacitor-file-picker, @capgo/capacitor-data-storage-sqlite for the implementation detail in @capgo/capacitor-data-storage-sqlite, Using @capgo/capacitor-data-storage-sqlite for the native capability in Using @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file for the implementation detail in @capgo/capacitor-file, and Using @capgo/capacitor-file for the native capability in Using @capgo/capacitor-file.