A package that allows you to use a native file explorer to pick single or multiple absolute file paths, with extensions filtering support.
First, add file_picker as a dependency in your pubspec.yaml file.
<application> to your app's
AndroidManifest.xml file. This is required to access files from external storage.
Based on the location of the files that you are willing to pick paths, you may need to add some keys to your iOS app's Info.plist file, located in
UIBackgroundModes with the fetch and remote-notifications keys - Required if you'll be using the
FileType.CUSTOM. Describe why your app needs to access background taks, such downloading files (from cloud services). This is called Required background modes, with the keys App download content from network and App downloads content in response to push notifications respectively in the visual editor (since both methods aren't actually overriden, not adding this property/keys may only display a warning, but shouldn't prevent its correct usage).
<key>UIBackgroundModes</key> <array> <string>fetch</string> <string>remote-notification</string> </array>
NSAppleMusicUsageDescription - Required if you'll be using the
FileType.AUDIO. Describe why your app needs permission to access music library. This is called Privacy - Media Library Usage Description in the visual editor.
<key>NSAppleMusicUsageDescription</key> <string>Explain why your app uses music</string>
NSPhotoLibraryUsageDescription - Required if you'll be using the
FileType.VIDEO. Describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
<key>NSPhotoLibraryUsageDescription</key> <string>Explain why your app uses photo library</string>
Note: Any iOS version below 11.0, will require an Apple Developer Program account to enable CloudKit and make it possible to use the document picker (which happens when you select
FileType.CUSTOM or any other option with
getMultiFilePath()). You can read more about it here.
There are only two methods that should be used with this package:
Will let you pick a single file. This receives two optional parameters: the
fileType for specifying the type of the picker and a
fileExtension parameter to filter selectable files. The available filters are:
FileType.ANY- Will let you pick all available files.
FileType.CUSTOM- Will let you pick a single path for the extension matching the
FileType.IMAGE- Will let you pick a single image file. Opens gallery on iOS.
FileType.VIDEO- WIll let you pick a single video file. Opens gallery on iOS.
FileType.AUDIO- Will let you pick a single audio file. Opens music on iOS. Note that DRM protected files won't provide a path,
nullwill be returned instead.
Will let you select multiple files and retrieve its path at once. Optionally you can provide a
fileExtension parameter to filter the allowed selectable files.
Will return a
Map<String,String> with the files name (
key) and corresponding path (
value) of all selected files.
Picking multiple paths from iOS gallery (image and video) aren't currently supported.
So, a few example usages can be as follow:
// Single file path String filePath; filePath = await FilePicker.getFilePath(type: FileType.ANY); // will let you pick one file path, from all extensions filePath = await FilePicker.getFilePath(type: FileType.CUSTOM, fileExtension: 'svg'); // will filter and only let you pick files with svg extension // Pick a single file directly File file = await FilePicker.getFile(type: FileType.ANY); // will return a File object directly from the selected file // Multi file path Map<String,String> filesPaths; filePaths = await FilePicker.getMultiFilePath(); // will let you pick multiple files of any format at once filePaths = await FilePicker.getMultiFilePath(fileExtension: 'pdf'); // will let you pick multiple pdf files at once filePaths = await FilePicker.getMultiFilePath(type: FileType.IMAGE); // will let you pick multiple image files at once List<String> allNames = filePaths.keys; // List of all file names List<String> allPaths = filePaths.values; // List of all paths String someFilePath = filePaths['fileName']; // Access a file path directly by its name (matching a key)
A few side notes
getMultiFilePath()on iOS will always use the document picker (aka Files app). This means that multi picks are not currently supported for photo library images/videos or music library files.
- When using
FileType.CUSTOM, unsupported extensions will throw a
MissingPluginExceptionthat is handled by the plugin.
- On Android, when available, you should avoid using third-party file explorers as those may prevent file extension filtering (behaving as
FileType.ANY). In this scenario, you will need to validate it on return.
Currently supported features
XLoad paths from cloud files (GDrive, Dropbox, iCloud)
XLoad path from a custom format by providing a file extension (pdf, svg, zip, etc.)
XLoad path from multiple files optionally, supplying a file extension
XLoad path from gallery
XLoad path from audio
XLoad path from video
XLoad path from any
Fileobject from any selected file
If you have any feature that you want to see in this package, please add it here. 🎉
See example app.
For help getting started with Flutter, view our online documentation.
For help on editing plugin code, view the documentation.