flutter_file_saver

Interface to provide a way to save files on the device in Flutter.

Platform Support

	Android	iOS	Web	Windows	Linux	MacOS
writeFileAsBytes	✅	✅	✅	❌️	❌️	✅
writeFileAsString	✅	✅	✅	❌️	❌️	✅

Under the hood, each implementation tries to use the native dialog to save the file:

• Android: ACTION_CREATE_DOCUMENT intent is used
• iOS: UIDocumentPickerViewController is used
• MacOS: NSSavePanel is used
• Web: It will try to use the showSaveFilePicker API if available, otherwise it will try to use the download attribute on an anchor tag

Getting Started

Import the package

dependencies:
    flutter_file_saver: any

Platform Setup

Android Setup

android {
    defaultConfig {
        minSdkVersion 19
    }
}

Check example

iOS Setup (Needs iOS 16+)

Add the following permissions to your ios/Runner/Info.plist:

<key>UISupportsDocumentBrowser</key>
<true/>
<key>UIFileSharingEnabled</key>
<true/>
<key>LSSupportsOpeningDocumentsInPlace</key>
<true/>

Check example

MacOS Setup

Add the following permissions to your macos/Runner/DebugProfile.entitlements:

<key>com.apple.security.files.user-selected.read-write</key>
<true/>

Check example

Methods

writeFileAsBytes

Write a file on the device from a Uint8List.

FlutterFileSaver().writeFileAsBytes(
    fileName: 'file.txt',
    bytes: fileBytes,
);

writeFileAsString

Write a file on the device from a String. This will most of the time convert your data and perform a call to writeFileAsBytes.

FlutterFileSaver().writeFileAsString(
    fileName: 'file.txt',
    string: 'Hello World!',
);