Editor Value in Angular Rich Text Editor Component
17 May 202524 minutes to read
Set placeholder text
Specifies the placeholder for the Rich Text Editor’s content used when the editor’s content area is empty through the placeholder
property.
You can customize the appearance of the placeholder text by targeting the e-rte-placeholder
class in your CSS. This allows you to modify properties such as font family, color, and other styles.
.e-richtexteditor .e-rte-placeholder {
font-family: monospace;
}
import { Component } from '@angular/core';
import { RichTextEditorModule, ToolbarService, HtmlEditorService, QuickToolbarService, ImageService, LinkService, TableService, PasteCleanupService, ToolbarSettingsModel } from '@syncfusion/ej2-angular-richtexteditor';
@Component({
imports: [
RichTextEditorModule
],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor id='editor' placeholder='Type Something'></ejs-richtexteditor>`,
providers: [ToolbarService, HtmlEditorService, QuickToolbarService, ImageService, LinkService, TableService, PasteCleanupService]
})
export class AppComponent {
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Get and set value
Setting Values
You can set the initial content of the Rich Text Editor using the value
property. There are two methods to accomplish this:
-
Using the
value
property directly. -
Using
ng-template
as thevaluetemplate
property allows you to customize the content of the Rich Text Editor.
Reterieving Values
To get the content from the Rich Text Editor, use the following approaches:
- Using the value property: This returns the current content of the editor.
import { Component, ViewChild } from '@angular/core';
import { RichTextEditorAllModule } from '@syncfusion/ej2-angular-richtexteditor';
import { ToolbarService, LinkService, ImageService, HtmlEditorService, ToolbarSettingsModel, RichTextEditorComponent } from '@syncfusion/ej2-angular-richtexteditor';
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
@Component({
imports: [RichTextEditorAllModule],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor #editor [toolbarSettings]='tools' placeholder='Start to type a content to save' >
</ejs-richtexteditor>`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService]
})
export class AppComponent {
@ViewChild('editor')
public editorObj!: RichTextEditorComponent;
private editorValue!: string;
public tools: ToolbarSettingsModel = {
items: [
'Bold',
'Italic',
'Underline',
'|',
'Formats',
'Alignments',
'Blockquote',
'OrderedList',
'UnorderedList',
'|',
'CreateLink',
'Image',
'|',
'SourceCode',
'Undo',
'Redo',
],
};
ngAfterViewInit() {
//insert the content to the editor using value property
this.editorObj.value = '<p>Welcome to the Syncfusion Rich Text Editor</p>';
//Get the value from the editor
this.editorValue = this.editorObj.value;
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app/app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
- Using the change event: The
change
event is triggered when the Rich Text Editor loses focus and its content has been modified. This event allows you to capture and handle content changes dynamically.
import { Component, ViewChild } from '@angular/core';
import { RichTextEditorAllModule, ChangeEventArgs } from '@syncfusion/ej2-angular-richtexteditor';
import { ToolbarService, LinkService, ImageService, HtmlEditorService, ToolbarSettingsModel, RichTextEditorComponent } from '@syncfusion/ej2-angular-richtexteditor';
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
@Component({
imports: [RichTextEditorAllModule],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor #editor [toolbarSettings]='tools' placeholder='Start to type a content to save' (change)="onChange($event)">
</ejs-richtexteditor>`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService]
})
export class AppComponent {
@ViewChild('editor')
public editorObj!: RichTextEditorComponent;
public tools: ToolbarSettingsModel = {
items: [
'Bold',
'Italic',
'Underline',
'|',
'Formats',
'Alignments',
'Blockquote',
'OrderedList',
'UnorderedList',
'|',
'CreateLink',
'Image',
'|',
'SourceCode',
'Undo',
'Redo',
],
};
public onChange(args: ChangeEventArgs): void {
console.log('Rich Text Editor value is:' + args.value);
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Two-way binding value
Two-way binding allows you to synchronize data between the component and the view. In the context of the Rich Text Editor, it enables you to keep the editor’s content in sync with a property in your component.
To implement two-way binding with the Rich Text Editor, you can use the [(value)]
directive. This allows you to bind the editor’s value to a property in your component, ensuring that changes in either the component or the editor are reflected in both places.
Here’s an example of how to implement two-way binding with the Rich Text Editor:
import { Component } from '@angular/core';
import { ToolbarService, LinkService, ImageService, HtmlEditorService } from '@syncfusion/ej2-angular-richtexteditor';
@Component({
selector: 'app-root',
template: `
<h3>Editor 1</h3>
<ejs-richtexteditor id="editor1" [(value)]="editorContent"></ejs-richtexteditor>
<h3>Editor 2</h3>
<ejs-richtexteditor id="editor2" [(value)]="editorContent"></ejs-richtexteditor>
`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService]
})
export class AppComponent {
public editorContent: string = 'Initial content';
ngOnInit() {
// You can update the content programmatically
setTimeout(() => {
this.editorContent = 'Updated content after 1 seconds';
}, 1000);
}
}
With this setup, any changes made in the Rich Text Editor will update the editorContent
property, and any programmatic changes to editorContent
will update the editor’s content. This two-way binding ensures that your component always has the most up-to-date content from the editor, and vice versa.
Autosave
The auto-save option in the Rich Text Editor allows the content to be automatically saved during idle periods after you have typed. Once this option is enabled, the editor will save the content based on the saveInterval
property’s value, which is specified in milliseconds.
The change event will be triggered if the content has been modified since the last saved state, ensuring consistent tracking of changes without manual intervention.
import { Component, ViewChild } from '@angular/core';
import { RichTextEditorAllModule, ChangeEventArgs } from '@syncfusion/ej2-angular-richtexteditor';
import { ToolbarService, LinkService, ImageService, HtmlEditorService, ToolbarSettingsModel, RichTextEditorComponent } from '@syncfusion/ej2-angular-richtexteditor';
import { enableRipple } from '@syncfusion/ej2-base';
enableRipple(true);
@Component({
imports: [RichTextEditorAllModule],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor #autoSaveEditor (change)="onChange($event)" [toolbarSettings]='tools' placeholder='Start to type a content to save' >
</ejs-richtexteditor>`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService]
})
export class AppComponent {
@ViewChild('autoSaveEditor')
public editorObj!: RichTextEditorComponent;
private editorValue!: string;
private changedValue!: string;
public tools: ToolbarSettingsModel = {
items: [
'Bold',
'Italic',
'Underline',
'|',
'Formats',
'Alignments',
'Blockquote',
'OrderedList',
'UnorderedList',
'|',
'CreateLink',
'Image',
'|',
'SourceCode',
'Undo',
'Redo',
],
};
public onChange(args: ChangeEventArgs){
//here you can add your code
this.changedValue = args.value;
}
ngAfterViewInit() {
//insert the content to the editor using value property
this.editorObj.value = '<p>Welcome to the Syncfusion Rich Text Editor</p>';
//Get the value from the editor
this.editorValue = this.editorObj.value;
}
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app/app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Programmatic content access
You can use the getHtml public method to retrieve the Rich Text Editor content.
let editorValue: string = this.editorObj.getHtml();
To fetch the Rich Text Editor’s text content, use getText method.
let editorValue: string = this.editorObj.getText();
Encoded editor value
The enableHtmlEncode
property in the Rich Text Editor specifies whether the source code is displayed in an encoded format. Additionally, the value
property also returns the content in an encoded format. This feature is particularly useful when you want to ensure that HTML content is displayed safely without being interpreted by the browser.
import { Component, ViewChild } from '@angular/core';
import { RichTextEditorComponent } from '@syncfusion/ej2-angular-richtexteditor';
import { ToolbarService, LinkService, ImageService, HtmlEditorService, ToolbarSettingsModel } from '@syncfusion/ej2-angular-richtexteditor';
@Component({
imports: [
RichTextEditorModule
],
selector: 'app-root',
template: `<ejs-richtexteditor #Editor [enableHtmlEncode]='true' ></ejs-richtexteditor>`,
styleUrls: ['./app.component.css'],
standalone: true,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService]
})
export class AppComponent {
public value: string = "<p>Rich Text Editor is a WYSIWYG editing control which will reduce the effort for users while trying to express their formatting word content as HTML or Markdown format.</p><p><b>API’s:</b></p><ul><li><p>maxLength - allows restricting the maximum length to be entered.</p></li><li><p>readOnly - allows to change it as a non-editable state.</p></li><li><p>enabled - enable or disable the RTE component.</p></li><li><p>enableHtmlEncode - Get the encoded string value through value property and source code panel</p></li><li><p>getValue - get the value of RTE.</p></li><li><p>getSelection - get the selected text of RTE.</p></li><li><p>selectAll - select all content in RTE.</p></li></ul>";
}
Styling editor content
By default, the content styles of the Rich Text Editor are not included when retrieving the HTML value from the editor. This can result in the styles not being applied when using the HTML content outside of the editor. To ensure that the styles are correctly applied, you can copy and use the following styles directly in your application: These styles are used in the UI elements of the Rich Text Editor.
Make sure to add a CSS class ‘e-rte-content’ to the content container.
.e-rte-content p {
margin: 0 0 10px;
margin-bottom: 10px;
}
.e-rte-content li {
margin-bottom: 10px;
}
.e-rte-content h1 {
font-size: 2.17em;
font-weight: 400;
line-height: 1;
margin: 10px 0;
}
.e-rte-content h2 {
font-size: 1.74em;
font-weight: 400;
margin: 10px 0;
}
.e-rte-content h3 {
font-size: 1.31em;
font-weight: 400;
margin: 10px 0;
}
.e-rte-content h4 {
font-size: 1em;
font-weight: 400;
margin: 0;
}
.e-rte-content h5 {
font-size: 00.8em;
font-weight: 400;
margin: 0;
}
.e-rte-content h6 {
font-size: 00.65em;
font-weight: 400;
margin: 0;
}
.e-rte-content blockquote {
margin: 10px 0;
margin-left: 0;
padding-left: 5px;
}
.e-rte-content pre {
background-color: inherit;
border: 0;
border-radius: 0;
color: #333;
font-size: inherit;
line-height: inherit;
margin: 0 0 10px;
overflow: visible;
padding: 0;
white-space: pre-wrap;
word-break: inherit;
word-wrap: break-word;
}
.e-rte-content strong, .e-rte-content b {
font-weight: 700;
}
.e-rte-content a {
text-decoration: none;
-webkit-user-select: auto;
-ms-user-select: auto;
user-select: auto;
}
.e-rte-content a:hover {
text-decoration: underline;
}
.e-rte-content h3 + h4,
.e-rte-content h4 + h5,
.e-rte-content h5 + h6 {
margin-top: 00.6em;
}
.e-rte-content .e-rte-image.e-imgbreak {
border: 0;
cursor: pointer;
display: block;
float: none;
margin: 5px auto;
max-width: 100%;
position: relative;
}
.e-rte-content .e-rte-image {
border: 0;
cursor: pointer;
display: block;
float: none;
margin: auto;
max-width: 100%;
position: relative;
}
.e-rte-content .e-rte-image.e-imginline {
display: inline-block;
float: none;
margin-left: 5px;
margin-right: 5px;
max-width: calc(100% - (2 * 5px));
vertical-align: bottom;
}
.e-rte-content .e-rte-image.e-imgcenter {
cursor: pointer;
display: block;
float: none;
margin: 5px auto;
max-width: 100%;
position: relative;
}
.e-rte-content .e-rte-image.e-imgleft {
float: left;
margin: 0 5px 0 0;
text-align: left;
}
.e-rte-content .e-rte-image.e-imgright {
float: right;
margin: 0 0 0 5px;
text-align: right;
}
.e-rte-content .e-rte-img-caption {
display: inline-block;
margin: 5px auto;
max-width: 100%;
position: relative;
}
.e-rte-content .e-rte-img-caption.e-caption-inline {
display: inline-block;
margin: 5px auto;
margin-left: 5px;
margin-right: 5px;
max-width: calc(100% - (2 * 5px));
position: relative;
text-align: center;
vertical-align: bottom;
}
.e-rte-content .e-rte-img-caption.e-imgcenter {
display: block;
}
.e-rte-content .e-rte-img-caption .e-rte-image.e-imgright,
.e-rte-content .e-rte-img-caption .e-rte-image.e-imgleft {
float: none;
margin: 0;
}
.e-rte-content .e-rte-table {
border-collapse: collapse;
empty-cells: show;
}
.e-rte-content .e-rte-table td,
.e-rte-content .e-rte-table th {
border: 1px solid #bdbdbd;
height: 20px;
min-width: 20px;
padding: 2px 5px;
vertical-align: middle;
}
.e-rte-content .e-rte-table.e-dashed-border td,
.e-rte-content .e-rte-table.e-dashed-border th {
border-style: dashed;
}
.e-rte-content .e-rte-img-caption .e-img-inner {
box-sizing: border-box;
display: block;
font-size: 16px;
font-weight: initial;
margin: auto;
opacity: .9;
position: relative;
text-align: center;
width: 100%;
}
.e-rte-content .e-rte-img-caption .e-img-wrap {
display: inline-block;
margin: auto;
padding: 0;
width: 100%;
}
.e-rte-content blockquote {
border-left: solid 2px #333;
}
.e-rte-content a {
color: #2e2ef1;
}
.e-rte-content .e-rte-table th {
background-color: #e0e0e0;
}
Character count
The Character Count feature in the Rich Text Editor allows you to track and display the number of characters entered in the editor. This feature is particularly useful when you need to limit the content length or provide visual feedback to users about their input.
How to enable character count
To enable the character count feature, set the showCharCount
property to true
. By default, this property is set to false
.
When enabled, the character count is displayed at the bottom right corner of the editor.
To use quick
Character Count
feature, configureCountService
in the provider section.
Understanding character count color indicators
The character count color will be modified based on the characters in the Rich Text Editor.
Status | Description |
---|---|
normal | The character count color remains black until 70% of the maxLength count is reached. |
warning | When the character count reaches 70% of the maxLength, the color changes to orange, indicating that the maximum limit is approaching. |
error | Once the character count hits 90% of the maxLength, the color turns red, signaling that the limit is nearly reached. |
import { Component } from '@angular/core';
import { RichTextEditorModule, ToolbarService, LinkService, ImageService, HtmlEditorService, CountService, QuickToolbarService, TableService, PasteCleanupService } from '@syncfusion/ej2-angular-richtexteditor';
@Component({
imports: [
RichTextEditorModule
],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor id='editor' [showCharCount]='true' [maxLength]='maxLength'></ejs-richtexteditor>`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService, CountService, QuickToolbarService, TableService, PasteCleanupService]
})
export class AppComponent {
public maxLength = 2000;
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
Setting maximum character limit
You can restrict the number of characters entered in the editor by setting the maxLength
property to a specific numeric value. When set, the maximum allowable character count is displayed alongside the current count at the bottom right of the editor.
If maxLength
is not set, there is no limit to the character count in the editor.
Retrieving character count programmatically
You can programmatically get the current character count in the editor using the getCharCount
public method.
let editorCount: number = this.editor.getCharCount();
Source code editing
Rich Text Editor includes the ability for users to directly edit HTML code via Source View
in the text area. If you made any modification in Source view directly, the changes will be reflected in the Rich Text Editor’s content. So, the users will have more flexibility over the content they have created.
Configuring source code tool in the toolbar
You can add the SourceCode
tool in the Rich Text Editor using the toolbarSettings
items property.
import { Component } from '@angular/core';
import { RichTextEditorModule, ToolbarService, LinkService, ImageService, HtmlEditorService, QuickToolbarService, TableService, PasteCleanupService } from '@syncfusion/ej2-angular-richtexteditor';
@Component({
imports: [
RichTextEditorModule
],
standalone: true,
selector: 'app-root',
template: `<ejs-richtexteditor id='editor' [(value)]='value'></ejs-richtexteditor>`,
providers: [ToolbarService, LinkService, ImageService, HtmlEditorService, QuickToolbarService, TableService, PasteCleanupService]
})
export class AppComponent {
public value: string = "<p>The Rich Text Editor component is a WYSIWYG (\"what you see is what you get\") editor that provides the best user experience to create and update the content. Users can format their content using standard toolbar commands.</p> <p><b>Key features:</b></p> <ul><li>Provides <IFRAME> and <DIV> modes</li><li>Capable of handling markdown editing.</li><li>Contains a modular library to load the necessary functionality on demand.</li><li>Provides a fully customizable toolbar.</li><li>Provides HTML view to edit the source directly for developers.</li><li>Supports third-party library integration.</li><li>Allows preview of modified content before saving it.</li><li>Handles images, hyperlinks, videos, uploads, etc.</li><li>Contains undo/redo manager.</li><li>Creates bulleted and numbered lists.</li></ul>";
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));
This functionality can also be enabled through the use of the
CodeMirror
plugin. It helps to highlight the HTML content and ensures that any modifications in the code view are instantly reflected in the preview mode.
The Rich Text Editor provides the showSourceCode
method, which allows you to toggle programmatically between the code view and the formatted text view. When invoked, this method switches the editor’s view to the opposite state.