jodit 4.0.0-beta.84 → 4.0.0-beta.86

package/CHANGELOG.md

@@ -9,6 +9,47 @@
 > -   :house: [Internal]
 > -   :nail_care: [Polish]
 
+## 4.0.0-beta.78
+
+- Update
+```
+ @types/karma                        ^6.3.3  →    ^6.3.4
+ @types/node                        ^20.1.0  →   ^20.5.0
+ @typescript-eslint/eslint-plugin   ^5.59.2  →    ^6.4.0
+ @typescript-eslint/parser          ^5.59.2  →    ^6.4.0
+ autoprefixer                      ^10.4.14  →  ^10.4.15
+ core-js                            ^3.30.2  →   ^3.32.0
+ css-loader                          ^6.7.3  →    ^6.8.1
+ css-minimizer-webpack-plugin        ^5.0.0  →    ^5.0.1
+ eslint                             ^8.40.0  →   ^8.47.0
+ eslint-config-prettier              ^8.8.0  →    ^9.0.0
+ eslint-plugin-import               ^2.27.5  →   ^2.28.0
+ eslint-plugin-prettier              ^4.2.1  →    ^5.0.0
+ glob                               ^10.2.2  →   ^10.3.3
+ less                                ^4.1.3  →    ^4.2.0
+ less-loader                        ^11.1.0  →   ^11.1.3
+ lint-staged                        ^13.2.2  →   ^14.0.0
+ mini-css-extract-plugin             ^2.7.5  →    ^2.7.6
+ node-jq                             ^2.3.5  →    ^4.0.1
+ postcss                           >=8.4.23  →  >=8.4.27
+ postcss-loader                      ^7.3.0  →    ^7.3.3
+ prettier                            ^2.8.8  →    ^3.0.1
+ style-loader                        ^3.3.2  →    ^3.3.3
+ stylelint                          ^15.6.1  →  ^15.10.2
+ stylelint-config-standard          ^33.0.0  →   ^34.0.0
+ stylelint-prettier                  ^3.0.0  →    ^4.0.2
+ synchronous-promise                 2.0.15  →    2.0.17
+ terser-webpack-plugin               ^5.3.8  →    ^5.3.9
+ ts-loader                           ^9.4.2  →    ^9.4.4
+ tslib                               ^2.5.0  →    ^2.6.1
+ typescript                          ^5.0.4  →    ^5.1.6
+ webpack                             5.82.0  →    5.88.2
+ webpack-cli                         ^5.1.0  →    ^5.1.4
+ webpack-dev-middleware              ^6.1.0  →    ^6.1.1
+ webpack-dev-server                 ^4.15.0  →   ^4.15.1
+ webpack-hot-middleware             ^2.25.3  →   ^2.25.4
+```
+
 ## 4.0.0-beta.77
 
 ### :bug: Bug Fix

package/README.md

