A Flutter plugin that manages files and interactions with file dialogs.
| Android | iOS | Linux | macOS | Web | Windows | |
|---|---|---|---|---|---|---|
| Support | SDK 24+ | iOS 15+ | Any | 12+ | Any | Windows 10+ |
You will need to add an entitlement for either read-only access:
<key>com.apple.security.files.user-selected.read-only</key>
<true/>or read/write access:
<key>com.apple.security.files.user-selected.read-write</key>
<true/>depending on your use case.
Here are small examples that show you how to use the API. Please also take a look at our example app.
const typeGroup = XTypeGroup(
label: 'images',
extensions: <String>['jpg', 'png'],
uniformTypeIdentifiers: <String>['public.jpeg', 'public.png'],
);
final XFile? file = await openFile(acceptedTypeGroups: <XTypeGroup>[typeGroup]);const jpgsTypeGroup = XTypeGroup(
label: 'JPEGs',
extensions: <String>['jpg', 'jpeg'],
uniformTypeIdentifiers: <String>['public.jpeg'],
);
const pngTypeGroup = XTypeGroup(
label: 'PNGs',
extensions: <String>['png'],
uniformTypeIdentifiers: <String>['public.png'],
);
final List<XFile> files = await openFiles(
acceptedTypeGroups: <XTypeGroup>[jpgsTypeGroup, pngTypeGroup],
);const fileName = 'suggested_name.txt';
final FileSaveLocation? result = await getSaveLocation(suggestedName: fileName);
if (result == null) {
// Operation was canceled by the user.
return;
}
final fileData = Uint8List.fromList('Hello World!'.codeUnits);
const mimeType = 'text/plain';
final textFile = XFile.fromData(fileData, mimeType: mimeType, name: fileName);
await textFile.saveTo(result.path);final String? directoryPath = await getDirectoryPath();
if (directoryPath == null) {
// Operation was canceled by the user.
return;
}Different platforms support different type group filter options. To avoid
ArgumentErrors on some platforms, ensure that any XTypeGroups you pass set
filters that cover all platforms you are targeting, or that you conditionally
pass different XTypeGroups based on Platform.
| Android | iOS | Linux | macOS | Web | Windows | |
|---|---|---|---|---|---|---|
extensions |
✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
mimeTypes |
✔️ | ✔️ | ✔️ | ✔️ | ||
uniformTypeIdentifiers |
✔️ | ✔️ | ||||
webWildCards |
✔️ |
| Feature | Description | Android | iOS | Linux | macOS | Windows | Web |
|---|---|---|---|---|---|---|---|
| Choose a single file | Pick a file/image | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Choose multiple files | Pick multiple files/images | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
| Choose a save location | Pick a directory to save a file in | ❌ | ❌ | ✔️ | ✔️ | ✔️ | ❌ |
| Choose a directory | Pick a directory and get its path | ✔️ | ❌ | ✔️ | ✔️ | ✔️ | ❌ |