# wangEditor-next

**Repository Path**: pengjielee/wangEditor-next

## Basic Information

- **Project Name**: wangEditor-next
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-04
- **Last Updated**: 2025-02-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# wangEditor-next 5


[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
[![codecov](https://codecov.io/gh/cycleccc/wangEditor-next/graph/badge.svg?token=0ZSXFXJPK3)](https://codecov.io/gh/cycleccc/wangEditor-next)

🌍 [English](./README-en.md) | 中文

## 介绍

原项目 [wangeditor](https://github.com/wangeditor-team/wangEditor) 因作者[个人原因](https://juejin.cn/post/7272735633458413602)短期不再维护，本项目为 fork 版本,将在尽量不 Breaking Change 的前提下继续维护。

开源 Web 富文本编辑器，开箱即用，配置简单。支持 JS Vue React 。

- [文档](https://cycleccc.github.io/docs/)
- [Demo](https://cycleccc.github.io/demo/)

![](./docs/images/editor.png)

## 特点

- **易于使用**：简单配置，开箱即用。
- **多框架支持**：支持 JS、Vue 和 React。
- **可定制**：高度可定制，满足您的需求。
- **轻量级**：占用空间小，性能高。

## 安装

### 对于 Vue 或 React
```shell
npm install @wangeditor-next/editor --save
// vue3 需要额外下载
npm install @wangeditor-next/editor-for-vue --save
// vue2 需要额外下载
npm install @wangeditor-next/editor-for-vue2 --save
// react 需要额外下载
npm install @wangeditor-next/editor-for-react --save
```

### 对于 HTML 使用 CDN 资源
```html
<script src="https://unpkg.com/@wangeditor-next/editor@latest/dist/index.js"></script>
```

## 使用示例

| 示例 | 在线 demo 链接 |
|------|------|
| HTML | [在 StackBlitz 上试用](https://stackblitz.com/edit/stackblitz-starters-xxqmwl) |
| Vue 2 | [在 StackBlitz 上试用](https://stackblitz.com/edit/vue2-vite-starter-hkmsif) |
| Vue 3 | [在 StackBlitz 上试用](https://stackblitz.com/edit/vue3-wangeditor-demo-8emmc7) |
| React | [在 StackBlitz 上试用](https://stackblitz.com/edit/react-4osjqn) |


## 交流

- [讨论问题和建议](https://github.com/cycleccc/wangEditor-next/issues)

## 贡献

我们欢迎所有贡献！请阅读[贡献指南](https://github.com/cycleccc/wangEditor-next/blob/master/docs/contribution-CN.md)及 [docs](https://github.com/cycleccc/wangEditor-next/tree/master/docs) 文件夹内的开发指南。

## 🌟 支持与鼓励

如果你觉得这个项目对你有帮助，请不要忘记给它一个 ⭐️！你的支持是我持续维护和改进这个项目的动力。感谢你的支持！

## 捐赠

对原项目捐赠即可，支持 wangEditor 开源工作：https://opencollective.com/wangeditor (~~虽然也没人捐赠~~)。

## 贡献者

<a href="https://github.com/cycleccc/wangEditor-next/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=cycleccc/wangEditor-next" />
</a>

## License

[MIT](./LICENSE) License © 2024-PRESENT [cycleccc](https://github.com/cycleccc)

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@wangeditor-next/editor?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/@wangeditor-next/editor
[npm-downloads-src]: https://img.shields.io/npm/dm/@wangeditor-next/core?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/@wangeditor-next/editor
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@wangeditor-next/editor?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=@wangeditor-next/editor
[license-src]: https://img.shields.io/github/license/cycleccc/wangeditor-next.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/cycleccc/wangeditor-next/blob/master/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/@wangeditor-next/editor