file_picker_plus

Flutter plugin for selecting files from the Android and iOS file library, and taking new pictures with the camera.

Using

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile and web development, and a full API reference.

Installation

First, add file_picker_plus as a dependency in your pubspec.yaml file.

In your flutter project add the dependency:

dependencies:
  ...
  file_picker_plus:

For help getting started with Flutter, view the online documentation.

Setup Configuration

Please check if use cameraPicker image_picker with image crop functionality image_cropper.
Please check if use imagePicker image_picker with image crop functionality image_cropper.
Please check if use filePicker file_picker.
Please check if use viewFile open_filex or open_share_pro.

Android

The Android implementation support to pick (multiple) images on Android 4.3 or higher.

If use image crop functionality, Add UCropActivity into your AndroidManifest.xml More info please check image_cropper.

<activity
    android:name="com.yalantis.ucrop.UCropActivity"
    android:screenOrientation="portrait"
    android:theme="@style/Theme.AppCompat.Light.NoActionBar"/>

Note: From v1.2.0, you need to migrate your android project to v2 embedding (detail)

No configuration required - the plugin should work out of the box. It is however highly recommended to prepare for Android killing the application when low on memory. How to prepare for this is discussed in the Handling MainActivity destruction on Android section to image_picker library. More info please check image_picker.

It is no longer required to add android:requestLegacyExternalStorage="true" as an attribute to the <application> tag in AndroidManifest.xml, as file_picker_plus has been updated to make use of scoped storage.

iOS

This plugin requires iOS 9.0 or higher.

The iOS implementation uses PHPicker to pick (multiple) images on iOS 14 or higher. As a result of implementing PHPicker it becomes impossible to pick HEIC images on the iOS simulator in iOS 14+. This is a known issue. Please test this on a real device, or test with non-HEIC images until Apple solves this issue. 63426347 - Apple known issue

Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:

NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.
NSMicrophoneUsageDescription - describe why your app needs access to the microphone, if you intend to record videos. This is called Privacy - Microphone Usage Description in the visual editor.

Web

If use image crop functionality, Add following codes inside <head> tag in file web/index.html More info please check image_cropper.

<head>
  ....

  <!-- Croppie -->
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/croppie/2.6.5/croppie.css" />
  <script defer src="https://cdnjs.cloudflare.com/ajax/libs/exif-js/2.3.0/exif.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/croppie/2.6.5/croppie.min.js"></script>

  ....
</head>

Note: file picked using the camera, gallery or file are saved to your application's local cache, and should therefore be expected to only be around temporarily. If you require your picked image to be stored permanently, it is your responsibility to move it to a more permanent location.

Example

Please follow this example here.

File Picker with default UI

FilePicker(
  context: context,
  height: 100,
  fileData: _fileData,
  crop: true,
  maxFileSizeInMb: 10,
  allowedExtensions: Files.allowedAllExtensions,
  onSelected: (fileData) {
    _fileData = fileData;
  },
  onCancel: (message, messageCode) {
    log("[$messageCode] $message");
  }
)

Camera Picker

Files.cameraPicker(
  fileData: _fileData,
  onSelected: (fileData) {
    _fileData = fileData;
  }
);

Image Picker

Files.imagePicker(
  fileData: _fileData,
  onSelected: (fileData) {
    _fileData = fileData;
  }
);

File Picker

Files.filePicker(
  fileData: _fileData,
  onSelected: (fileData) {
    _fileData = fileData;
  }
);