Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 4.76 KB

README.md

File metadata and controls

101 lines (69 loc) · 4.76 KB
Raw

Fluent Editor

All Contributors

Fluent Editor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as tables, images, hyperlinks, copy and paste, inserting emoticons, file uploads, @ reminders, and diagonal menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem.

English | 简体中文

Features

Fluent Editor has the following features and advantages:

  • Contains more than 30 rich modules and formats, in addition to the 21 built-in formats in Quill, it also extends and enhances 15 modules and formats such as tables, images, hyperlinks, word counts, emoticons, file uploads, copy and paste, @ reminders, slash shortcut menus, screenshots, etc
  • Powerful table function, supports inserting tables 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:

npm i @opentiny/fluent-editor

Write html：

<div id="editor">
  <p>Hello Fluent Editor!</p>
</div>

Import style:

@import '@opentiny/fluent-editor/style.css';

Initialize the Fluent Editor editor:

import FluentEditor from '@opentiny/fluent-editor'

const editor = new FluentEditor('#editor', {
  theme: 'snow',
})

Development

git clone git@github.com:opentiny/fluent-editor.git
cd fluent-editor
pnpm i
pnpm dev

Open your browser and visit: 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):

zzxming
zzxming
💻		 Janson1012
Janson1012
💻		 Kagol
Kagol
💻		 keray
keray
💻

Credits ❤️

Thanks to:

  • The 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 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 project, which is a Quill module for emoji. Fluent Editor's insert emoji function is based on quill-emoji.
  • The 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