File Picker #
A package that allows you to use a native file explorer to pick single or multiple absolute file paths, with extensions filtering support.
Currently supported features #
- Load paths from cloud files (GDrive, Dropbox, iCloud)
- Load path from a custom format by providing a list of file extensions (pdf, svg, zip, etc.)
- Load path from multiple files optionally, supplying file extensions
- Load path from gallery
- Load path from audio
- Load path from video
- Load path from any
- Create a
List<File>objects from any selected file(s)
- Supports desktop through go-flutter (MacOS, Windows, Linux)
If you have any feature that you want to see in this package, please add it here. 🎉
See the File Picker Wiki for every detail on about how to install, setup and use it.
Quick simple usage example:
File file = await FilePicker.getFile();
List<File> files = await FilePicker.getMultiFile();
Multiple files with extension filter
List<File> files = await FilePicker.getMultiFile( type: FileType.custom, allowedExtensions: ['jpg', 'pdf', 'doc'], );
For full usage details refer to the Wiki above.
Example App #
Getting Started #
For help getting started with Flutter, view our online documentation.
For help on editing plugin code, view the documentation.
- Updates GO (Desktop) to support multiple extension filters.
- Addresses an issue that could result in permission handler resolving requests from other activities.
- Adds multiple file extension filter support. From now on, you must provide a
Listof extensions with type
FileType.customwhen restricting types while picking.
- Other minor improvements;
- iOS: Fixes an issue that could result in a crash when selecting files (with repeated taps) from 3rd party remote providers (Google Drive, Dropbox etc.);
- Go: Updates channel name;
- Adds check that ensures that you one uses
FileType.customwhen providing a custom file extension filter;
- Updates channel name on iOS.
- Adds temporary workaround for (#49365)(https://github.com/flutter/flutter/issues/49365) until 1.14.6 lands on stable channel.
- Breaking change: Refactored
FileTypeto match lower camelCase Dart guideline (eg.
- Added support for new Android plugins APIs (Android V2 embedding);
Removes checked flutter_export_environment.sh from example app.
- Fixes an issue that could result in a crash when tapping multiple times in the same media file while picking, on some iOS devices (#171).
Updates go-flutter dependencies.
- Fixes an issue that could cause a crash when picking video files in iOS 13 or above due to SDK changes.
- Updates Go-Flutter with go 1.13.
Bug fix: Fixes an issue that could result in some cached files, picked from Google Photos (remote file), to have the name set as
Bug fix: Fixes an issue that could prevent internal storage files from being properly picked.
- Adds Desktop support throught go-flutter, you can see detailed instructions on how to get in runing here.
- Adds Desktop example, to run it just do
hover initand then
hover runwithin the plugin's example folder (you must have go and hover installed, check the previous point).
- Similar to
getFile, now there is also a
getMultiFilewhich behaves the same way, but returning a list of files instead.
- Updates Android SDK deprecated code.
- Sometimes when a big file was being picked from a remote directory (GDrive for example), the UI could be blocked. Now this shouldn't happen anymore.
Bug fix: Fixes an issue that could cause a crash when picking files with very long names.
Changes: Updates Android target API to 29.
Rollback - Breaking change: Re-adds runtime verification for external storage read permission. Don't forget to add the permission to the
AndroidManifest.xml file as well. More info in the README file.
Bug fix: Fixes a crash that could cause some Android API to crash when multiple files were selected from external storage.
- Removes the Android write permissions requirement.
- Minor improvements in the example app.
- Now the exceptions are rethrown in case the user wants to handle them, despite that already being done in the plugin call.
Bug fix: Fixes an issue that could prevent users to pick files from the iCloud Drive app, on versions below iOS 11.
Rollback: Removes a local dependency that shouldn't have been committed with
1.3.4 which would cause Android build to fail.
Bug fix: Protects the
registrar.activity() in the Android side of being accessed when it's
- Fixes an issue where sometimes a single file path was being returned as a
requestCodein Android intents are now restricted to 16 bits.
Bug fix: Returns a
null value in the
getFile() when the picker is canceled.
Bug fix: Fixes an issue on Android, where other activity would try to call
FilePicker's result object when it shouldn't.
FileType.CAMERAis no longer available, if you need it, you can use this package along with image_picker.
- You can now pick multiple files by using the
getMultiFilePath()method which will return a
Map<String,String>with all paths from selected files, where the key matches the file name and the value its path. Optionally, it also supports filtering by file extension, otherwise all files will be selectable. Nevertheless, you should keep using
getFilePath()for single path picking.
- You can now use
FileType.AUDIOto pick audio files. In iOS this will let you select from your music library. Paths from DRM protected files won't be loaded (see README for more details).
getFile()utility method that does the same of
getFilePath()but returns a
Fileobject instead, for the returned path.
Bug fixes and updates
- This package is no longer attached to the image_picker, and because of that, camera permission is also no longer required.
- Fixes an issue where sometimes the InputStream wasn't being properly closed. Also, its exception is now being forward to the plugin caller.
- Fixes an issue where the picker, when canceled, wasn't calling the result callback on the underlying platforms.
Breaking change: Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library.
- Updates README file.
FileType.PDFwas removed since now it can be used along with custom file types by using the
FileType.CUSTOMand providing the file extension (e.g. PDF, SVG, ZIP, etc.).
- Now it is possible to provide a custom file extension to filter file picking options by using
Bug fixes and updates
- Fixes file names from cloud on Android. Previously it would always display Document
- Fixes an issue on iOS where an exception was being thrown after canceling and re-opening the picker.
- Fixes an issue where collision could happen with request codes on Android.
- Adds public documentation to
- Example app updated.
- Updates .gitignore
- Minor update of README file.
- Adds comments for public API
- Version 1.0 release.
- Adds support for ANY and VIDEO files.
- Fixes an issue where permissions were recursively asked on Android.
- Fixes an issue where some paths from document files couldn't be loaded with Android 8.0.
- Updates README file to match changes.
- General refactor & cleanup.
- Replaces commons dependency with FilePath class on Android, to handle path resolution on different SDK.
- Minor correction in the README file.
- Changed Meta minimum version due to versioning conflict with flutter_localization.
- Updated readme.
- Changed license from Apache 2.0 to MIT.
- Adds demo screenshot.
- Adds license information (Apache 2.0).
- Adds CHANGELOG details.
- Initial release.
- Supports picking paths from files on local storage, cloud.
- Supports picking paths from both gallery & camera due to image_picker dependency.
import 'package:file_picker_example/src/file_picker_demo.dart'; import 'package:flutter/widgets.dart'; void main() => runApp(new FilePickerDemo());
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: file_picker: ^1.6.2
2. Install it
You can install packages from the command line:
$ 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:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Apr 8, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.7.1
- pana: 0.13.6
- Flutter: 1.12.13+hotfix.8