JavaScript
EditEdit This DocumentInstall NuGet
Demos
Support
Forum
FREE TRIAL
Search results

RichTextEditorModel API in JavaScript RichTextEditor API control

Interface for a class RichTextEditor

Properties

actionBegin

EmitType<ActionBeginEventArgs>

Triggers before command execution using toolbar items or executeCommand method. If you cancel this event, the command cannot be executed. Set the cancel argument to true to cancel the command execution.

actionComplete

EmitType<ActionCompleteEventArgs>

Triggers after command execution using toolbar items or executeCommand method.

afterImageDelete

EmitType<AfterImageDeleteEventArgs>

Event triggers when the selected image is cleared from the Rich Text Editor Content.

afterMediaDelete

EmitType<AfterMediaDeleteEventArgs>

Event triggers when the selected media is cleared from the Rich Text Editor Content.

afterPasteCleanup

EmitType<any>

Triggers after cleanup the copied content.

beforeDialogClose

EmitType<BeforeCloseEventArgs>

Event triggers when the dialog is being closed. If you cancel this event, the dialog remains opened. Set the cancel argument to true to prevent closing a dialog.

beforeDialogOpen

EmitType<BeforeOpenEventArgs>

Event triggers when the dialog is being opened. If you cancel this event, the dialog remains closed. Set the cancel argument to true to cancel the open of a dialog.

beforeFileUpload

EmitType<BeforeUploadEventArgs>

Event triggers before the media audio/video upload process.

beforeImageDrop

EmitType<ImageDropEventArgs>

Triggers before drop the image.

beforeImageUpload

EmitType<BeforeUploadEventArgs>

Event triggers before the image upload process.

beforePasteCleanup

EmitType<PasteCleanupArgs>

Triggers before cleanup the copied content.

beforeQuickToolbarOpen

EmitType<BeforeQuickToolbarOpenArgs>

Event triggers when the quick toolbar is being opened.

beforeSanitizeHtml

EmitType<BeforeSanitizeHtmlArgs>

Event triggers before sanitize the value. It’s only applicable to editorMode as HTML.

blur

EmitType<Object>

Triggers when Rich Text Editor is focused out.

change

EmitType<ChangeEventArgs>

Triggers only when Rich Text Editor is blurred and changes are done to the content.

created

EmitType<Object>

Triggers when the Rich Text Editor is rendered.

destroyed

EmitType<Object>

Triggers when the Rich Text Editor is destroyed.

dialogClose

EmitType<Object>

Event triggers after the dialog has been closed.

dialogOpen

EmitType<Object>

Event triggers when a dialog is opened.

fileRemoving

EmitType<RemovingEventArgs>

Event triggers when the selected media is cleared from the insert audio/video dialog.

fileSelected

EmitType<SelectedEventArgs>

Event triggers when the media is selected or dragged into the insert media audio/video dialog.

fileUploadFailed

EmitType<Object>

Event triggers when there is an error in the media upload.

fileUploadSuccess

EmitType<Object>

Event triggers when the media is successfully uploaded to the server side.

fileUploading

EmitType<UploadingEventArgs>

Event triggers when the selected media begins to upload in the insert media audio/video dialog.

focus

EmitType<Object>

Triggers when Rich Text Editor is focused in

imageRemoving

EmitType<RemovingEventArgs>

Event triggers when the selected image is cleared from the insert image dialog.

imageSelected

EmitType<SelectedEventArgs>

Event triggers when the image is selected or dragged into the insert image dialog.

imageUploadFailed

EmitType<Object>

Event triggers when there is an error in the image upload.

imageUploadSuccess

EmitType<Object>

Event triggers when the image is successfully uploaded to the server side.

imageUploading

EmitType<UploadingEventArgs>

Event triggers when the selected image begins to upload in the insert image dialog.

quickToolbarClose

EmitType<Object>

Event triggers after the quick toolbar has been closed.

quickToolbarOpen

EmitType<Object>

Event triggers when a quick toolbar is opened.

resizeStart

EmitType<ResizeArgs>

Triggers only when start resize the image.

resizeStop

EmitType<ResizeArgs>

Triggers only when stop resize the image.

resizing

EmitType<ResizeArgs>

Triggers only when resizing the image.

toolbarClick

EmitType<Object>

