https://github.com/opentiny/fluent-editor
Fluent Editor is a rich text editor based on Quill 2.0, which extends rich modules and formats on the basis of Quill. It is powerful and out-of-the-box. Fluent Editor 是一个基于 Quill 2.0 的富文本编辑器，在 Quill 基础上扩展了丰富的模块和格式，功能强大、开箱即用。
https://github.com/opentiny/fluent-editor
editor fluent-editor opentiny quill rich-text rich-text-editor wysiwyg wysiwyg-editor
Last synced: 5 months ago
JSON representation
Fluent Editor is a rich text editor based on Quill 2.0, which extends rich modules and formats on the basis of Quill. It is powerful and out-of-the-box. Fluent Editor 是一个基于 Quill 2.0 的富文本编辑器，在 Quill 基础上扩展了丰富的模块和格式，功能强大、开箱即用。
- Host: GitHub
- URL: https://github.com/opentiny/fluent-editor
- Owner: opentiny
- Created: 2024-08-12T11:58:49.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-13T01:20:14.000Z (9 months ago)
- Last Synced: 2024-09-13T16:44:38.268Z (9 months ago)
- Topics: editor, fluent-editor, opentiny, quill, rich-text, rich-text-editor, wysiwyg, wysiwyg-editor
- Language: TypeScript
- Homepage: https://opentiny.github.io/fluent-editor/
- Size: 598 KB
- Stars: 60
- Watchers: 7
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fluent Editor
[](#contributors-)
Fluent Editor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as table, image, link, clipboard, emoji, file, mention, and quick menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem.
English | [简体中文](README.zh-CN.md)
## Features
Fluent Editor has the following features and advantages:
- Contains more than 30 modules and formats, in addition to the 21 built-in formats in Quill, it also extends and enhances 15 modules and formats such as table, image, link, counter, emoji, file, clipboard, mention, quick menu, screenshot, etc.
- Powerful table function, supports inserting table with specified rows and columns in the toolbar, table row height/column width dragging, inserting rows/columns, deleting rows/columns, merging/splitting cells, and other rich table operations.
- It is not related to frameworks and can be used in multiple frameworks such as Vue, React, Angular, etc.
- Compatible with all Quill APIs, Quill ecosystem modules and formats.
## Quick Start
Install Fluent Editor:
```shell
npm i @opentiny/fluent-editor
```
Write html：
```html
Hello Fluent Editor!
```
Import style:
```css
@import '@opentiny/fluent-editor/style.css';
```
Initialize the Fluent Editor editor:
```javascript
import FluentEditor from '@opentiny/fluent-editor'
const editor = new FluentEditor('#editor', {
theme: 'snow',
})
```
## Development
```shell
git clone [email protected]:opentiny/fluent-editor.git
cd fluent-editor
pnpm i
pnpm dev
```
Open your browser and visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
## Contributors ✨
Contributors are community members who have 1 or more PR merged in OpenTiny.
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
zzxming
💻
Janson1012
💻
Kagol
💻
keray
💻
qwangry
💻
jany55555
💻
## Credits ❤️
Thanks to:
- The [quill](https://github.com/slab/quill) project, which is an API-driven rich text editor with a modular architecture, good scalability, ease of use, and cross-platform support. Fluent Editor extends and enhances a large number of modules and formats such as tables, images, and hyperlinks based on Quill.
- The [quill-better-table](https://github.com/soccerloway/quill-better-table) project, which enhances the built-in table module of Quill and adds rich functionality. Fluent Editor's table operation functionality is based on quill-better-table.
- The [quill-emoji](https://github.com/contentco/quill-emoji) project, which is a Quill module for emoji. Fluent Editor's insert emoji function is based on quill-emoji.
- The [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) project, which is a Quill module for resizing images and videos. Fluent Editor's image scaling function is based on quill-blot-formatter.
## License
[MIT](LICENSE)