wangEditor/README-en.md

3.0 KiB
Raw Blame History

wangEditor

Stars badge Forks badge cypress badge jest badge build badge MIT License


Logo

wangEditor

A lightweight rich text editor, friendly API and use extremely conventient.
Offical website · Explore the docs »

中文 · View Demo · Report Bug · Request Feature

About

wangEditor is a web rich text editor that use typescript develop. It's lightweight, simple, use convience and open source.

It support most of modern browsers: Chrome, Firefox, Safar, Edge, QQ-browser, IE11 and so on.

It doesn't support mobile browsers.

Product Name Screen Shot

Usage

Use NPM package

npm install wangeditor --save

A few lines code for creating editor instance

import E from "wangeditor";
const editor = new E("#div1");
editor.create();

Use CDN

<script type="text/javascript" src="https://unpkg.com/wangeditor/dist/wangEditor.min.js"></script>
<script type="text/javascript">
  const E = window.wangEditor
  const editor = new E('#div1')
  // or const editor = new E(document.getElementById('div1'))
  editor.create()
</script>

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Before contributing wangEditor, You must read contribution docs.

License

Distributed under the MIT License. See MIT License for more information.

Developer team

We have a professional developer team, if you want to join us, you can send email to wangfupeng1988@163.com.

If you are a chinese developer, you can join our QQ group or read chinese docs for more information.

Support us

Your support will encourage us to output more quality content.