https://github.com/cycleccc/wangEditor-next

wangEditor-next —— 基于 slate.js 的富文本编辑器。wangEditor-next —— rich text editor, based on slate.js.
https://github.com/cycleccc/wangEditor-next

react richeditor tyepscript vue

Last synced: about 2 months ago
JSON representation

wangEditor-next —— 基于 slate.js 的富文本编辑器。wangEditor-next —— rich text editor, based on slate.js.

• Host: GitHub
• URL: https://github.com/cycleccc/wangEditor-next
• Owner: cycleccc
• License: mit
• Created: 2024-04-07T02:47:09.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-11-20T18:14:55.000Z (about 2 months ago)
• Last Synced: 2024-11-21T03:27:00.570Z (about 2 months ago)
• Topics: react, richeditor, tyepscript, vue
• Language: TypeScript
• Homepage: https://cycleccc.github.io/docs/
• Size: 11.8 MB
• Stars: 239
• Watchers: 5
• Forks: 24
• Open Issues: 57
• Metadata Files:
  • Readme: README-en.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-web-editor - wangEditor-next - wangEditor-next —— rich text editor, based on slate.js. (Rich text editor)

README

        
# wangEditor-next 5

[![codecov](https://codecov.io/gh/cycleccc/wangEditor-next/branch/master/graph/badge.svg?token=0ZSXFXJPK3)](https://codecov.io/gh/cycleccc/wangEditor-next)

[![GitHub stars](https://img.shields.io/github/stars/cycleccc/wangEditor-next)](https://github.com/cycleccc/wangEditor-next/stargazers)

[Chinese](./README.md)

## Introduction

The original project [wangeditor-next](https://github.com/cycleccc/wangEditor) is temporarily not maintained due to the author's [personal reasons](https://juejin.cn/post/7272735633458413602). This project is a forked version that will continue to be maintained with minimal breaking changes.

An open-source web rich text editor that is ready to use out of the box with simple configuration. It supports JS, Vue, and React.

- [Documentation](https://cycleccc.github.io/docs/)

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

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

## Features

- **Easy to use**: Simple configuration and ready to use out of the box.

- **Multi-framework support**: Works with JS, Vue, and React.

- **Customizable**: Highly customizable to fit your needs.

- **Lightweight**: Minimal footprint with high performance.

## Installation

### For Vue or React

```shell

npm i wangeditor-next/editor

```

### For HTML using CDN resources

```html

```

## Usage Examples

### HTML

Try it on StackBlitz: [HTML Example](https://stackblitz.com/edit/stackblitz-starters-xxqmwl)

### Vue 2

Try it on StackBlitz: [Vue 2 Example](https://stackblitz.com/edit/vue2-vite-starter-hkmsif)

### Vue 3

Try it on StackBlitz: [Vue 3 Example](https://stackblitz.com/edit/vue3-wangeditor-demo-8emmc7)

### React

Try it on StackBlitz: [React Example](https://stackblitz.com/edit/react-4osjqn)

## Communication

- [Discuss issues and suggestions](https://github.com/cycleccc/wangEditor-next/issues)

## Contribution

We welcome contributions! Please read the [contribution guidelines](https://github.com/cycleccc/wangEditor-next/blob/master/docs/contribution-CN.md) and the development guide in the [docs](https://github.com/cycleccc/wangEditor-next/tree/master/docs) folder.

## 🌟 Support and Motivation

If you find this project helpful, please give it a ⭐️! Your support is my motivation to maintain and improve this project. Thank you!

## Donation

To donate to the original project, support wangEditor's open-source work at https://opencollective.com/wangeditor (~~though no one donates anyway~~).

## License

[MIT License](https://opensource.org/licenses/MIT)