Package Exports
- @opentiny/fluent-editor
- @opentiny/fluent-editor/es/index.es.js
- @opentiny/fluent-editor/lib/index.cjs.js
- @opentiny/fluent-editor/style.css
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentiny/fluent-editor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
TinyEditor
TinyEditor 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 | 简体中文
Features
TinyEditor 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 TinyEditor:
npm i @opentiny/fluent-editor
Write html:
<div id="editor">
<p>Hello TinyEditor!</p>
</div>
Import style:
@import '@opentiny/fluent-editor/style.css';
Initialize the TinyEditor editor:
import TinyEditor from '@opentiny/fluent-editor'
const editor = new TinyEditor('#editor', {
theme: 'snow',
})
Development
git clone git@github.com:opentiny/tiny-editor.git
cd tiny-editor
pnpm i
pnpm dev
Open your browser and visit: http://localhost:5173/tiny-editor/
Contributors ✨
Contributors are community members who have made contributions in OpenTiny.
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. TinyEditor 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. TinyEditor's table operation functionality is based on quill-better-table.
- The quill-emoji project, which is a Quill module for emoji. TinyEditor's insert emoji function is based on quill-emoji.
- The quill-blot-formatter project, which is a Quill module for resizing images and videos. TinyEditor's image scaling function is based on quill-blot-formatter.