{"id":42102115,"url":"https://github.com/Cap-go/capacitor-file-picker","last_synced_at":"2026-02-05T13:00:51.371Z","repository":{"id":329449801,"uuid":"1117244843","full_name":"Cap-go/capacitor-file-picker","owner":"Cap-go","description":"Capacitor plugin File picker - Pick files, images, videos, and directories","archived":false,"fork":false,"pushed_at":"2026-01-31T22:48:37.000Z","size":115,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-01T10:27:33.322Z","etag":null,"topics":["capacitor-plugin","capacitorjs"],"latest_commit_sha":null,"homepage":"https://capgo.app","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-12-16T03:27:43.000Z","updated_at":"2026-01-31T22:48:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Cap-go/capacitor-file-picker","commit_stats":null,"previous_names":["cap-go/capacitor-file-picker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-file-picker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-file-picker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-file-picker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-file-picker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-file-picker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-file-picker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-file-picker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29122350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-05T10:47:47.471Z","status":"ssl_error","status_checked_at":"2026-02-05T10:45:08.119Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor-plugin","capacitorjs"],"created_at":"2026-01-26T13:00:21.332Z","updated_at":"2026-02-05T13:00:51.362Z","avatar_url":"https://github.com/Cap-go.png","language":"Java","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":["Capgo Capacitor Plugins","[Capgo plugins](https://capgo.app/)"],"sub_categories":["Storage \u0026 Files"],"readme":"# @capgo/capacitor-file-picker\n \u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_file_picker\"\u003e ➡️ Get Instant updates for your App with Capgo\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_file_picker\"\u003e Missing a feature? We'll build the plugin for you 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nFile picker Capacitor plugin - Pick files, images, videos, and directories\n\n## Why Capacitor File Picker?\n\nA comprehensive file picker plugin with **full native support** for iOS and Android:\n\n- **Pick Files** - Select any file type with MIME type filtering\n- **Pick Images** - Native photo library picker with multi-select\n- **Pick Videos** - Native video picker with duration and dimensions\n- **Pick Media** - Combined image and video picker\n- **Pick Directory** - Select folders (Android/iOS)\n- **HEIC to JPEG** - Convert HEIC images to JPEG (iOS only)\n- **Copy Files** - Copy files to new locations\n- **File Metadata** - Get size, dimensions, duration, and more\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/file-picker/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-file-picker\nnpx cap sync\n```\n\n## Requirements\n\n- iOS: iOS 15.0+\n- Android: API 24+ (Android 7.0+)\n- Web: Modern browsers with File API support\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`pickFiles(...)`](#pickfiles)\n* [`pickImages(...)`](#pickimages)\n* [`pickVideos(...)`](#pickvideos)\n* [`pickMedia(...)`](#pickmedia)\n* [`pickDirectory()`](#pickdirectory)\n* [`convertHeicToJpeg(...)`](#convertheictojpeg)\n* [`copyFile(...)`](#copyfile)\n* [`checkPermissions()`](#checkpermissions)\n* [`requestPermissions()`](#requestpermissions)\n* [`addListener('pickerDismissed', ...)`](#addlistenerpickerdismissed-)\n* [`removeAllListeners()`](#removealllisteners)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nCapacitor File Picker Plugin interface for selecting files, images, videos, and directories.\n\n### pickFiles(...)\n\n```typescript\npickFiles(options?: PickFilesOptions | undefined) =\u003e Promise\u003cPickFilesResult\u003e\n```\n\nPick one or more files from the device.\n\n| Param         | Type                                                          | Description                 |\n| ------------- | ------------------------------------------------------------- | --------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#pickfilesoptions\"\u003ePickFilesOptions\u003c/a\u003e\u003c/code\u003e | - Options for picking files |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pickfilesresult\"\u003ePickFilesResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### pickImages(...)\n\n```typescript\npickImages(options?: PickMediaOptions | undefined) =\u003e Promise\u003cPickFilesResult\u003e\n```\n\nPick one or more images from the gallery.\nAndroid/iOS only.\n\n| Param         | Type                                                          | Description                  |\n| ------------- | ------------------------------------------------------------- | ---------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#pickmediaoptions\"\u003ePickMediaOptions\u003c/a\u003e\u003c/code\u003e | - Options for picking images |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pickfilesresult\"\u003ePickFilesResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### pickVideos(...)\n\n```typescript\npickVideos(options?: PickMediaOptions | undefined) =\u003e Promise\u003cPickFilesResult\u003e\n```\n\nPick one or more videos from the gallery.\nAndroid/iOS only.\n\n| Param         | Type                                                          | Description                  |\n| ------------- | ------------------------------------------------------------- | ---------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#pickmediaoptions\"\u003ePickMediaOptions\u003c/a\u003e\u003c/code\u003e | - Options for picking videos |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pickfilesresult\"\u003ePickFilesResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### pickMedia(...)\n\n```typescript\npickMedia(options?: PickMediaOptions | undefined) =\u003e Promise\u003cPickFilesResult\u003e\n```\n\nPick one or more images or videos from the gallery.\nAndroid/iOS only.\n\n| Param         | Type                                                          | Description                 |\n| ------------- | ------------------------------------------------------------- | --------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#pickmediaoptions\"\u003ePickMediaOptions\u003c/a\u003e\u003c/code\u003e | - Options for picking media |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pickfilesresult\"\u003ePickFilesResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### pickDirectory()\n\n```typescript\npickDirectory() =\u003e Promise\u003cPickDirectoryResult\u003e\n```\n\nPick a directory from the device.\nAndroid/iOS only.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pickdirectoryresult\"\u003ePickDirectoryResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### convertHeicToJpeg(...)\n\n```typescript\nconvertHeicToJpeg(options: ConvertHeicToJpegOptions) =\u003e Promise\u003cConvertHeicToJpegResult\u003e\n```\n\nConvert a HEIC image to JPEG format.\niOS only.\n\n| Param         | Type                                                                          | Description                  |\n| ------------- | ----------------------------------------------------------------------------- | ---------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#convertheictojpegoptions\"\u003eConvertHeicToJpegOptions\u003c/a\u003e\u003c/code\u003e | - Options for the conversion |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#convertheictojpegresult\"\u003eConvertHeicToJpegResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### copyFile(...)\n\n```typescript\ncopyFile(options: CopyFileOptions) =\u003e Promise\u003cvoid\u003e\n```\n\nCopy a file to a new location.\n\n| Param         | Type                                                        | Description                    |\n| ------------- | ----------------------------------------------------------- | ------------------------------ |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#copyfileoptions\"\u003eCopyFileOptions\u003c/a\u003e\u003c/code\u003e | - Options for copying the file |\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### checkPermissions()\n\n```typescript\ncheckPermissions() =\u003e Promise\u003cPermissionStatus\u003e\n```\n\nCheck permissions for reading files.\nAndroid only.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#permissionstatus\"\u003ePermissionStatus\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### requestPermissions()\n\n```typescript\nrequestPermissions() =\u003e Promise\u003cPermissionStatus\u003e\n```\n\nRequest permissions for reading files.\nAndroid only.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#permissionstatus\"\u003ePermissionStatus\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### addListener('pickerDismissed', ...)\n\n```typescript\naddListener(eventName: 'pickerDismissed', listenerFunc: PickerDismissedListener) =\u003e Promise\u003cPluginListenerHandle\u003e\n```\n\nAdd a listener for the picker dismissed event.\niOS only.\n\n| Param              | Type                                                                        | Description             |\n| ------------------ | --------------------------------------------------------------------------- | ----------------------- |\n| **`eventName`**    | \u003ccode\u003e'pickerDismissed'\u003c/code\u003e                                              | - The event name        |\n| **`listenerFunc`** | \u003ccode\u003e\u003ca href=\"#pickerdismissedlistener\"\u003ePickerDismissedListener\u003c/a\u003e\u003c/code\u003e | - The listener function |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() =\u003e Promise\u003cvoid\u003e\n```\n\nRemove all listeners for this plugin.\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 8.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### PickFilesResult\n\nResult of picking files.\n\n| Prop        | Type                      | Description           |\n| ----------- | ------------------------- | --------------------- |\n| **`files`** | \u003ccode\u003ePickedFile[]\u003c/code\u003e | Array of picked files |\n\n\n#### PickedFile\n\nRepresents a picked file.\n\n| Prop             | Type                | Description                                                             |\n| ---------------- | ------------------- | ----------------------------------------------------------------------- |\n| **`name`**       | \u003ccode\u003estring\u003c/code\u003e | The name of the file                                                    |\n| **`path`**       | \u003ccode\u003estring\u003c/code\u003e | The path to the file                                                    |\n| **`mimeType`**   | \u003ccode\u003estring\u003c/code\u003e | The MIME type of the file                                               |\n| **`size`**       | \u003ccode\u003enumber\u003c/code\u003e | The size of the file in bytes                                           |\n| **`data`**       | \u003ccode\u003estring\u003c/code\u003e | The base64 encoded data of the file. Only present if readData was true. |\n| **`blob`**       | \u003ccode\u003eBlob\u003c/code\u003e   | The Blob instance of the file. Web only.                                |\n| **`width`**      | \u003ccode\u003enumber\u003c/code\u003e | Width in pixels (images/videos only)                                    |\n| **`height`**     | \u003ccode\u003enumber\u003c/code\u003e | Height in pixels (images/videos only)                                   |\n| **`duration`**   | \u003ccode\u003enumber\u003c/code\u003e | Duration in seconds (videos only)                                       |\n| **`modifiedAt`** | \u003ccode\u003enumber\u003c/code\u003e | Last modified timestamp in milliseconds                                 |\n\n\n#### PickFilesOptions\n\nOptions for picking files.\n\n| Prop           | Type                  | Description                                                                                                                                         | Default            |\n| -------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |\n| **`types`**    | \u003ccode\u003estring[]\u003c/code\u003e | List of accepted MIME types or file extensions. On iOS, only MIME types are supported. Examples: ['image/*'], ['application/pdf'], ['.pdf', '.doc'] |                    |\n| **`limit`**    | \u003ccode\u003enumber\u003c/code\u003e   | Maximum number of files to pick. Set to 0 for unlimited (platform default).                                                                         | \u003ccode\u003e0\u003c/code\u003e     |\n| **`readData`** | \u003ccode\u003eboolean\u003c/code\u003e  | Whether to read the file data as base64. Note: Reading large files may cause memory issues.                                                         | \u003ccode\u003efalse\u003c/code\u003e |\n\n\n#### PickMediaOptions\n\nOptions for picking media (images/videos).\n\n| Prop                  | Type                 | Description                                                                                 | Default            |\n| --------------------- | -------------------- | ------------------------------------------------------------------------------------------- | ------------------ |\n| **`limit`**           | \u003ccode\u003enumber\u003c/code\u003e  | Maximum number of files to pick. Set to 0 for unlimited (platform default).                 | \u003ccode\u003e0\u003c/code\u003e     |\n| **`readData`**        | \u003ccode\u003eboolean\u003c/code\u003e | Whether to read the file data as base64. Note: Reading large files may cause memory issues. | \u003ccode\u003efalse\u003c/code\u003e |\n| **`skipTranscoding`** | \u003ccode\u003eboolean\u003c/code\u003e | iOS only: Skip transcoding of videos.                                                       | \u003ccode\u003efalse\u003c/code\u003e |\n| **`ordered`**         | \u003ccode\u003eboolean\u003c/code\u003e | iOS 15+ only: Show ordered selection badges.                                                | \u003ccode\u003efalse\u003c/code\u003e |\n\n\n#### PickDirectoryResult\n\nResult of picking a directory.\n\n| Prop       | Type                | Description                        |\n| ---------- | ------------------- | ---------------------------------- |\n| **`path`** | \u003ccode\u003estring\u003c/code\u003e | The path to the selected directory |\n\n\n#### ConvertHeicToJpegResult\n\nResult of HEIC to JPEG conversion.\n\n| Prop       | Type                | Description                         |\n| ---------- | ------------------- | ----------------------------------- |\n| **`path`** | \u003ccode\u003estring\u003c/code\u003e | The path to the converted JPEG file |\n\n\n#### ConvertHeicToJpegOptions\n\nOptions for converting HEIC to JPEG.\n\n| Prop          | Type                | Description                                   | Default          |\n| ------------- | ------------------- | --------------------------------------------- | ---------------- |\n| **`path`**    | \u003ccode\u003estring\u003c/code\u003e | The path to the HEIC file to convert          |                  |\n| **`quality`** | \u003ccode\u003enumber\u003c/code\u003e | The compression quality for JPEG (0.0 - 1.0). | \u003ccode\u003e0.9\u003c/code\u003e |\n\n\n#### CopyFileOptions\n\nOptions for copying a file.\n\n| Prop            | Type                 | Description                                 | Default            |\n| --------------- | -------------------- | ------------------------------------------- | ------------------ |\n| **`from`**      | \u003ccode\u003estring\u003c/code\u003e  | Source file path                            |                    |\n| **`to`**        | \u003ccode\u003estring\u003c/code\u003e  | Destination file path                       |                    |\n| **`overwrite`** | \u003ccode\u003eboolean\u003c/code\u003e | Whether to overwrite if destination exists. | \u003ccode\u003efalse\u003c/code\u003e |\n\n\n#### PermissionStatus\n\nPermission status for file access.\n\n| Prop                      | Type                                                        | Description                                            |\n| ------------------------- | ----------------------------------------------------------- | ------------------------------------------------------ |\n| **`readExternalStorage`** | \u003ccode\u003e\u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e\u003c/code\u003e | Whether permission to read media files is granted      |\n| **`accessMediaLocation`** | \u003ccode\u003e\u003ca href=\"#permissionstate\"\u003ePermissionState\u003c/a\u003e\u003c/code\u003e | Whether permission to access media location is granted |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\n### Type Aliases\n\n\n#### PermissionState\n\n\u003ccode\u003e'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'\u003c/code\u003e\n\n\n#### PickerDismissedListener\n\nListener callback for picker dismissed event.\n\n\u003ccode\u003e(event: null): void\u003c/code\u003e\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-file-picker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCap-go%2Fcapacitor-file-picker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCap-go%2Fcapacitor-file-picker/lists"}