@@ -1,8 +1,9 @@
 ![Jodit WYSIWYG editor](https://raw.githubusercontent.com/xdan/jodit/main/examples/assets/logo.png)
 
-# Jodit Editor 3
+# Jodit Editor
 
-An excellent WYSIWYG editor written in pure TypeScript without the use of additional libraries. Its file editor and image editor.
+Jodit Editor is an excellent WYSIWYG editor written in pure TypeScript
+without the use of additional libraries. It includes a file editor and image editor.
 
 [![Build Status](https://github.com/xdan/jodit/workflows/Run%20tests/badge.svg)](https://github.com/xdan/jodit/actions/workflows/tests.yml)
 [![npm version](https://badge.fury.io/js/jodit.svg)](https://badge.fury.io/js/jodit)
@@ -11,7 +12,7 @@ An excellent WYSIWYG editor written in pure TypeScript without the use of additi
 -   [Demo and Official site](https://xdsoft.net/jodit/)
 -   [PRO Version](https://xdsoft.net/jodit/pro/)
 -   [Builder](https://xdsoft.net/jodit/builder/)
--   [Playground - play with options](https://xdsoft.net/jodit/play.html)
+-   [Playground - Play with Options](https://xdsoft.net/jodit/play.html)
 -   [Documentation](https://xdsoft.net/jodit/docs/)
 -   [Download & Changes](https://github.com/xdan/jodit/releases)
 -   [Changelog](https://github.com/xdan/jodit/blob/main/CHANGELOG.md)
@@ -20,84 +21,84 @@ An excellent WYSIWYG editor written in pure TypeScript without the use of additi
 
 ## Get Started
 
-## How use
+## How to Use
 
-Download the latest [release](https://github.com/xdan/jodit/releases/latest) or
+Download the latest [release](https://github.com/xdan/jodit/releases/latest) or via npm:
 
-### INSTALL VIA NPM
-
-```bash
+```sh
 npm install jodit
 ```
 
-You will get:
+You will get the following files:
 
-- inside /esm: ESM version of the editor (compatible with e.g. webpack)
-- inside /(es5|es2015|es2018|es2021)/*.js: UMD bundled, not minified
-- inside /(es5|es2015|es2018|es2021)/*.min.js: UMD bundled, and minified
-- types/index.d.ts: this specifies the API of the editor (this is what is actually versioned, everything else is considered private and might break with any release).
+-   Inside `/esm`: ESM version of the editor (compatible with tools like webpack)
+-   Inside `/es5`, `/es2015`, `/es2018`, `/es2021`: UMD bundled files (not minified)
+-   Inside `/es5`, `/es2015`, `/es2018`, `/es2021` with `.min.js` extension: UMD bundled and minified files
+-   `types/index.d.ts`: This file specifies the API of the editor. It is versioned, while everything else is considered private and may change with each release.
 
-### Include just two files
+### Include Jodit in Your Project
 
-ES5 Version
+Include the following two files:
+
+ES5 Version:
 
 ```html
 <link type="text/css" rel="stylesheet" href="es2015/jodit.min.css" />
 <script type="text/javascript" src="es2015/jodit.min.js"></script>
 ```
 
-es2021 Version (if your users use only modern browsers)
+ES2021 Version (for modern browsers only):
 
 ```html
 <link type="text/css" rel="stylesheet" href="es2021/jodit.min.css" />
 <script type="text/javascript" src="es2021/jodit.min.js"></script>
 ```
 
-esm modules
+ESM Modules:
 
 ```html
 <script type="importmap">
-  {
-    "imports": {
-      "autobind-decorator": "https://unpkg.com/autobind-decorator@2.4.0/lib/esm/index.js"
-    }
-  }
+	{
+		"imports": {
+			"autobind-decorator": "https://unpkg.com/autobind-decorator@2.4.0/lib/esm/index.js"
+		}
+	}
 </script>
-<link rel="stylesheet" href="./node_modules/jodit/es2021/jodit.min.css"/>
+<link rel="stylesheet" href="./node_modules/jodit/es2021/jodit.min.css" />
 <script type="module">
-  import {Jodit} from "./node_modules/jodit/esm/index.js"
-  Jodit.make('#editor', {
-    width: 600,
-    height: 400,
-  });
+	import { Jodit } from './node_modules/jodit/esm/index.js';
+	Jodit.make('#editor', {
+		width: 600,
+		height: 400
+	});
 </script>
 ```
 
-ESM automatically connects only the basic set of plugins and only English.
-You can connect the necessary plugins and languages yourself:
+The ESM modules automatically include only the basic set of plugins and the English language.
+You can manually include additional plugins and languages as needed.
 
 ```html
 <script type="importmap">
-  {
-    "imports": {
-      "autobind-decorator": "https://unpkg.com/autobind-decorator@2.4.0/lib/esm/index.js"
-    }
-  }
+	{
+		"imports": {
+			"autobind-decorator": "https://unpkg.com/autobind-decorator@2.4.0/lib/esm/index.js"
+		}
+	}
 </script>
-<link rel="stylesheet" href="./node_modules/jodit/es2021/jodit.min.css"/>
+<link rel="stylesheet" href="./node_modules/jodit/es2021/jodit.min.css" />
 <script type="module">
-  import {Jodit} from "./node_modules/jodit/esm/index.js"
-  import "./node_modules/jodit/esm/plugins/add-new-line/add-new-line.js"
-  import "./node_modules/jodit/esm/plugins/fullsize/fullsize.js"
-  import de from "./node_modules/jodit/esm/langs/de.js"
-
-  Jodit.langs.de = de;
-
-  Jodit.make('#editor', {
-    width: 600,
-    height: 400,
-    language: 'de'
-  });
+	import { Jodit } from './node_modules/jodit/esm/index.js';
+	import './node_modules/jodit/esm/plugins/add-new-line/add-new-line.js';
+	import './node_modules/jodit/esm/plugins/fullsize/fullsize.js';
+	import de from './node_modules/jodit/esm/langs/de.js';
+
+	Jodit.langs.de = de;
+
+	Jodit.make('#editor', {
+		width: 600,
+		height: 400,
+		language: 'de'
+	});
 </script>
 ```
 
@@ -108,137 +109,36 @@ You can connect the necessary plugins and languages yourself:
 ```html
 <link
 	rel="stylesheet"
-	href="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.84/es2021/jodit.min.css"
+	href="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.86/es2021/jodit.min.css"
 />
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.84/es2021/jodit.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jodit/4.0.0-beta.86/es2021/jodit.min.js"></script>
 ```
 
 #### unpkg
 
-
 ```html
 <link
 	rel="stylesheet"
-	href="https://unpkg.com/jodit@4.0.0-beta.84/es2021/jodit.min.css"
+	href="https://unpkg.com/jodit@4.0.0-beta.86/es2021/jodit.min.css"
 />
-<script src="https://unpkg.com/jodit@4.0.0-beta.84/es2021/jodit.min.js"></script>
+<script src="https://unpkg.com/jodit@4.0.0-beta.86/es2021/jodit.min.js"></script>
 ```
 
+### Usage
 
-
-### USAGE
-
-And some `<textarea>` element
+Add a <textarea> element to your HTML:
 
 ```html
 <textarea id="editor" name="editor"></textarea>
 ```
 
-After this, you can init Jodit plugin
+Initialize Jodit on the textarea:
 
 ```javascript
 const editor = Jodit.make('#editor');
 editor.value = '<p>start</p>';
 ```
 
-with jQuery
-
-```javascript
-$('textarea').each(function () {
-	const editor = Jodit.make(this);
-	editor.value = '<p>start</p>';
-});
-```
-
-## For contributors:
-
-```bash
-git clone https://github.com/xdan/jodit.git
-cd jodit
-npm ci
-```
-
-Run webpack Hot Reload server:
-
-```bash
-npm start
-```
-
-Demo will be available here
-
-```
-http://localhost:2000/
-```
-
-Build min files:
-
-```bash
-make build
-```
-
-Build without some plugins:
-
-```bash
-make build es=es2021 uglify=true excludePlugins="about,source,bold,image,xpath,stat,class-span,color,clean-html,file,focus,enter,backspace,media,preview,pint,redo-undo,resize-cells,search,spellcheck,table"
-```
-
-Build without some languages:
-
-```bash
-make build es=es2021 uglify=true excludeLanguages="ru,ar,cs_cz,de,es,fa,fr,he,hu,id,it,ja,ko,nl,pl,pt_br,ru,tr,zh_cn,zh_tw"
-```
-
-Run tests:
-
-```bash
-make test browsers ChromeHeadless,IE,Firefox
-```
-
-or
-
-```bash
-make test
-```
-
-or
-
-```bash
-npm test
-```
-
-For checking tests in browser, open URL:
-
-```
-http://localhost:2000/test/test.html
-```
-
-For testing FileBrowser and Uploader modules, need install [PHP Connector](https://github.com/xdan/jodit-connectors)
-
-```bash
-composer create-project --no-dev jodit/connector
-```
-
-Run test PHP server
-
-```bash
-php -S localhost:8181 -t ./
-```
-
-and set options for Jodit:
-
-```javascript
-const editor = Jodit.make('#editor', {
-	uploader: {
-		url: 'http://localhost:8181/index-test.php?action=fileUpload'
-	},
-	filebrowser: {
-		ajax: {
-			url: 'http://localhost:8181/index-test.php'
-		}
-	}
-});
-```
-
 ### Create plugin
 
 ```javascript
@@ -337,6 +237,35 @@ const editor = Jodit.make('.someselector', {
 });
 ```
 
+## FileBrowser and Uploader
+
+For testing FileBrowser and Uploader modules, need install [PHP Connector](https://github.com/xdan/jodit-connectors)
+
+```bash
+composer create-project --no-dev jodit/connector
+```
+
+Run test PHP server
+
+```bash
+php -S localhost:8181 -t ./
+```
+
+and set options for Jodit:
+
+```javascript
+const editor = Jodit.make('#editor', {
+	uploader: {
+		url: 'http://localhost:8181/index-test.php?action=fileUpload'
+	},
+	filebrowser: {
+		ajax: {
+			url: 'http://localhost:8181/index-test.php'
+		}
+	}
+});
+```
+
 ## Browser Support
 
 -   Internet Explorer 11
@@ -345,11 +274,6 @@ const editor = Jodit.make('.someselector', {
 -   Latest Safari
 -   Microsoft Edge
 
-## Contributing
-
-This project is maintained by a community of developers. Contributions are welcome and appreciated. You can find Jodit on GitHub; feel free to start an issue or create a pull requests:
-https://github.com/xdan/jodit
-
 ## License
 
 MIT