wangeditor-next/wangEditor-next
 Watch    6
 Star    785
 Fork    82

wangEditor-next 5

npm version npm downloads bundle JSDocs License codecov

🌍 English | 中文

介绍

原项目 wangeditor 因作者个人原因短期不再维护,本项目为 fork 版本,将在尽量不 Breaking Change 的前提下继续维护。

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

特点

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

安装

对于 Vue 或 React

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 资源

<script src="https://unpkg.com/@wangeditor-next/editor@latest/dist/index.js"></script>

使用示例

示例 在线 demo 链接
HTML 在 StackBlitz 上试用
Vue 2 在 StackBlitz 上试用
Vue 3 在 StackBlitz 上试用
React 在 StackBlitz 上试用

仓库内 demo 的真实源码统一维护在 apps/

  • apps/demo-html
  • apps/demo-react
  • apps/demo-vue3
  • apps/demo-yjs-react
  • apps/demo-yjs-vue3

本地运行:

pnpm demo:html
pnpm demo:react
pnpm demo:vue3
pnpm demo:yjs:react
pnpm demo:yjs:vue3

说明:

  • README 中的 StackBlitz 链接用于在线复现和分享
  • 仓库内实际维护以 apps/* 为准,不建议直接把沙盒代码当成长期维护源
  • 如需导出模板,可使用 pnpm demo:export-template demo-react <output-dir>pnpm demo:export-template demo-vue3 <output-dir>
  • 如需自动同步模板仓库,可配置 .github/workflows/export-demo-templates.yml 所需的 repo variables / secret

交流

贡献

我们欢迎所有贡献!请阅读贡献指南docs 文件夹内的开发指南。

🌟 支持与鼓励

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

捐赠

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

贡献者

License

MIT License © 2024-PRESENT cycleccc

关于
基于 slate.js、支持 vue2、3、react、markdown、多人协同、易使用、可扩展的富文本编辑器
最后更新于  2 days ago
License