https://github.com/a7ul/react-native-simple-download-manager
A react native module to schedule downloads on native download manager
https://github.com/a7ul/react-native-simple-download-manager
android download manager native open-library react schedule-downloads
Last synced: about 1 month ago
JSON representation
A react native module to schedule downloads on native download manager
- Host: GitHub
- URL: https://github.com/a7ul/react-native-simple-download-manager
- Owner: a7ul
- License: mit
- Created: 2017-12-11T06:45:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T11:32:01.000Z (over 2 years ago)
- Last Synced: 2025-04-05T02:22:21.013Z (2 months ago)
- Topics: android, download, manager, native, open-library, react, schedule-downloads
- Language: Java
- Homepage: https://www.npmjs.com/package/react-native-simple-download-manager
- Size: 115 KB
- Stars: 36
- Watchers: 3
- Forks: 15
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-simple-download-manager
A simple straightforward react native module that lets you schedule downloads onto your download manager for android.
- Support custom headers for authentication
- File download scheduler
- Cancel file downlaod
- Check status of the download
TODO - ios module
### Installation:
`yarn add react-native-simple-download-manager`
or
`npm i react-native-simple-download-manager --save`
### Mostly automatic installation
`react-native link react-native-simple-download-manager`
### Manual installation
#### Android
1. Open up `android/app/src/main/java/[...]/MainApplication.java`
- Add `import com.masteratul.downloadmanager.ReactNativeDownloadManagerPackage;` to the imports at the top of the file
- Add `new ReactNativeDownloadManagerPackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
```
include ':react-native-simple-download-manager'
project(':react-native-simple-download-manager').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-simple-download-manager/android')
```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```
compile project(':react-native-simple-download-manager')
```
### Usage
```js
const downloadManager = require("react-native-simple-download-manager");
const url = "http://url/to/file.ext?query=parmas";
const headers = { Authorization: "Bearer abcsdsjkdjskjdkskjd" };
const config = {
downloadTitle: "Title that should appear in Native Download manager",
downloadDescription:
"Description that should appear in Native Download manager",
saveAsName: "File name to save",
allowedInRoaming: true,
allowedInMetered: true,
showInDownloads: true,
external: false, //when false basically means use the default Download path (version ^1.3)
path: "Download/" //if "external" is true then use this path (version ^1.3)
};
downloadManager
.download((url = ""), (headers = {}), (config = {}))
.then(response => {
console.log("Download success!");
})
.catch(err => {
console.log("Download failed!");
});
```
### Advanced Usage
The module currently supports
- download,
- queueDownload,
- attachOnCompleteListener,
- cancel,
- checkStatus
You can check https://github.com/master-atul/react-native-simple-download-manager/blob/master/index.js
### Contributors
- [Atul R](https://github.com/master-atul)
- [Shivam Barsaley](https://github.com/shivambarsaley)
- [ibrahimtelman](https://github.com/ibrahimtelman)
- [KingDark](https://github.com/kingdark1234)
Peace ! ✌🏻🌮