README.md

capacitor-plugin-file-picker

Capacitor plugin to pick files

Install (Capacitor 6.x)

npm install @whiteguru/capacitor-plugin-file-picker
npx cap sync

Capacitor 5.x

npm install @whiteguru/capacitor-plugin-file-picker@^5.0.1
npx cap sync

Capacitor 4.x

npm install @whiteguru/capacitor-plugin-file-picker@^4.0.1
npx cap sync

Capacitor 3.x

npm install @whiteguru/capacitor-plugin-file-picker@3.0.1
npx cap sync

API

• pick(...)
• pickImages(...)
• pickVideos(...)
• pickFiles(...)
• Interfaces

pick(...)

pick(options: FilePickerOptions) => Promise<FilePickerResults>

Param	Type
options	FilePickerOptions

Returns: Promise<FilePickerResults>

---

pickImages(...)

pickImages(options?: FilePickerCommonOptions | undefined) => Promise<FilePickerResults>

Param	Type
options	FilePickerCommonOptions

Returns: Promise<FilePickerResults>

---

pickVideos(...)

pickVideos(options?: FilePickerCommonOptions | undefined) => Promise<FilePickerResults>

Param	Type
options	FilePickerCommonOptions

Returns: Promise<FilePickerResults>

---

pickFiles(...)

pickFiles(options?: FilePickerCommonOptions | undefined) => Promise<FilePickerResults>

Param	Type
options	FilePickerCommonOptions

Returns: Promise<FilePickerResults>

---

Interfaces

FilePickerResults

Prop	Type
files	FilePickerResult[]

FilePickerResult

Prop	Type	Description
path	string	File Path
webPath	string	webPath returns a path that can be used to set the src attribute of an image for efficient loading and rendering.
name	string	File Name
extension	string	File Extensions

FilePickerOptions

Prop	Type
mimes	string[]

FilePickerCommonOptions

Prop	Type	Description	Default
multiple	boolean	Select multiple Files	false
limit	number	Maximum number of files to select