macos_file_picker 0.2.0 macos_file_picker: ^0.2.0 copied to clipboard
Opens native macOS dialogs to pick files or folders.
Opens native macOS dialogs to pick files or folders. Features:
- Pick a single or multiple files, folders and both.
- Pick a file to save.
Usage #
/// Opens a macOS dialog based on the given arguments.
///
/// [mode]:
/// file: pick files.
/// folder: pick folders.
/// fileAndFolder: pick files and folders.
/// saveFile: pick a file saving path.
///
/// [allowsMultiple] when true, allows multiple selection. Default: false.
/// [defaultName] default file name for save dialog.
///
/// Return value:
/// [null]: dialog closed / cancelled.
/// A list of [MacosFilePickerPath] representing a platform path.
/// When [allowsMultiple] is false, the list should only has one item.
Future<List<MacosFilePickerPath>?> pick(MacosFilePickerMode mode,
{String? defaultName, bool? allowsMultiple});
Example #
final _macosFilePickerPlugin = MacosFilePicker();
Future<void> _openDialog() async {
// Pick a single file path.
var result = await _macosFilePickerPlugin.pick(_mode,
allowsMultiple: _allowsMultiple);
setState(() {
_output = result == null ? 'Cancelled' : result.toString();
});
}