Triggers when Rich Text Editor Toolbar items is clicked.

toolbarStatusUpdate

EmitType<Object>

This event is deprecated and no longer works. Use updatedToolbarStatus event to get the undo and redo status.

updatedToolbarStatus

EmitType<ToolbarStatusEventArgs>

Triggers when the toolbar items status is updated.

autoSaveOnIdle

boolean

Enables or disables the auto-save option which performs the save action while in the idle state after typed content. If enabled, the Rich Text Editor will save the content on idle state with saveInterval property’s value. The change event will be triggered if the content has changed from the last saved state.

backgroundColor

BackgroundColorModel

Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.

<div id="defaultRTE"></div>
import { RichTextEditor, Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table } from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject(Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table);

    let defaultRTE: RichTextEditor = new RichTextEditor({
     toolbarSettings: {
            items: ['BackgroundColor']
        },
       backgroundColor :  { columns: 5, colorCode: { 'Custom': ['#ffff00', '#00ff00', '#00ffff', '#ff00ff', '#0000ff', '#ff0000', '#000080', '#008080', '#008000', '#800080', '#800000', '#808000', '#c0c0c0', '#000000',""] }}
    });
    defaultRTE.appendTo('#defaultRTE');

bulletFormatList

BulletFormatListModel

Predefine the advanced list types that populate in the bulletFormatList dropdown list from the toolbar.

cssClass

string

Specifies the CSS class name appended with the root element of the RichTextEditor. One or more custom CSS classes can be added to a RichTextEditor.

editorMode

EditorMode

Specifies the editing mode of the RichTextEditor.

  • HTML - Render Rich Text Editor as HTML editor using <IFRAME> element or content editable <div> element or <textarea> element.
  • Markdown - Render Rich Text Editor as markdown editor using <textarea>.

emojiPickerSettings

EmojiSettingsModel

Specifies the emoji picker options in Rich Text Editor with the following properties.

  • iconsSet – Specify an array of items representing emoji icons.
  • showSearchBox - Enables or disables the search box in an emoji picker.

enableAutoUrl

boolean

Enable enableAutoUrl to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise the given URL will automatically convert to absolute path URL by prefixing https:// for hyperlinks.

<div id="defaultRTE"></div>
import { RichTextEditor, Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table } from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject(Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table);

    let defaultRTE: RichTextEditor = new RichTextEditor({
     enableAutoUrl : true
    });
    defaultRTE.appendTo('#defaultRTE');

enableHtmlEncode

boolean

specifies the value whether the source code is displayed with encoded format.

enableHtmlSanitizer

boolean

Defines whether to allow the cross-scripting site or not.

enablePersistence

boolean

Enables or disables the persisting component’s state between page reloads. If enabled, the value of Rich Text Editor is persisted

<div id="defaultRTE"></div>
import { RichTextEditor, Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table } from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject(Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table);

    let defaultRTE: RichTextEditor = new RichTextEditor({
    enablePersistence : true
    });
    defaultRTE.appendTo('#defaultRTE');

enableResize

boolean

Enables or disables the resizing option in the editor. If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.

<div id="defaultRTE"></div>
import { RichTextEditor,Resize} from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject( Resize);

    let defaultRTE: RichTextEditor = new RichTextEditor({
    enableResize : true
    });
    defaultRTE.appendTo('#defaultRTE');

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enableTabKey

boolean

Allows the tab key action in the Rich Text Editor content.

<div id="defaultRTE"></div>
import { RichTextEditor, Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table } from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject(Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table);

    let defaultRTE: RichTextEditor = new RichTextEditor({
    enableTabKey : true
    });
    defaultRTE.appendTo('#defaultRTE');

enableXhtml

boolean

Specifies a value that indicates whether the xhtml is enabled or not.

enabled

boolean

Specifies a value that indicates whether the component is enabled or not.

<div id="defaultRTE"></div>
import { RichTextEditor, Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table } from '@syncfusion/ej2-richtexteditor';
RichTextEditor.Inject(Toolbar, Link, Image, Count, HtmlEditor, QuickToolbar, Table);

    let defaultRTE: RichTextEditor = new RichTextEditor({
    enabled : true
    });
    defaultRTE.appendTo('#defaultRTE');

enterKey

EnterKey

