Package selection guidance compiled from public package information, community data, and project usage.
The download_assets package enables Flutter applications to retrieve and store assets locally within the app's repository, making them available for offline use. It supports downloading files from remote URLs and saving them to the device’s file system, which is particularly useful for caching resources like images, documents, or configuration files. The package works across multiple platforms including Android, iOS, macOS, Windows, and Linux, ensuring consistent behavior. It simplifies asset management by handling downloads asynchronously and managing file paths automatically.
Use cases
Offline content access
Caching remote resources
Preloading app assets
Dynamic content updates
Asset fallback mechanisms
Key features
Cross-platform support
Asynchronous downloads
Local file storage
Automatic path management
Support for various file types
Suitable for
Apps needing offline functionality
Content-heavy apps
Apps with dynamic asset delivery
Developers managing remote assets
Projects requiring cached data
Considerations
Requires internet permission on mobile
Disk space management needed
File naming conflicts possible
No built-in retry logic
Manual cleanup of downloaded files
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Download_assets
About
The download_assets package is a powerful library that facilitates the process of downloading assets
into the application. With this library, you can easily download files, images, videos, and other
resources in your app, providing a smooth and efficient user experience.
Features
init
Init method for setting up the assetsDir, which is required to be called during app
initialization.
await downloadAssetsController.init();
startDownload
Starts the asset download process.
assetsUrls: A list of [AssetUrl] objects representing each file to be downloaded.
uncompressDelegates: A list of custom decompression delegates for different types of files, such
as ZIP, RAR, etc (optional).
onStartUnzipping: Called right before the start of the uncompressing process (optional).
onProgress: Called after each iteration returning the current progress (optional). The double parameter ranges from 0 to 1, where 1 indicates the completion of the download process.
onDone: Called when all files have been downloaded and uncompressed (optional).
onCancel: Cancels the ongoing download (optional).
requestQueryParams: Query params to be used in the request (optional).
requestExtraHeaders: Extra headers to be added in the request (optional).
checkSize: Specifies if the size of the file should be checked first before starting download (optional).
Uncompress delegates are responsible for implementing the logic to uncompress different types of
files, such as ZIP, RAR, etc. By providing a list of delegates, it becomes possible to support
multiple file formats during the download.
To implement your own uncompression delegate, you should implement the interface below.
/// Abstract class representing a delegate for asset decompression.abstractclassUncompressDelegate{
constUncompressDelegate();
/// Gets the file extension associated with the delegate.Stringgetextension;
/// uncompress the asset located at [compressedFilePath] to the specified [assetsDir]./// [compressedFilePath] -> The path to the compressed asset file./// [assetsDir] -> The directory where the uncompressed asset should be stored.Futureuncompress(String compressedFilePath, String assetsDir);
}
Note: This kind of delegate is essential for enabling the download process to handle various
file formats by implementing the necessary decompression logic. This flexibility allows users to
download and work with a wide range of compressed file types effortlessly. UnzipDelegate() is
already included, which handles the decompression of ZIP files.
Example
You can find an example here: https://github.com/edjostenes/download_assets/tree/master/example
Contributing
Contributions are welcome! If you encounter any issues or have suggestions for improvement,
please create an issue on the GitHub repository.