Awesome

⚠️ Deprecated repository

This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.

Maintainers

Sponsors

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.

Installation

npm install @capawesome/capacitor-file-picker
npx cap sync

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

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);
  }
};

API

• convertHeicToJpeg(...)
• pickFiles(...)
• pickImages(...)
• pickMedia(...)
• pickVideos(...)
• addListener('pickerDismissed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

convertHeicToJpeg(...)

convertHeicToJpeg(options: ConvertHeicToJpegOptions) => Promise<ConvertHeicToJpegResult>

Convert a HEIC image to JPEG.

Only available on iOS.

Returns: <code>Promise<<a href="#convertheictojpegresult">ConvertHeicToJpegResult</a>></code>

Since: 0.6.0

pickFiles(...)

pickFiles(options?: PickFilesOptions | undefined) => Promise<PickFilesResult>

Open the file picker that allows the user to select one or more files.

Returns: <code>Promise<<a href="#pickfilesresult">PickFilesResult</a>></code>

pickImages(...)

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.

Returns: <code>Promise<<a href="#pickfilesresult">PickFilesResult</a>></code>

Since: 0.5.3

pickMedia(...)

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.

Returns: <code>Promise<<a href="#pickfilesresult">PickFilesResult</a>></code>

Since: 0.5.3

pickVideos(...)

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.

Returns: <code>Promise<<a href="#pickfilesresult">PickFilesResult</a>></code>

Since: 0.5.3

addListener('pickerDismissed', ...)

addListener(eventName: 'pickerDismissed', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Called when the file picker is dismissed.

Only available on iOS.

Returns: <code>Promise<<a href="#pluginlistenerhandle">PluginListenerHandle</a>> & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

Since: 0.6.2

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 0.6.2

Interfaces

ConvertHeicToJpegResult

ConvertHeicToJpegOptions

PickFilesResult

File

PickFilesOptions

PickMediaOptions

PluginListenerHandle

Type Aliases

PickedFile

<code><a href="#file">File</a></code>

PickImagesOptions

<code><a href="#pickmediaoptions">PickMediaOptions</a></code>

PickImagesResult

<code><a href="#pickmediaresult">PickMediaResult</a></code>

PickMediaResult

<code><a href="#pickfilesresult">PickFilesResult</a></code>

PickVideosOptions

<code><a href="#pickmediaoptions">PickMediaOptions</a></code>

PickVideosResult

<code><a href="#pickmediaresult">PickMediaResult</a></code>

Changelog

See CHANGELOG.md.

License

See LICENSE.