Specifies tag to be inserted when enter key is pressed.

  • P - When the enter key is pressed a p tag will be inserted and the default value of the Rich Text Editor will be <p><br></p>.
  • DIV - When the enter key is pressed a div tag will be inserted instead of the default P tag and the default value of the Rich Text Editor will be <div><br></div>.
  • BR - When the enter key is pressed a br tag will be inserted instead of the default P tag and the default value of the Rich Text Editor will be <br>.

fileManagerSettings

FileManagerSettingsModel

Specifies the image manager options in Rich Text Editor component and control with the following properties.

  • enable - set boolean value to enable or disable the image manager.
  • ajaxSettings - Specifies the AJAX settings of the image manager.
  • contextMenuSettings - Specifies the context menu settings of the image manager.
  • navigationPaneSettings - Specifies the navigation pane settings of the image manager.
  • toolbarSettings - Specifies the group of items aligned horizontally in the toolbar.
  • uploadSettings - Specifies the upload settings for the image manager.

floatingToolbarOffset

number

Preserves the toolbar at the top of the Rich Text Editor on scrolling and specifies the offset of the floating toolbar from documents top position

fontColor

FontColorModel

Predefine the color palette that can be rendered for font color toolbar command .

<div id="defaultRTE"></div>
import { RichTextEditor} from '@syncfusion/ej2-richtexteditor';

    let defaultRTE: RichTextEditor = new RichTextEditor({
    fontColor : { columns: 2, colorCode: { 'Custom': ['#ffff00',  '#008000', '#800080', '#800000', '#808000', '#c0c0c0', '#000000','']}},
    toolbarSettings: {
            items: ['FontColor']
        },
    });
    defaultRTE.appendTo('#defaultRTE');

fontFamily

FontFamilyModel

Predefine the font families that populate in font family dropdown list from the toolbar.

<div id="defaultRTE"></div>
let defaultRTE: RichTextEditor = new RichTextEditor({
  fontFamily: {
    default: "Segoe UI",
    width: "65px",
    items: [
      { text: "Segoe UI", value: "Segoe UI" },
      { text: "Arial", value: "Arial,Helvetica,sans-serif" },
      { text: "Courier New", value: "Courier New,Courier,monospace" },
      { text: "Georgia", value: "Georgia,serif" },
      { text: "Impact", value: "Impact,Charcoal,sans-serif" },
      { text: "Lucida Console", value: "Lucida Console,Monaco,monospace" },
      { text: "Tahoma", value: "Tahoma,Geneva,sans-serif" },
      { text: "Times New Roman", value: "Times New Roman,Times,serif" },
      { text: "Trebuchet MS", value: "Trebuchet MS,Helvetica,sans-serif" },
      { text: "Verdana", value: "Verdana,Geneva,sans-serif" }
    ]
  },
  toolbarSettings: {
    items: ["FontName"]
  }
});
defaultRTE.appendTo("#defaultRTE");

fontSize

FontSizeModel

Predefine the font sizes that populate in font size dropdown list from the toolbar.

<div id="defaultRTE"></div>
import { RichTextEditor } from "@syncfusion/ej2-richtexteditor";

let defaultRTE: RichTextEditor = new RichTextEditor({
  fontSize: {
    default: "10",
    width: "35px",
    items: [
      { text: "8", value: "8pt" },
      { text: "10", value: "10pt" },
      { text: "12", value: "12pt" },
      { text: "14", value: "14pt" },
      { text: "18", value: "18pt" },
      { text: "24", value: "24pt" },
      { text: "36", value: "36pt" }
    ]
  },
  toolbarSettings: {
    items: ["FontSize"]
  }
});
defaultRTE.appendTo("#defaultRTE");

format

FormatModel

Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.

<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';


let defaultRTE: RichTextEditor = new RichTextEditor({
  format: {
    default: "Paragraph",
    width: "65px",
    types: [
      { text: "Paragraph" },
      { text: "Code" },
      { text: "Quotation" },
      { text: "Heading 1" },
      { text: "Heading 2" },
      { text: "Heading 3" },
      { text: "Heading 4" },
      { text: "Heading 5" },
      { text: "Heading 6" }
    ]
  },
  toolbarSettings: {
    items: ["Formats"]
  }
});
defaultRTE.appendTo("#defaultRTE");

formatPainterSettings

FormatPainterSettingsModel

