@opentiny/fluent-editor 3.17.2-alpha.0 → 3.17.2-alpha.1

package/README.md

@@ -0,0 +1,64 @@
+# FluentEditor
+
+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.
+
+## Features
+
+FluentEditor 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 FluentEditor:
+
+```shell
+npm i @opentiny/fluent-editor
+```
+
+Write html：
+
+```html
+<div id="editor">
+  <p>Hello FluentEditor!</p>
+</div>
+```
+
+Import style:
+
+```css
+@import '@opentiny/fluent-editor/dist/style.css'
+```
+
+Initialize the FluentEditor editor:
+
+```javascript
+import FluentEditor from '@opentiny/fluent-editor'
+
+const editor = new FluentEditor('#editor', {
+  theme: 'snow'
+})
+```
+
+## Development
+
+```shell
+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/](http://localhost:5173/fluent-editor/)
+
+## ❤️ 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. FluentEditor 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. FluentEditor'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. FluentEditor'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. FluentEditor's image scaling function is based on quill-blot-formatter.

package/package.json

@@ -1,80 +1,79 @@
-{
-  "name": "@opentiny/fluent-editor",
-  "version": "3.17.2-alpha.0",
-  "description": "A rich text editor based on Quill 2.0, which extends rich modules and formats on the basis of Quill. It's powerful and out-of-the-box.",
-  "homepage": "https://opentiny.github.io/fluent-editor/",
-  "keywords": [
-    "editor",
-    "rich-text-editor",
-    "rich-text",
-    "wysiwyg",
-    "wysiwyg-editor",
-    "quill",
-    "opentiny",
-    "fluent-editor"
-  ],
-  "author": "OpenTiny Team",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:opentiny/fluent-editor.git"
-  },
-  "bugs": {
-    "url": "https://github.com/opentiny/fluent-editor/issues"
-  },
-  "main": "dist/index.cjs.js",
-  "files": [
-    "dist/*"
-  ],
-  "module": "dist/index.es.js",
-  "exports": {
-    ".": {
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.cjs.js"
-    },
-    "./dist/style.css": {
-      "import": "./dist/style.css",
-      "require": "./dist/style.css"
-    }
-  },
-  "scripts": {
-    "start": "vite build && vite",
-    "dev": "vite",
-    "build": "vite build",
-    "test": "jest",
-    "format": "prettier './{src,test}/**/*.{js,ts,tsx,vue}' --write"
-  },
-  "gitHooks": {
-    "pre-commit": "lint-staged",
-    "commit-msg": "node verifyCommit.js"
-  },
-  "lint-staged": {
-    "*.ts": [
-      "eslint --fix",
-      "git add"
-    ]
-  },
-  "devDependencies": {
-    "@types/jest": "^26.0.23",
-    "@types/node": "^15.0.2",
-    "@types/quill": "^2.0.9",
-    "@typescript-eslint/eslint-plugin": "^5.7.0",
-    "@typescript-eslint/parser": "^5.7.0",
-    "eslint": "^8.5.0",
-    "jest": "^26.6.3",
-    "lint-staged": "^12.1.4",
-    "lodash-es": "^4.17.15",
-    "prettier": "^2.3.0",
-    "sass": "^1.47.0",
-    "ts-jest": "^26.5.6",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.2.4",
-    "vite": "^2.3.0"
-  },
-  "dependencies": {
-    "highlight.js": "^10.2.0",
-    "html2canvas": "^1.0.0-rc.7",
-    "quill": "^2.0.0",
-    "quill-delta": "^5.1.0"
-  }
+{
+  "name": "@opentiny/fluent-editor",
+  "version": "3.17.2-alpha.1",
+  "description": "A rich text editor based on Quill 2.0, which extends rich modules and formats on the basis of Quill. It's powerful and out-of-the-box.",
+  "homepage": "https://opentiny.github.io/fluent-editor/",
+  "keywords": [
+    "editor",
+    "rich-text-editor",
+    "rich-text",
+    "wysiwyg",
+    "wysiwyg-editor",
+    "quill",
+    "opentiny",
+    "fluent-editor"
+  ],
+  "author": "OpenTiny Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:opentiny/fluent-editor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/opentiny/fluent-editor/issues"
+  },
+  "main": "index.cjs.js",
+  "module": "index.es.js",
+  "exports": {
+    ".": {
+      "import": "./index.es.js",
+      "require": "./index.cjs.js"
+    },
+    "./style.css": {
+      "import": "./style.css",
+      "require": "./style.css"
+    }
+  },
+  "scripts": {
+    "start": "vite build && vite",
+    "dev": "vite",
+    "build": "vite build && node scripts/pre-release.js",
+    "test": "jest",
+    "format": "prettier './{src,test}/**/*.{js,ts,tsx,vue}' --write"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged",
+    "commit-msg": "node verifyCommit.js"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "git add"
+    ]
+  },
+  "devDependencies": {
+    "@types/jest": "^26.0.23",
+    "@types/node": "^15.0.2",
+    "@types/quill": "^2.0.9",
+    "@typescript-eslint/eslint-plugin": "^5.7.0",
+    "@typescript-eslint/parser": "^5.7.0",
+    "commander": "^6.2.0",
+    "eslint": "^8.5.0",
+    "jest": "^26.6.3",
+    "lint-staged": "^12.1.4",
+    "lodash-es": "^4.17.15",
+    "prettier": "^2.3.0",
+    "sass": "^1.47.0",
+    "shelljs": "^0.8.4",
+    "ts-jest": "^26.5.6",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.2.4",
+    "vite": "^2.3.0"
+  },
+  "dependencies": {
+    "highlight.js": "^10.2.0",
+    "html2canvas": "^1.0.0-rc.7",
+    "quill": "^2.0.0",
+    "quill-delta": "^5.1.0"
+  }
 }