# template-output

**Repository Path**: wanghaoye/template-output

## Basic Information

- **Project Name**: template-output
- **Description**: 导出txt、word、pdf、jpg
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-22
- **Last Updated**: 2024-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 基本适用于所有简单txt
#### 基本适用于所有需要特定模板的word
> 无法自定义相关配置
### 使用方法
> npm i template-output
 
> node版本16.18.1，npm版本8.19.2 (目前兼容测试至node18版本)

```javascript
import { exportTxt, exportWordDocx, exportPdf, exportImg } from template-output
```

*  **exportTxt方法需要两个参数**
```javascript
/**
 * 导出TXT的方法
 * @param fileName 生成txt的文件名(不需要后缀)  string
 * @param data 导出需要的数据 string
 */
exportTxt(fileName,data)
```

*  **exportWordDocx方法需要三个参数**
```javascript
/**
 * 导出Word的方法
 * @param template 自配的模板名称，默认放在public中 string
 * @param data 导出需要的数据 Object
 * @param fileName 生成word的文件名(不需要后缀) string
 * 备注：1、word模板格式自行配置；
 * 备注：2、模板中需要使用{key}这种格式来接收数据；
 * 备注：3、数组lg：[1,2,3]使用{#data}{.}{/data}或者lg:[{name:'张三'},{name:'李四'}]{#data}{name}{/data}。
 */
 exportWordDocx(template,data,fileName)
 ```

 *  **exportPdf方法需要三个参数**
```javascript
/**
 * 导出PDF的方法
 * @param DOM 需要转换为pdf的dom
 * @param offset 图片高度偏移量，解决分页将文字分裂的问题
 * @param fileName 生成pdf的文件名
 */
 exportPdf(DOM,offset,fileName)
 ```

  *  **exportImg方法需要两个参数**
```javascript
/**
 * 导出图片的方法
 * @param DOM 需要转换为图片的dom
 * @param fileName 生成图片的文件名
 * 注：本方法支持导出长截图，但不要将容器设置为固定高度，否则会导致图片无法完全截取整个页面
 */
 exportImg(DOM,fileName)
 ```