This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.
@capawesome/capacitor-file-picker
Capacitor plugin that allows the user to select a file.
| Maintainer | GitHub | Social |
|---|---|---|
| Robin Genz | robingenz | @robin_genz |
This is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.
npm install @capawesome/capacitor-file-picker
npx cap syncNo configuration required for this plugin.
A working example can be found here: robingenz/capacitor-plugin-demo
import { FilePicker } from '@capawesome/capacitor-file-picker';
const pickFiles = async () => {
const result = await FilePicker.pickFiles({
types: ['image/png'],
multiple: true,
});
};
const pickImages = async () => {
const result = await FilePicker.pickImages({
multiple: true,
});
};
const pickMedia = async () => {
const result = await FilePicker.pickMedia({
multiple: true,
});
};
const pickVideos = async () => {
const result = await FilePicker.pickVideos({
multiple: true,
});
};
const appendFileToFormData = async () => {
const result = await FilePicker.pickFiles();
const file = result.files[0];
const formData = new FormData();
if (file.blob) {
const rawFile = new File(file.blob, file.name, {
type: file.mimeType,
});
formData.append('file', rawFile, file.name);
}
};convertHeicToJpeg(...)pickFiles(...)pickImages(...)pickMedia(...)pickVideos(...)addListener('pickerDismissed', ...)removeAllListeners()- Interfaces
- Type Aliases
convertHeicToJpeg(options: ConvertHeicToJpegOptions) => Promise<ConvertHeicToJpegResult>Convert a HEIC image to JPEG.
Only available on iOS.
| Param | Type |
|---|---|
options |
ConvertHeicToJpegOptions |
Returns: Promise<ConvertHeicToJpegResult>
Since: 0.6.0
pickFiles(options?: PickFilesOptions | undefined) => Promise<PickFilesResult>Open the file picker that allows the user to select one or more files.
| Param | Type |
|---|---|
options |
PickFilesOptions |
Returns: Promise<PickFilesResult>
pickImages(options?: PickMediaOptions | undefined) => Promise<PickImagesResult>Pick one or more images from the gallery.
On iOS 13 and older it only allows to pick one image.
Only available on Android and iOS.
| Param | Type |
|---|---|
options |
PickMediaOptions |
Returns: Promise<PickFilesResult>
Since: 0.5.3
pickMedia(options?: PickMediaOptions | undefined) => Promise<PickMediaResult>Pick one or more images or videos from the gallery.
On iOS 13 and older it only allows to pick one image or video.
Only available on Android and iOS.
| Param | Type |
|---|---|
options |
PickMediaOptions |
Returns: Promise<PickFilesResult>
Since: 0.5.3
pickVideos(options?: PickMediaOptions | undefined) => Promise<PickVideosResult>Pick one or more videos from the gallery.
On iOS 13 and older it only allows to pick one video.
Only available on Android and iOS.
| Param | Type |
|---|---|
options |
PickMediaOptions |
Returns: Promise<PickFilesResult>
Since: 0.5.3
addListener(eventName: 'pickerDismissed', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandleCalled when the file picker is dismissed.
Only available on iOS.
| Param | Type |
|---|---|
eventName |
'pickerDismissed' |
listenerFunc |
() => void |
Returns: Promise<PluginListenerHandle> & PluginListenerHandle
Since: 0.6.2
removeAllListeners() => Promise<void>Remove all listeners for this plugin.
Since: 0.6.2
| Prop | Type | Description | Since |
|---|---|---|---|
path |
string |
The path of the converted JPEG image. | 0.6.0 |
| Prop | Type | Description | Since |
|---|---|---|---|
path |
string |
The path of the HEIC image. | 0.6.0 |
| Prop | Type |
|---|---|
files |
File[] |
| Prop | Type | Description | Since |
|---|---|---|---|
blob |
Blob |
The Blob instance of the file. Only available on Web. | |
data |
string |
The Base64 string representation of the data contained in the file. Is only provided if readData is set to true. |
|
duration |
number |
The duration of the video in seconds. Only available on Android and iOS. | 0.5.3 |
height |
number |
The height of the image or video in pixels. Only available on Android and iOS. | 0.5.3 |
mimeType |
string |
The mime type of the file. | |
modifiedAt |
number |
The last modified timestamp of the file in milliseconds. | 0.5.9 |
name |
string |
The name of the file. | |
path |
string |
The path of the file. Only available on Android and iOS. | |
size |
number |
The size of the file in bytes. | |
width |
number |
The width of the image or video in pixels. Only available on Android and iOS. | 0.5.3 |
| Prop | Type | Description | Default |
|---|---|---|---|
types |
string[] |
List of accepted file types. Look at IANA Media Types for a complete list of standard media types. This option cannot be used with multiple: true on Android. |
|
multiple |
boolean |
Whether multiple files may be selected. | false |
readData |
boolean |
Whether to read the file data. | false |
| Prop | Type | Description | Default |
|---|---|---|---|
multiple |
boolean |
Whether multiple files may be selected. | false |
readData |
boolean |
Whether to read the file data. | false |
| Prop | Type |
|---|---|
remove |
() => Promise<void> |
See CHANGELOG.md.
See LICENSE.