Specifies the format painter options in Rich Text Editor with the following properties.

  • allowedFormats - Sets the tag name selectors for elements from which the formats can be copied.
  • deniedFormats - Sets the selectors for elements from which formats cannot be copied.
<div id="defaultRTE"></div>
import { RichTextEditor, HtmlEditor, Toolbar, FormatPainter, } from "@syncfusion/ej2-richtexteditor";

RichTextEditor.Inject(HtmlEditor, Toolbar, FormatPainter);

let defaultRTE: RichTextEditor = new RichTextEditor({
    toolbarSettings: {
        items: ['FormatPainter'] 
    },
    formatPainterSettings:{
        allowedFormats: 'span; strong;',
        deniedFormats:'span(important)'
    }
});
defaultRTE.appendTo("#defaultRTE");

formatter

IFormatter

Customize keyCode to change the key value.

<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';

let defaultRTE: RichTextEditor = new RichTextEditor({
  formatter  : null
});
defaultRTE.appendTo("#defaultRTE");

height

string | number

Specifies the height of the Rich Text Editor component.

htmlAttributes

{ [key: string]: string }

Allows additional HTML attributes such as title, name, etc., and It will be accepts n number of attributes in a key-value pair format.

iframeSettings

IFrameSettingsModel

Specifies the items to be rendered in an iframe mode, and it has the following properties.

  • enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
  • attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
  • resources - we can add both styles and scripts to the iframe.
  • styles[] - An array of CSS style files to inject inside the iframe to display content
  • scripts[] - An array of JS script files to inject inside the iframe
<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';


let defaultRTE: RichTextEditor = new RichTextEditor({
  iframeSettings : {
    enable :true
  }
});
defaultRTE.appendTo("#defaultRTE");

inlineMode

InlineModeModel

Enable or disable the inline edit mode.

  • enable - set boolean value to enable or disable the inline edit mode.
  • onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline. If its set to false, upon clicking to the target element, the toolbar is opened.
<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';


let defaultRTE: RichTextEditor = new RichTextEditor({
  inlineMode : {
    enable :true
  }
});
defaultRTE.appendTo("#defaultRTE");

insertAudioSettings

AudioSettingsModel

Specifies the audio insert options in Rich Text Editor component and control with the following properties.

  • allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
  • layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor. Possible options are: ‘Inline’ and ‘Break’.

  • saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).

    If you want to insert a lot of tiny audios in the editor and don’t want a specific physical location for saving audios, you can opt to save format as Base64.

  • saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
  • path - Specifies the path of the location to store the audios and refer it to display the audios.

insertImageSettings

ImageSettingsModel

Specifies the image insert options in Rich Text Editor component and control with the following properties.

  • allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
  • display - Sets the default display for an image when it is inserted in to the RichTextEditor. Possible options are: ‘inline’ and ‘block’.
  • width - Sets the default width of the image when it is inserted in the RichTextEditor.

  • saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).

    If you want to insert a lot of tiny images in the editor and don’t want a specific physical location for saving images, you can opt to save format as Base64.

  • height - Sets the default height of the image when it is inserted in the RichTextEditor.
  • saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
  • path - Specifies the path of the location to store the images and refer it to display the images.
<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Link,
  Image,
  Count,
  HtmlEditor,
  QuickToolbar,
  Table
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(
  Toolbar,
  Link,
  Image,
  Count,
  HtmlEditor,
  QuickToolbar,
  Table
);
let defaultRTE: RichTextEditor = new RichTextEditor({
  insertImageSettings: {
    allowedTypes: [".jpeg", ".jpg", ".png"],
    display: "inline",
    width: "auto",
    height: "auto",
    saveFormat: "Blob"
  }
});
defaultRTE.appendTo("#defaultRTE");

insertVideoSettings

VideoSettingsModel

Specifies the video insert options in Rich Text Editor component and control with the following properties.

  • allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
  • layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor. Possible options are: ‘Inline’ and ‘Break’.
  • width - Sets the default width of the video when it is inserted in the RichTextEditor.

  • saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).

    If you want to insert a lot of tiny videos in the editor and don’t want a specific physical location for saving videos, you can opt to save format as Base64.

  • height - Sets the default height of the video when it is inserted in the RichTextEditor.
  • saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
  • path - Specifies the path of the location to store the videos and refer it to display the videos.

