@syncfusion/ej2-vue-richtexteditor 31.2.3 → 31.2.4
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 +90 -46
- package/dist/ej2-vue-richtexteditor.umd.min.js +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,39 +1,31 @@
|
|
|
1
|
-
# Vue
|
|
1
|
+
# Vue Rich Text Editor Component | Vue Markdown Editor
|
|
2
2
|
|
|
3
|
-
The [Vue Rich Text Editor](https://www.syncfusion.com/vue-ui-components/vue-wysiwyg-rich-text-editor?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm)
|
|
3
|
+
The [Vue Rich Text Editor](https://www.syncfusion.com/vue-ui-components/vue-wysiwyg-rich-text-editor?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm) is a feature-rich WYSIWYG HTML editor and Markdown editor. The Rich Text Editor is widely used to create blogs, forum posts, notes sections, comment sections, messaging applications, and more. The control provides an efficient user interface for a better editing experience with mobile support. It has a variety of tools to edit and format rich content, and it return a valid HTML markup or Markdown (MD) content. It allows users to insert images, links, tables, media files and lists with modular architectures.
|
|
4
4
|
|
|
5
|
-
<
|
|
6
|
-
<
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
</
|
|
5
|
+
<div align="center">
|
|
6
|
+
<h4>
|
|
7
|
+
<a href="https://ej2.syncfusion.com/react/documentation/rich-text-editor/getting-started/?utm_source=npm&utm_medium=listing&utm_campaign=react-richtexteditor-npm">📖Getting started</a> •
|
|
8
|
+
<a href="https://ej2.syncfusion.com/react/demos/?utm_source=npm&utm_medium=listing&utm_campaign=react-richtexteditor-npm#/bootstrap5/rich-text-editor/tools">🚀Online demos</a> •
|
|
9
|
+
<a href="https://www.syncfusion.com/react-components/react-wysiwyg-rich-text-editor?utm_source=npm&utm_medium=listing&utm_campaign=react-richtexteditor-npm">🌐Learn more</a>
|
|
10
|
+
</h4>
|
|
11
|
+
</div>
|
|
10
12
|
|
|
11
13
|
<p align="center">
|
|
12
|
-
<img src="https://raw.githubusercontent.com/SyncfusionExamples/nuget-img/master/
|
|
14
|
+
<img src="https://raw.githubusercontent.com/SyncfusionExamples/nuget-img/master/javascript/javascript-rich-text-editor-new.gif" alt="Vue RichTextEditor Component"/>
|
|
13
15
|
</p>
|
|
14
16
|
|
|
15
17
|
<p align="center">
|
|
16
18
|
Trusted by the world's leading companies
|
|
17
19
|
<a href="https://www.syncfusion.com">
|
|
18
|
-
<img src="https://
|
|
20
|
+
<img src="https://ej2.syncfusion.com/home/images/trusted_companies.png" alt="Bootstrap logo">
|
|
19
21
|
</a>
|
|
20
22
|
</p>
|
|
21
23
|
|
|
22
|
-
##
|
|
23
|
-
|
|
24
|
-
### Create a Vue Application
|
|
24
|
+
## ⚡️ Quick Start
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm install -g @vue/cli
|
|
30
|
-
vue create quickstart
|
|
31
|
-
cd quickstart
|
|
32
|
-
npm run serve
|
|
33
|
-
```
|
|
34
|
-
Initiating a new project prompts us to choose the type of project to be used for the current application. Select the option `Default ([Vue 2] babel, eslint)` from the menu.
|
|
26
|
+
Syncfusion <sup>®</sup> Rich Text Editor is easy to integrate into Vue 2 applications. Just install the package, configure styles, register the component, inject required modules, and render the editor.
|
|
35
27
|
|
|
36
|
-
###
|
|
28
|
+
### 🛠️ Installation
|
|
37
29
|
|
|
38
30
|
All Syncfusion<sup>®</sup> Vue packages are published in [npmjs.com](https://www.npmjs.com/~syncfusionorg) registry. To install Vue Rich Text Editor package, use the following command.
|
|
39
31
|
|
|
@@ -41,18 +33,26 @@ All Syncfusion<sup>®</sup> Vue packages are published in [npmjs.com](https://ww
|
|
|
41
33
|
npm install @syncfusion/ej2-vue-richtexteditor --save
|
|
42
34
|
```
|
|
43
35
|
|
|
44
|
-
|
|
36
|
+
This command will:
|
|
45
37
|
|
|
46
|
-
|
|
38
|
+
- Add the `@syncfusion/ej2-vue-richtexteditor` package and its peer dependencies to your `package.json` file.
|
|
47
39
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
Vue
|
|
40
|
+
### ⚙️ Setup
|
|
41
|
+
|
|
42
|
+
#### 1. Create a Vue Application
|
|
43
|
+
|
|
44
|
+
You can use [`Vue CLI`](https://github.com/vuejs/vue-cli) to setup your Vue 2 applications.To install Vue CLI use the following commands.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm install -g @vue/cli
|
|
48
|
+
vue create quickstart
|
|
49
|
+
cd quickstart
|
|
50
|
+
npm run serve
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
>
|
|
53
|
+
> 💡 Initiating a new project prompts us to choose the type of project to be used for the current application. Select the option `Default ([Vue 2] babel, eslint)` from the menu.
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
#### 2. Add CSS References
|
|
56
56
|
|
|
57
57
|
Add CSS references needed for Rich Text Editor in **style** section of the **App.vue** file from **../node_modules/@syncfusion** package folder.
|
|
58
58
|
|
|
@@ -69,14 +69,28 @@ Add CSS references needed for Rich Text Editor in **style** section of the **App
|
|
|
69
69
|
</style>
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
### 🧩 Register the Rich Text Editor Component
|
|
73
|
+
|
|
74
|
+
Register the Rich Text Editor globally using `Vue.use()`:
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
import { RichTextEditorPlugin } from '@syncfusion/ej2-vue-richtexteditor';
|
|
78
|
+
Vue.use(RichTextEditorPlugin);
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
<blockquote>
|
|
82
|
+
<p>ℹ️ <b>Note:</b></p>
|
|
83
|
+
<span><code>RichTextEditorPlugin</code> will globally register the Rich Text Editor component and its child directives. For detailed information on module injection, refer to the <a href="https://ej2.syncfusion.com/vue/documentation/rich-text-editor/module">Documentation</a></span>
|
|
84
|
+
</blockquote>
|
|
85
|
+
|
|
86
|
+
### 🧩 Add the Rich Text Editor Component
|
|
73
87
|
|
|
74
88
|
Add the Vue Rich Text Editor by using **ejs-richtexteditor** selector in **template** section of the **App.vue** file.
|
|
75
89
|
|
|
76
90
|
```html
|
|
77
91
|
<template>
|
|
78
92
|
<ejs-richtexteditor ref="defaultRTE" :height="400">
|
|
79
|
-
|
|
93
|
+
<p>Start editing your content here.</p>
|
|
80
94
|
</ejs-richtexteditor>
|
|
81
95
|
</template>
|
|
82
96
|
|
|
@@ -106,33 +120,63 @@ Add the Vue Rich Text Editor by using **ejs-richtexteditor** selector in **templ
|
|
|
106
120
|
```
|
|
107
121
|
> Refer the [Getting Started with Vue3](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/get-started/#getting-started) for using Syncfusion<sup>®</sup> Vue components in Vue 3 applications.
|
|
108
122
|
|
|
109
|
-
## Supported frameworks
|
|
123
|
+
## 🛠️ Supported frameworks
|
|
110
124
|
|
|
111
|
-
|
|
125
|
+
Rich Text Editor component is also offered in the following frameworks.
|
|
112
126
|
|
|
113
|
-
| [<img src="https://ej2.syncfusion.com/github/images/js.svg" height="50" />](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github)<br/> [JavaScript](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/angular-new.svg" height="50" />](https://www.syncfusion.com/angular-components/?utm_medium=listing&utm_source=github)<br/> [Angular](https://www.syncfusion.com/angular-components/?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/
|
|
127
|
+
| [<img src="https://ej2.syncfusion.com/github/images/js.svg" height="50" />](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github)<br/> [JavaScript](https://www.syncfusion.com/javascript-ui-controls?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/angular-new.svg" height="50" />](https://www.syncfusion.com/angular-components/?utm_medium=listing&utm_source=github)<br/> [Angular](https://www.syncfusion.com/angular-components/?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/react.svg" height="50" />](https://www.syncfusion.com/react-ui-components?utm_medium=listing&utm_source=github)<br/> [React](https://www.syncfusion.com/react-ui-components?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/netcore.svg" height="50" />](https://www.syncfusion.com/aspnet-core-ui-controls?utm_medium=listing&utm_source=github)<br/> [ASP.NET Core](https://www.syncfusion.com/aspnet-core-ui-controls?utm_medium=listing&utm_source=github) | [<img src="https://ej2.syncfusion.com/github/images/netmvc.svg" height="50" />](https://www.syncfusion.com/aspnet-mvc-ui-controls?utm_medium=listing&utm_source=github)<br/> [ASP.NET MVC](https://www.syncfusion.com/aspnet-mvc-ui-controls?utm_medium=listing&utm_source=github) |
|
|
114
128
|
| :-----: | :-----: | :-----: | :-----: | :-----: |
|
|
115
129
|
|
|
116
|
-
## Showcase samples
|
|
130
|
+
## 🏗️ Showcase samples
|
|
117
131
|
|
|
118
|
-
* [Vue HTML editor
|
|
119
|
-
* [Blog posting using
|
|
120
|
-
* [Vue Markdown editor
|
|
121
|
-
* [Vue live
|
|
132
|
+
* [Vue HTML editor demo](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/tools.html)
|
|
133
|
+
* [Blog posting using Vue rich text editor demo](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/blog-posting.html)
|
|
134
|
+
* [Vue Markdown editor demo](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/markdown-editor.html)
|
|
135
|
+
* [Vue live Markdown editor demo](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/online-html-editor.html)
|
|
122
136
|
|
|
123
|
-
## Key features
|
|
137
|
+
## ✨ Key features
|
|
124
138
|
|
|
125
139
|
* [Edit mode](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/iframe.html) - HTML content is possible to edit in a `div` element or an `iframe` in the rich text editor.
|
|
140
|
+
|
|
141
|
+
* [@Mentions](https://ej2.syncfusion.com/vue/demos/#/bootstrap5/rich-text-editor/mention-integration.html) - Easily mention users, tags, or items with an autocomplete suggestion list.
|
|
142
|
+
|
|
143
|
+
* [Slash Menu Support](https://ej2.syncfusion.com/vue/demos/#/bootstrap5/rich-text-editor/smart-suggestion.html) - Quickly insert content blocks using the `/` command.
|
|
144
|
+
|
|
145
|
+
* [Checklist Suport](https://ej2.syncfusion.com/demos/?utm_source=npm&utm_medium=listing&utm_campaign=javascript-rich-text-editor-npm/#/bootstrap5/rich-text-editor/tools.html) - Allows users to create checklists (to-do lists) directly within the editor. Users can easily add interactive checkbox items to their content.
|
|
146
|
+
|
|
147
|
+
* [Accessibility & WCAG 2.0 Compliance](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/accessibility) - Ensures full accessibility support, making it user-friendly for people who rely on assistive technologies (AT) or keyboard navigation.
|
|
148
|
+
|
|
149
|
+
* [Preventing Cross-Site Scripting (XSS)](https://ej2.syncfusion.com/aspnetcore/documentation/rich-text-editor/prevent-cross-site-scripting/?utm_source=npm&utm_medium=listing&utm_campaign=javascript-richtexteditor-npm) - The Rich Text Editor allows users to edit the content with security by preventing cross-site scripting (XSS).
|
|
150
|
+
|
|
151
|
+
* [HTML code editing](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/miscellaneous/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm#code-view) - The rich text editor allows users to edit the HTML code directly in the HTML code view. This can be useful for users who are familiar with HTML and want to have more control over the formatting and layout of their content.
|
|
152
|
+
|
|
126
153
|
* [Markdown editor](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/markdown-preview.html) - The rich text editor allows you to edit Markdown content using the Markdown syntax.
|
|
154
|
+
|
|
127
155
|
* [Markdown content preview](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/markdown-preview.html) - Preview of the modified Markdown content in the editor, you can give users the ability to see what the formatted content will look like before they save it.
|
|
128
|
-
|
|
156
|
+
|
|
129
157
|
* [Tools](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/toolbar/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm#toolbar-items) - The rich text editor handles a wide range of features, including inserting images, hyperlinks, tables, formatting tools, and more.
|
|
158
|
+
|
|
130
159
|
* [Toolbar appearance](https://ej2.syncfusion.com/vue/demos/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm/#/bootstrap5/rich-text-editor/types.html) - The rich text editor can provide a fully customizable toolbar that allows users to access the various formatting and editing options that are available.
|
|
131
|
-
|
|
160
|
+
|
|
161
|
+
* [Export and Import](https://ej2.syncfusion.com/vue/demos/#/bootstrap5/rich-text-editor/export-document.html) - Supports exporting content to PDF, and Word formats.
|
|
162
|
+
|
|
163
|
+
* [Copy and paste](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/paste-cleanup") - Copy and paste from Microsoft Word, Outlook, or other editors or sources while preserving formatting, styles, and structure.
|
|
164
|
+
|
|
165
|
+
* [Undo and redo](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/undo-redo) - Users can use undo and redo actions to reverse or repeat actions they took while editing the content.
|
|
166
|
+
|
|
132
167
|
* [Module injection](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/getting-started/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm#module-injection) - It is possible to create a editor that utilizes a modular library to load the necessary functionality on demand. This can be useful for optimizing the performance of the editor.
|
|
168
|
+
|
|
133
169
|
* [Third-party integration](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/third-party-integration/?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm#third-party-integration) - It is possible to integrate a third-party library into a rich text editor to add additional functionality or features to the editor like `Code-mirror`, `Embedly` and more.
|
|
134
170
|
|
|
135
|
-
##
|
|
171
|
+
## 📚 Resources
|
|
172
|
+
|
|
173
|
+
* [Documentation](https://ej2.syncfusion.com/vue/documentation/rich-text-editor/getting-started)
|
|
174
|
+
* [Theme Studio](https://ej2.syncfusion.com/themestudio/)
|
|
175
|
+
* [What's New](https://www.syncfusion.com/products/whatsnew/vue?utm_medium=listing&utm_source=github)
|
|
176
|
+
* [Road Map](https://www.syncfusion.com/products/roadmap/vue)
|
|
177
|
+
* [E-Books](https://www.syncfusion.com/succinctly-free-ebooks?searchkey=vue&type=all)
|
|
178
|
+
|
|
179
|
+
## 🤝 Support
|
|
136
180
|
|
|
137
181
|
Product support is available through following mediums.
|
|
138
182
|
|
|
@@ -142,13 +186,13 @@ Product support is available through following mediums.
|
|
|
142
186
|
* [Request feature or report bug](https://www.syncfusion.com/feedback/vue?utm_source=npm&utm_medium=listing&utm_campaign=vue-richtexteditor-npm)
|
|
143
187
|
* Live chat
|
|
144
188
|
|
|
145
|
-
##
|
|
189
|
+
## 🔄 Change log
|
|
146
190
|
|
|
147
191
|
Check the changelog [here](https://github.com/syncfusion/ej2-vue-ui-components/blob/master/components/richtexteditor/CHANGELOG.md?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm). Get minor improvements and bug fixes every week to stay up to date with frequent updates.
|
|
148
192
|
|
|
149
|
-
## License and copyright
|
|
193
|
+
## ⚖️ License and copyright
|
|
150
194
|
|
|
151
|
-
> This is a commercial product and requires a paid license for possession or use. Syncfusion<sup>®</sup> licensed software, including this component, is subject to the terms and conditions of Syncfusion<sup>®</sup> [EULA](https://www.syncfusion.com/eula/es/). To acquire a license for
|
|
195
|
+
> This is a commercial product and requires a paid license for possession or use. Syncfusion<sup>®</sup> licensed software, including this component, is subject to the terms and conditions of Syncfusion<sup>®</sup> [EULA](https://www.syncfusion.com/eula/es/). To acquire a license for 140+ [Vue UI components](https://www.syncfusion.com/vue-components), you can [purchase](https://www.syncfusion.com/sales/products) or [start a free 30-day trial](https://www.syncfusion.com/account/manage-trials/start-trials).
|
|
152
196
|
> A free community [license](https://www.syncfusion.com/products/communitylicense) is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.
|
|
153
197
|
See [LICENSE FILE](https://github.com/syncfusion/ej2-vue-ui-components/blob/master/license?utm_source=npm&utm_medium=listing&utm_campaign=vue-rich-text-editor-npm) for more info.
|
|
154
198
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/*!
|
|
2
2
|
* filename: ej2-vue-richtexteditor.umd.min.js
|
|
3
|
-
* version : 31.2.
|
|
3
|
+
* version : 31.2.4
|
|
4
4
|
* Copyright Syncfusion Inc. 2001 - 2025. All rights reserved.
|
|
5
5
|
* Use of this code is subject to the terms of our license.
|
|
6
6
|
* A copy of the current license can be obtained at any time by e-mailing
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@syncfusion/ej2-vue-richtexteditor",
|
|
3
|
-
"version": "31.2.
|
|
3
|
+
"version": "31.2.4",
|
|
4
4
|
"description": "Essential JS 2 RichTextEditor component for Vue",
|
|
5
5
|
"author": "Syncfusion Inc.",
|
|
6
6
|
"license": "SEE LICENSE IN license",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"es2015": "dist/es6/ej2-vue-richtexteditor.es2015.js",
|
|
20
20
|
"readme": "ReadMe.md",
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@syncfusion/ej2-base": "~31.2.
|
|
22
|
+
"@syncfusion/ej2-base": "~31.2.4",
|
|
23
23
|
"@syncfusion/ej2-vue-base": "~31.2.2",
|
|
24
|
-
"@syncfusion/ej2-richtexteditor": "31.2.
|
|
24
|
+
"@syncfusion/ej2-richtexteditor": "31.2.4"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {},
|
|
27
27
|
"scripts": {
|