@opentiny/fluent-editor 3.17.3 → 3.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,64 +1,64 @@
1
- # FluentEditor
2
-
3
- FluentEditor 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.
4
-
5
- ## Features
6
-
7
- FluentEditor has the following features and advantages:
8
-
9
- - 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
10
- - 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
11
- - It is not related to frameworks and can be used in multiple frameworks such as Vue, React, Angular, etc
12
- - Compatible with all Quill APIs, Quill ecosystem modules and formats
13
-
14
- ## Quick Start
15
-
16
- Install FluentEditor:
17
-
18
- ```shell
19
- npm i @opentiny/fluent-editor
20
- ```
21
-
22
- Write html:
23
-
24
- ```html
25
- <div id="editor">
26
- <p>Hello FluentEditor!</p>
27
- </div>
28
- ```
29
-
30
- Import style:
31
-
32
- ```css
33
- @import '@opentiny/fluent-editor/style.css'
34
- ```
35
-
36
- Initialize the FluentEditor editor:
37
-
38
- ```javascript
39
- import FluentEditor from '@opentiny/fluent-editor'
40
-
41
- const editor = new FluentEditor('#editor', {
42
- theme: 'snow'
43
- })
44
- ```
45
-
46
- ## Development
47
-
48
- ```shell
49
- git clone git@github.com:opentiny/fluent-editor.git
50
- cd fluent-editor
51
- pnpm i
52
- pnpm dev
53
- ```
54
-
55
- Open your browser and visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
56
-
57
- ## ❤️ Credits
58
-
59
- Thanks to:
60
-
61
- - 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. FluentEditor extends and enhances a large number of modules and formats such as tables, images, and hyperlinks based on Quill.
62
- - 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. FluentEditor's table operation functionality is based on quill-better-table.
63
- - The [quill-emoji](https://github.com/contentco/quill-emoji) project, which is a Quill module for emoji. FluentEditor's insert emoji function is based on quill-emoji.
64
- - The [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) project, which is a Quill module for resizing images and videos. FluentEditor's image scaling function is based on quill-blot-formatter.
1
+ # FluentEditor
2
+
3
+ FluentEditor 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.
4
+
5
+ ## Features
6
+
7
+ FluentEditor has the following features and advantages:
8
+
9
+ - 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
10
+ - 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
11
+ - It is not related to frameworks and can be used in multiple frameworks such as Vue, React, Angular, etc
12
+ - Compatible with all Quill APIs, Quill ecosystem modules and formats
13
+
14
+ ## Quick Start
15
+
16
+ Install FluentEditor:
17
+
18
+ ```shell
19
+ npm i @opentiny/fluent-editor
20
+ ```
21
+
22
+ Write html:
23
+
24
+ ```html
25
+ <div id="editor">
26
+ <p>Hello FluentEditor!</p>
27
+ </div>
28
+ ```
29
+
30
+ Import style:
31
+
32
+ ```css
33
+ @import '@opentiny/fluent-editor/style.css'
34
+ ```
35
+
36
+ Initialize the FluentEditor editor:
37
+
38
+ ```javascript
39
+ import FluentEditor from '@opentiny/fluent-editor'
40
+
41
+ const editor = new FluentEditor('#editor', {
42
+ theme: 'snow'
43
+ })
44
+ ```
45
+
46
+ ## Development
47
+
48
+ ```shell
49
+ git clone git@github.com:opentiny/fluent-editor.git
50
+ cd fluent-editor
51
+ pnpm i
52
+ pnpm dev
53
+ ```
54
+
55
+ Open your browser and visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
56
+
57
+ ## ❤️ Credits
58
+
59
+ Thanks to:
60
+
61
+ - 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. FluentEditor extends and enhances a large number of modules and formats such as tables, images, and hyperlinks based on Quill.
62
+ - 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. FluentEditor's table operation functionality is based on quill-better-table.
63
+ - The [quill-emoji](https://github.com/contentco/quill-emoji) project, which is a Quill module for emoji. FluentEditor's insert emoji function is based on quill-emoji.
64
+ - The [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) project, which is a Quill module for resizing images and videos. FluentEditor's image scaling function is based on quill-blot-formatter.