ohayolibs/packages/components/down-file/index.zh-CN.md

Ohayo is a set of essential modules for ohayojp.

---
type: Basic
title: down-file
subtitle: 下载文件
cols: 1
module: import { DownFileModule } from '@ohayo/components/down-file';
---

一个基于 `blob` 的文件下载。

## 依赖

```
yarn add file-saver
```

## API

### [down-file]

| 成员 | 说明 | 类型 | 默认值 |
|----|----|----|-----|
| `[http-data]` | URL请求参数 | `{}` | - |
| `[http-body]` | POST请求响应体 | `{}` | - |
| `[http-method]` | 请求类型 | `'POST','GET','HEAD','PUT','PATCH','DELETE'` | `'GET'` |
| `[http-url]` | 下载地址 | `string` | - |
| `[file-name]` | 指定文件名，若为空从服务端返回的 `header` 中获取 `filename`、`x-filename` | `string, (rep: HttpResponse<Blob>) => string` | - |
| `[pre]` | 下载前回调 | `(ev: MouseEvent) => Promise<boolean>` | - |
| `(success)` | 成功回调 | `EventEmitter<HttpResponse<Blob>>` | - |
| `(error)` | 错误回调 | `EventEmitter<any>` | - |

## 常见问题

### 文件名获取顺序

1. `file-name`
2. `content-disposition` 的 `filename*`、`filename`
3. header 参数 `filename`、`x-filename`

### 兼容性

使用 `new Blob()` 来校验[浏览器兼容](https://github.com/eligrey/FileSaver.js/#supported-browsers)，若不兼容会在目标元素上增加 `down-file__not-support` 样式。

> 默认不兼容处理行为为隐藏，可以设置 Less 变量为 `@down-file-not-support-behavior: 'disabled'` 表示禁止点击。