keyConfig

{ [key: string]: string }

Customizes the key actions in RichTextEditor. For example, when using German keyboard, the key actions can be customized using these shortcuts.

<div id="defaultRTE"></div>
import { RichTextEditor } from "@syncfusion/ej2-richtexteditor";

let defaultRTE: RichTextEditor = new RichTextEditor({
  keyConfig : { 'undo': 'ctrl+z',
    'redo': 'ctrl+y',
    'copy': 'ctrl+c'}
});
defaultRTE.appendTo("#defaultRTE");

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

maxLength

number

Specifies the maximum number of characters allowed in the Rich Text Editor component.

<div id="defaultRTE"></div>
import { RichTextEditor } from "@syncfusion/ej2-richtexteditor";

let defaultRTE: RichTextEditor = new RichTextEditor({
    maxLength : 500
});
defaultRTE.appendTo("#defaultRTE");

numberFormatList

NumberFormatListModel

Predefine the advanced list types that populate in the numberFormatList dropdown list from the toolbar.

pasteCleanupSettings

PasteCleanupSettingsModel

Specifies the pasting options in Rich Text Editor component and control with the following properties.

  • prompt - Set boolean value to enable or disable the prompt when pasting.
  • deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
  • allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
  • deniedTags - Specifies the tags to restrict when pasting in RTE.
  • keepFormat - Set boolean value to keep or remove the from when pasting.
  • plainText - Set boolean value to paste as plain text or not.
<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Link,
  Image,
  Count,
  HtmlEditor,
  QuickToolbar,
  PasteCleanup,
  Table
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(
  Toolbar,
  Link,
  Image,
  Count,
  HtmlEditor,
  QuickToolbar,
  Table,
  PasteCleanup
);

let defaultRTE: RichTextEditor = new RichTextEditor({
  pasteCleanupSettings: {
    prompt: false,
    deniedAttrs: null,
    allowedStyleProps: [
      "background",
      "background-color",
      "border",
      "border-bottom",
      "border-width",
      "clear",
      "visibility",
      "white-space",
      "width"
    ],
    deniedTags: null,
    keepFormat: true,
    plainText: false
  }
});
defaultRTE.appendTo("#defaultRTE");

placeholder

string

Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.

quickToolbarSettings

QuickToolbarSettingsModel

Specifies the items to be rendered in quick toolbar based on the target element.

  • It has following fields:
  • enable - set boolean value to show or hide the quick toolbar
  • actionOnScroll - it has two possible options
  • hide: The quickToolbar is closed when the parent element is scrolled.
  • none: The quickToolbar cannot be closed even the parent element is scrolled.
  • link - Specifies the items to be rendered in quick toolbar based on link element such as Open, Edit, and UnLink.
  • image - Specifies the items to be rendered in quick toolbar based on image element such as ‘Replace’, ‘Align’, ‘Caption’, ‘Remove’, ‘InsertLink’, ‘Display’, ‘AltText’, ‘Dimension’.
  • text - Specifies the items to be rendered in quick toolbar based on text element such as ‘Cut’, ‘Copy’, ‘Paste’.
<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
  quickToolbarSettings: {
    enable: true,
    actionOnScroll: "hide",
    link: ["Open", "Edit", "UnLink"],
    image: [
      "Replace",
      "Align",
      "Caption",
      "Remove",
      "-",
      "InsertLink",
      "Display",
      "AltText",
      "Dimension"
    ],
    text: ["Cut", "Copy", "Paste"]
  }
});
defaultRTE.appendTo("#defaultRTE");

readonly

boolean

The user interactions on the component are disabled, when set to true.

saveInterval

number

Specifies the saveInterval in milliseconds for autosave the value. The change event will be triggered if the content was changed from the last saved interval.

<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';

    let defaultRTE: RichTextEditor = new RichTextEditor({
    saveInterval : 500
    });
    defaultRTE.appendTo('#defaultRTE');

shiftEnterKey

ShiftEnterKey

Specifies tags to be inserted when shift+enter key is pressed.

  • BR - When the shift + enter key is pressed a br tag will be inserted which is the default behavior.
  • P - When the shift + enter key is pressed a p tag will be inserted instead of the default br tag.
  • DIV - When the shift + enter key is pressed a div tag will be inserted instead of the default br tag.

