Skip to content

@capgo/capacitor-file-picker

Capacitor File Picker Plugin interface for selecting files, images, videos, and directories.

Capacitor File Picker Plugin interface for selecting files, images, videos, and directories.

  • 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.
MethodDescription
pickFilesPick one or more files from the device.
pickImagesPick one or more images from the gallery. Android/iOS only.
pickVideosPick one or more videos from the gallery. Android/iOS only.
pickMediaPick one or more images or videos from the gallery. Android/iOS only.
pickDirectoryPick a directory from the device. Android/iOS only.
convertHeicToJpegConvert a HEIC image to JPEG format. iOS only.
copyFileCopy a file to a new location.
checkPermissionsCheck permissions for reading files. Android only.
requestPermissionsRequest permissions for reading files. Android only.
addListenerAdd a listener for the picker dismissed event. iOS only.
removeAllListenersRemove all listeners for this plugin.
getPluginVersionGet the native Capacitor plugin version.

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