file_save_directory #

A Flutter plugin that allows you to save files to the Downloads, Documents, Music, Videos, or App Documents directories on Android and iOS. It also supports automatically opening the file after saving, handles permissions, and resolves file name conflicts.

✨ Features #

• ✅ Save files to:
  • 📂 Public Downloads folder
  • 📄 Public Documents folder
  • 🎵 Public Music folder
  • 🎬 Public Videos folder
  • 📁 App's private documents directory
• 🛡️ Automatically handles permissions and file name conflicts
• 📱 Supports Android 6.0+ and iOS 11+
• 📦 Simple API — just provide a file name and bytes
• 🔓 Optionally opens the file after saving
• 🎵 Smart detection for audio and video file types

Platform Support #

• ✅ Android 6.0+ (API level 23)
• ✅ iOS 11+

🚀 Getting Started #

⚙️ Platform Setup #

✅ Android Setup

1. Update AndroidManifest.xml in android/app/src/main/AndroidManifest.xml:

   First, ensure your manifest declaration includes the required namespaces:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

2. Add permissions (inside <manifest>, but outside <application>):

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" tools:ignore="ScopedStorage" />

3. Enable Legacy Storage (For Android 10)

   Inside the <application> tag in AndroidManifest.xml, add:

<application
    ...
    android:requestLegacyExternalStorage="true"
    ...
>
</application>

🍎 iOS Setup

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

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

These keys enable file sharing and document interaction for your iOS app.

💡 Usage #

1. Import the plugin:

import 'package:file_save_directory/file_save_directory.dart';

2. Save a file:

final result = await FileSaveDirectory.instance.saveFile(
  fileName: 'example.txt',
  fileBytes: utf8.encode('Hello, Flutter!'),
  location: SaveLocation.downloads, // or SaveLocation.documents, SaveLocation.music, SaveLocation.videos, SaveLocation.appDocuments
  openAfterSave: true, // Default to true
);

📍 Save Location Options #

• 🗂️ SaveLocation.downloads → 📂 Public Downloads (Android), 📄 Documents (iOS)
• 📄 SaveLocation.documents → 📁 Public Documents (Android), 📄 Documents (iOS)
• 🎵 SaveLocation.music → 🎵 Public Music folder (Android), 🎵 App's Music folder (iOS)
• 🎬 SaveLocation.videos → 🎬 Public Movies/Videos folder (Android), 🎬 App's Videos folder (iOS)
• 📁 SaveLocation.appDocuments → 📦 App's private documents folder (Android & iOS)

🛠 Troubleshooting #

✅ Android 11+ requires MANAGE_EXTERNAL_STORAGE for full shared storage access.

📁 If saving fails, ensure your app has storage permissions.

📱 Test on a real device to validate file system behavior.

⚙️ Call FileSaveDirectory.instance.openAppSettings() if you need to prompt users to manually grant storage access.

🤝 Contributing #

Feel free to open issues or submit pull requests. All contributions are welcome!