showCharCount

boolean

Sets Boolean value to enable or disable the display of the character counter.

<div id="defaultRTE"></div>
import { RichTextEditor } from '@syncfusion/ej2-richtexteditor';

let defaultRTE: RichTextEditor = new RichTextEditor({
  showCharCount: true
});
defaultRTE.appendTo("#defaultRTE");

showTooltip

boolean

Specify the value whether tooltip will be displayed for the Rich Text Editor toolbar.

tableSettings

TableSettingsModel

Specifies the table insert options in Rich Text Editor component and control with the following properties.

  • styles - Class name should be appended by default in table element. It helps to design the table in specific CSS styles always when inserting in editor.
  • width - Sets the default width of the table when it is inserted in the RichTextEditor.
  • minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
  • maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
  • resize - To enable resize the table.
<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  Table,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Table, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
  tableSettings: {
    width: "100%",
    styles: [
      {
        text: "Dashed Borders",
        command: "Table",
        subCommand: "Dashed"
      },
      {
        text: "Alternate Rows",
        command: "Table",
        subCommand: "Alternate"
      }
    ],
    resize: true,
    minWidth: 0,
    maxWidth: null
  }
});
defaultRTE.appendTo("#defaultRTE");

toolbarSettings

ToolbarSettingsModel

Specifies the group of items aligned horizontally in the toolbar as well as defined the toolbar rendering type. By default, toolbar is float at the top of the RichTextEditor. When you scroll down, the toolbar will scroll along with the page on Rich Text Editor with the specified offset value.

  • enable: set boolean value to show or hide the toolbar.
  • enableFloating: Set Boolean value to enable or disable the floating toolbar. Preserves the toolbar at top of the Rich Text Editor on scrolling.
  • type: it has two possible options
  • Expand: Hide the overflowing toolbar items in the next row. Click the expand arrow to view overflowing toolbar items
  • MultiRow: The toolbar overflowing items wrapped in the next row.

  • items: Specifies the array of items aligned horizontally in the toolbar.

    | and - can insert a vertical and horizontal separator lines in the toolbar.

  • itemConfigs: Modify the default toolbar item configuration like icon class.

    By default, The toolbar is rendered with scrollable in mobile devices and does not support the toolbar type.

<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  Table,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Table, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
    toolbarSettings: {
            items: ['Bold', 'Italic', 'Underline', 'StrikeThrough',
                'FontName', 'FontSize', 'FontColor', 'BackgroundColor',
                'LowerCase', 'UpperCase', 'SuperScript', 'SubScript', '|',
                'Formats', 'Alignments', 'OrderedList', 'UnorderedList',
                'Outdent', 'Indent', '|',
                'CreateTable', 'CreateLink', 'Image', '|', 'ClearFormat', 'Print',
                'SourceCode', 'FullScreen', '|', 'Undo', 'Redo'
            ]
        },
});
defaultRTE.appendTo("#defaultRTE");

undoRedoSteps

number

Specifies the count of undo history which is stored in undoRedoManager.

<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  Table,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Table, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
    undoRedoSteps : 10
});
defaultRTE.appendTo("#defaultRTE");

undoRedoTimer

number

Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.

value

string

Specifies the value displayed in the RichTextEditor’s content area and it should be string. The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.

<div id="defaultRTE"></div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  Table,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Table, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
    value : 'rich text editor'
});
defaultRTE.appendTo("#defaultRTE");

valueTemplate

string | Function

Accepts the template design and assigns it as RichTextEditor’s content. The built-in template engine which provides options to compile template string into a executable function. For EX: We have expression evolution as like ES6 expression string literals

<div id="defaultRTE">
    <p> Rich Text Editor </p>
</div>
import {
  RichTextEditor,
  Toolbar,
  Image,
  Link,
  HtmlEditor,
  Table,
  QuickToolbar,
  NodeSelection
} from "@syncfusion/ej2-richtexteditor";
RichTextEditor.Inject(Toolbar, Table, Image, Link, HtmlEditor, QuickToolbar);

let defaultRTE: RichTextEditor = new RichTextEditor({
});
defaultRTE.appendTo("#defaultRTE");

width

string | number

Specifies the width of the RichTextEditor.

Previous
Next