# egg-ueditor

> 基于egg的UEditor百度编辑器后端实现，支持图片/文件上传、列表及图片远程抓取

Latest version **1.1.0** (published 2020-03-05) · Apache License 2.0 license · 0 weekly downloads

## Install

```sh
npm install egg-ueditor
pnpm add egg-ueditor
yarn add egg-ueditor
bun add egg-ueditor
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-03-05 |
| First published | 2018-12-23 |
| Weekly downloads | 0 |
| License | Apache License 2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | inmyjs |
| Maintainers | inmyjs |
| Keywords | egg, nodejs, ueditor, egg-ueditor |

## Links

- npm: https://www.npmjs.com/package/egg-ueditor
- Repository: https://github.com/inmyjs/egg-ueditor
- Issues: https://github.com/inmyjs/egg-ueditor/issues
- npm.io page: https://npm.io/package/egg-ueditor

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-03-05
- 1.0.3 — 2020-03-05
- 1.0.2 — 2020-03-05
- 1.0.1 — 2018-12-23
- 1.0.0 — 2018-12-23

## README

# egg-ueditor
基于egg的UEditor百度编辑器后端实现，支持图片/文件上传、列表及图片远程抓取

### 安装

```
 npm install egg-ueditor --save
```

### 使用方法


1. 在app/router.js中如下使用
```javascript

const ueditor = require('egg-ueditor')

app.all('/ueditor', ueditor())
```
   注意：默认上传至egg静态资源目录app/public，若需要上传至其他目录，如下使用：
```javascript
app.all('/ueditor', ueditor(['assets/public','public']))
```
   参数为一个数组，第1个参数为静态资源相对目录，第2个参数为静态资源url映射路径。
   
   返回的图片/文件url为完整http地址，以方便前后端分布部署，比如:http://127.0.0.1:7001/public/upload/ueditor/image/20181223/1545560529310279850.png
     
2. 可以修改 UEditor 配置，具体的参数请参考 UEditor 官方的文档
```javascript
// 需要传UEditor 配置对象
router.all('/ueditor', ueditor({
	"imageAllowFiles": [".png", ".jpg", ".jpeg"]
	"imagePathFormat": "/upload/ueditor/image/{yyyy}{mm}{dd}/{filename}"  // 保存为原文件名
}))
```
  或者
```javascript
// 需要传UEditor 配置对象
router.all('/ueditor', ueditor(['app/public','public']，{
	"imageAllowFiles": [".png", ".jpg", ".jpeg"]
	"imagePathFormat": "/upload/ueditor/image/{yyyy}{mm}{dd}/{filename}"  // 保存为原文件名
}))
```
### 2020-03-05 更新
1.增加上传图片返回相对地址，默认imageRelativeUrlEnable=true
2.使用egg-multipart上传文件，不再依赖koa-multer

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