flutter_file_picker 0.0.3

flutter_document_picker #

Allows user pick a document. Picked document is copied to app temporary directory. Optionally allows pick document with specific extension only.

When file is picked its extension is checked using allowedFileExtensions parameter. Then file is copied to app temp directory. Copied file path is returned as result. If picked file extension is not in allowedFileExtensions list then extension_mismatch error is returned.

In Android Intent.ACTION_OPEN_DOCUMENT is used. This intent is supported only from Android 19 (KitKat) SDK version. So this plugin can be used only if app minSdkVersion is 19 or more.

In iOS UIDocumentPickerViewController is used. Files can be filtered by list of UTI types using allowedUtiTypes parameter. Picked file path is returned as result.

Params #

Plugin has 3 optional parameters to help pick only specific document type:

  • List<String> allowedUtiTypes (used only in iOS)

    In iOS Uniform Type Identifiers is used to check document types. If list is null or empty "public.data" document type will be provided. Only documents with provided UTI types will be enabled in iOS document picker.

    More info: https://developer.apple.com/library/archive/qa/qa1587/_index.html

  • List<String> allowedFileExtensions (used both in iOS and in Android)

    List of file extensions that picked file should have. If list is null or empty - picked document extension will not be checked.

  • List<String> allowedMimeTypes (used only in Android)

    Only files with provided MIME types will be shown in document picker. If list is null or empty - */* MIME type will be used.

  • List<String> invalidFileNameSymbols (used both in iOS and in Android)

    List symbols that will be sanitized to "_" in the selected document name. I.e. Google Drive allows symbol '/' in the document name, but this symbol is not allowed in file name that will be saved locally.

    Default list: ['/'].

    Example: file name 'Report_2018/12/08.txt' will be replaced to 'Report_2018_12_08.txt'

Example #

//Without parameters:
final path = await FlutterDocumentPicker.openDocument();
  
  ...

    
//With parameters:
FlutterDocumentPickerParams params = FlutterDocumentPickerParams(      
  allowedFileExtensions: ['mwfbak'],
  allowedUtiTypes: ['com.sidlatau.example.mwfbak'],
  allowedMimeTypes: ['application/*'],
  invalidFileNameSymbols: ['/'],
);

final path = await FlutterDocumentPicker.openDocument(params: params);

Getting Started #

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

For help on editing plugin code, view the documentation.

3.0.0 #

  • Added ability to filter by multiple MIME types in Android.

BREAKING:

allowedMimeType parameter is replaced with allowedMimeTypes.

MIGRATION:

Just change allowedMimeType: 'value' to array allowedMimeTypes: ['value']

2.0.0 #

  • Migrated to Android X.

1.4.0 #

  • Updated to work with Android Studio 3.3.

1.3.0 #

  • Updated Swift version to 4.2.

1.2.0 #

  • Added ability to sanitize selected document name (Issue #17).

1.1.3 #

  • Updated Gradle, Kotlin, target SDK versions to latest ones.

1.1.2 #

  • Updated Gradle, Kotlin, target SDK versions to latest ones (Issue #11).

1.1.1 #

  • Fixed bug when plugin reacted to not its own request codes (Issue #6). Special thanks to @acheronian for spotting the issue!

1.1.0 #

  • Added allowedMimeType parameter to filter files by MIME type in Android.

1.0.1 #

  • Fixed bug when small file got corrupted after copying (Issue #3). Special thanks to @przemyslawsikora for spotting the issue!

1.0.0 #

  • Changed API to support list of allowed file extensions and UTI's.

0.1.1 #

  • Android part: Not needed logging removed.

0.1.0 #

  • iOS part: picked document is copied to temp dir.

0.0.3 #

  • Removed print statements.

0.0.2 #

  • Fixed documentation.

0.0.1 #

  • Initial version that works on Android and iOS. Has ability to filter file to pick by extension.

example/README.md

flutter_document_picker_example #

Demonstrates how to use the flutter_document_picker plugin.

Getting Started #

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

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_file_picker: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_file_picker/flutter_document_picker.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
41
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
68
Learn more about scoring.

We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8

Admin