# rc-downloader

> The seed project for React library.

Latest version **0.2.8** (published 2020-05-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install rc-downloader
pnpm add rc-downloader
yarn add rc-downloader
bun add rc-downloader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.8 |
| Published | 2020-05-12 |
| First published | 2020-04-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 30.7 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | yuchen |
| Maintainers | haruchin |

## Links

- npm: https://www.npmjs.com/package/rc-downloader
- npm.io page: https://npm.io/package/rc-downloader

## Dependencies (4)

- [antd](https://npm.io/package/antd.md) ^3.23.2
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [react](https://npm.io/package/react.md) ^16.9.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.9.0

## Recent versions

- 0.2.8 (latest) — 2020-05-12
- 0.2.7 — 2020-05-12
- 0.2.6 — 2020-05-12
- 0.2.5 — 2020-05-11
- 0.2.4 — 2020-05-11
- 0.2.3 — 2020-05-11
- 0.2.2 — 2020-05-11
- 0.2.1 — 2020-05-11
- 0.2.0 — 2020-05-11
- 0.1.0 — 2020-04-24
- 0.1.9 — 2020-04-24

## README

# Downloader
本组件集成3种下载方式。

* 第一种：通过url下载文件
* 第二种：通过form表单下载文件
* 第三种：文件断点下载

## 安装
使用npm：
```shell
$ npm i rc-downloader
```

## How to Use

* 第一种 url下载

Import:
```jsx
import Downloader from 'rc-downloader' // 主文件
```

```jsx
Downloader.downloadByUrl(url) // url为下载的文件路径
```

* 第二种 form表单形式下载

Import:
```jsx
import Downloader from 'rc-downloader' // 主文件
const { RemoteDownload } = Downloader // 表单下载组件
```

Js in your script:
```jsx
//开始下载设置参数
this.setState({
    downloadUrl: '',
    gotoDownload: true,
    downloadParams
})

// 下载结束后要把gotoDownload设置为false
afterDownload = () => {
    this.setState({
        gotoDownload: false
    })
}

```

Render in your component:
```jsx
<RemoteDownload
    url={downloadUrl}                       // 下载路径
    method="get"                            // 下载方式
    gotoDownload={gotoDownload}             // 是否开始下载
    afterDownload={this.afterDownload}      // 下载后回调
    paramData={downloadParams}              // 下载文件需要的参数
/>
```

* 第三种  使用下载器断点下载

后台需要配合接口

Import:
```jsx
import Downloader from 'rc-downloader' // 主文件
```

在app.js中初始化组件

```jsx

Downloader.initDownloader()

```

添加任务

```js
const fileObj = {
    url: '',                // 服务器端下载url 必填
    fileId: '',             // 服务器的文件id 必填
    total: 0,               // 文件总大小 必填
    id: '',                 // 任务id 非必填
    fileName: '',           // 文件名称 非必填
    date: '',               // 创建日期 非必填
    type: '',               // 文件类型 非必填
    resultUrl: '',          // 下载成功后回调 非必填
    resultParams: '',       // 下载成功后回调函数参数 非必填
}

// 调用下载组件
Downloader.addTask(fileObj)

// 显示下载组件
Downloader.show()

// 隐藏下载组件
Downloader.hide()
```

## Keywords

react, downloader

---
_Source: https://npm.io/package/rc-downloader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._