jodit-react 4.1.2 → 5.0.0-beta.1

package/.github/workflows/new-version.yml

@@ -10,11 +10,11 @@ jobs:
   newversion:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
           fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
-      - uses: actions/setup-node@v3 #Setup Node
+      - uses: actions/setup-node@v4 #Setup Node
         with:
           node-version-file: '.nvmrc'
           cache: 'npm'

package/.github/workflows/release.yml

@@ -13,8 +13,8 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3 #Setup Node
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4 #Setup Node
       with:
         node-version-file: '.nvmrc'
         cache: 'npm'
@@ -33,4 +33,4 @@ jobs:
 
     - name: Publish
       run: |
-        NPM_TOKEN=${{ secrets.NPM_TOKEN }} npm publish ./ --access public
+        NPM_TOKEN=${{ secrets.NPM_TOKEN }} npm publish ./ --access public --tag beta

package/.nvmrc

@@ -1 +1 @@
-18.17.1
+20

package/README.md

@@ -45,11 +45,10 @@ const Example = ({ placeholder }) => {
 	const editor = useRef(null);
 	const [content, setContent] = useState('');
 
-	const config = useMemo(
-		{
+	const config = useMemo(() => ({
 			readonly: false, // all options from https://xdsoft.net/jodit/docs/,
 			placeholder: placeholder || 'Start typings...'
-		},
+		}),
 		[placeholder]
 	);
 
@@ -71,7 +70,7 @@ const Example = ({ placeholder }) => {
 You can use all Jodit features and write your [own plugin](https://xdsoft.net/jodit/docs/modules/plugin.html) for example.
 
 ```js
-import JoditEditor, { Jodit } from '../../src/';
+import JoditEditor, { Jodit } from 'jodit-react';
 
 /**
  * @param {Jodit} jodit
@@ -96,9 +95,29 @@ function preparePaste(jodit) {
 Jodit.plugins.add('preparePaste', preparePaste);
 
 //...
-return <JoditEditor/>;
+return <JoditEditor />;
+```
+
+You can see how to write plugins [in the documentation](https://xdsoft.net/jodit/pro/docs/how-to/create-plugin.md) or [on the stand](https://xdsoft.net/jodit/pro/docs/getting-started/examples.md#jodit-example-paste-link)
+
+## Use with Jodit PRO
+
+You can connect any Jodit constructor and set it as the `JoditConstructor` property of the component.
+
+```jsx
+import React from 'react';
+import JoditEditor from 'jodit-react';
+import {Jodit} from 'jodit-pro';
+import 'jodit-pro/es5/jodit.min.css';
+// ...
+
+function App() {
+  return <JoditEditor JoditConstructor={Jodit} />;
+}
+
 ```
 
+
 ## License
 
 This package is available under `MIT` License.