fc_file_picker_util 0.8.0 fc_file_picker_util: ^0.8.0 copied to clipboard
File pickers based on file_selector.
fc_file_picker_util #
Windows | macOS | iOS | Android | |
---|---|---|---|---|
Pick files | ✅ (Name / Path) | ✅ (Name / Path / URL) | ✅ (Name / Path / URL) | ✅ (Uri) |
Pick a folder | ✅ (Name / Path) | ✅ (Name / Path / URL) | ✅ (Name / Path / URL) | ✅ (Uri) |
Pick a save path | ✅ (Name / Path) | ✅ (Name / Path / URL) | ❌ | ❌ |
fc_file_picker_util
is based on file_selector with the following differences:
- On iOS and macOS, it returns both URL and path for files and folders.
- On Android:
- When picking files: instead of copying the file to a temporary location, it returns file SAF Uri directly.
- When picking folder: it returns an SAF Uri.
- To access the SAF Uri-based files or folders, use my other packages: saf_stream and saf_util.
Usage #
macOS #
You need to add the following key to entitlements in order for macOS app to be able to access file system:
<key>com.apple.security.files.user-selected.read-write</key>
<true/>
FcFilePickerPath
#
Since fc_file_picker_util
can return path or URI or both, the result is wrapped in FcFilePickerPath
:
class FcFilePickerPath {
final String name;
final String? path;
final String? uri;
}
Pick a file or multiple files #
/// Picks a file and return a [FcFilePickerPath].
final file = await FcFilePickerUtil.pickFile();
/// Picks multiple files and return a list of [FcFilePickerPath].
final files = await FcFilePickerUtil.pickMultipleFiles();
Pick a folder #
/// Picks a folder and return a [FcFilePickerPath].
///
/// [writePermission] is only applicable on Android.
final folder = await FcFilePickerUtil.pickFolder(writePermission: true);
Pick a save path #
It's recommended to use mobile share menu to save files.
/// Picks a save file location and return a [String] path.
/// You can optionally specify a default file name via [defaultName].
final savePath = await FcFilePickerUtil.pickSaveFile();