Easy Downloader #

A Flutter plugin for easy file downloading with queue management, progress tracking, and automatic file saving to gallery or downloads folder.

Features #

• 🔄 Queue-based downloads - Downloads processed one at a time to prevent overwhelming the device
• 📊 Progress tracking - Real-time progress updates with bytes received/total
• 📁 Smart file saving - Automatically saves to the appropriate location based on file type
• 🏷️ Tag support - Group and manage downloads by tags
• ❌ Cancellation - Cancel single downloads, by tag, or all at once
• 🔁 Retry support - Easily retry failed or cancelled downloads
• 📱 Platform-aware - Works on both Android and iOS

File Type Handling #

Getting Started #

Installation #

Add easy_downloader to your pubspec.yaml:

dependencies:
  easy_downloader: ^0.0.1

Platform Setup #

Android

Add the following permissions to your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29"/>

iOS

Add the following to your Info.plist for saving to gallery:

<key>NSPhotoLibraryAddUsageDescription</key>
<string>We need access to save downloaded images and videos to your gallery.</string>

To make downloaded files visible in the iOS Files app, also add:

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

Usage #

Setup #

Provide the DownloaderCubit at the top of your widget tree:

import 'package:dio/dio.dart';
import 'package:easy_downloader/easy_downloader.dart';
import 'package:flutter_bloc/flutter_bloc.dart';

void main() {
  runApp(
    BlocProvider(
      create: (context) => DownloaderCubit(dio: Dio()),
      child: MyApp(),
    ),
  );
}

Start a Download #

context.read<DownloaderCubit>().addDownloadTask(
  url: 'https://example.com/document.pdf',
  filename: 'my_document.pdf',
  fileType: FileType.pdf,
  tag: 'invoices', // Optional: group downloads
);

Track Downloads #

BlocBuilder<DownloaderCubit, DownloaderState>(
  builder: (context, state) {
    return ListView.builder(
      itemCount: state.downloadTasks.length,
      itemBuilder: (context, index) {
        final task = state.downloadTasks[index];
        return ListTile(
          title: Text(task.filename),
          subtitle: Text(task.progressText),
          trailing: _buildTrailingWidget(task),
        );
      },
    );
  },
)

Cancel Downloads #

// Cancel a single download
context.read<DownloaderCubit>().cancelDownload(taskId);

// Cancel all downloads with a specific tag
context.read<DownloaderCubit>().cancelDownloadsByTag('invoices');

// Cancel all downloads
context.read<DownloaderCubit>().cancelAllDownloads();

Retry a Download #

context.read<DownloaderCubit>().retryDownload(taskId);

Check Progress by Tag #

final progress = context.read<DownloaderCubit>().getCollectiveProgressByTag('invoices');
final hasOngoing = context.read<DownloaderCubit>().hasOngoingDownloadsByTag('invoices');

Clean Up #

// Remove completed downloads from the list
context.read<DownloaderCubit>().clearCompletedDownloads();

// Remove all terminal downloads (completed, failed, cancelled)
context.read<DownloaderCubit>().clearTerminalDownloads();

Download Status #

Each download task has one of the following statuses:

Additional Information #

Dependencies #

This package uses the following dependencies:

• dio - HTTP client for downloads
• flutter_bloc - State management
• gal - Save images/videos to gallery
• downloadsfolder - Access downloads folder on Android
• path_provider - Access file system paths

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

Issues #

If you encounter any issues, please file them on the issue tracker.

License #

This project is licensed under the MIT License - see the LICENSE file for details.