jQuery HtmlEditor Options

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.

Type:

Default Value: false

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

allowSoftLineBreak

Allows users to break content into multiple lines within a single block element. The Shift + Enter key combination generates the new line.

Type:

Default Value: false

customizeModules

Allows you to customize the DevExtreme Quill and 3rd-party modules.

Type:

Function parameters:

config:

Module configurations.

The DevExtreme Quill modules and the API you can use to customize them are described in the Modules documentation section. For example, the History module, which handles the undo and redo operations, can be customized as follows:

jQuery

index.js

$(function() {
    $("#htmlEditorContainer").dxHtmlEditor({
        // ...
        customizeModules: function(config) {
            config.history = {
                delay: 0,
                maxStack: 5000
            }; 
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-html-editor ...
    [customizeModules]="customizeQuillModules">
</dx-html-editor>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    customizeQuillModules(config) {
        config.history = {
            delay: 0,
            maxStack: 5000
        }; 
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxHtmlEditorModule } from 'devextreme-angular';
@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxHtmlEditorModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxHtmlEditor ...
        :customize-modules="customizeQuillModules"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxHtmlEditor from 'devextreme-vue/html-editor';

export default {
    components: {
        DxHtmlEditor
    },
    methods: {
        customizeQuillModules(config) {
            config.history = {
                delay: 0,
                maxStack: 5000
            }; 
        }
    }
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import HtmlEditor from 'devextreme-react/html-editor';

class App extends React.Component {
    render() {
        return (
            <HtmlEditor ...
                customizeModules={this.customizeQuillModules}
            />
        );
    }
    customizeQuillModules(config) {
        config.history = {
            delay: 0,
            maxStack: 5000
        }; 
    }
}
export default App;

If 3rd-party modules are used in the HtmlEditor, refer to their documentation for information on the API.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Default Value: false

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Default Value: {}

jQuery

$(function(){
    $("#htmlEditorContainer").dxHtmlEditor({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-html-editor ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-html-editor>

import { DxHtmlEditorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxHtmlEditorModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxHtmlEditor ...
        :element-attr="htmlEditorAttributes">
    </DxHtmlEditor>
</template>

<script>
import DxHtmlEditor from 'devextreme-vue/html-editor';

export default {
    components: {
        DxHtmlEditor
    },
    data() {
        return {
            htmlEditorAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

App.js

import React from 'react';

import HtmlEditor from 'devextreme-react/html-editor';

class App extends React.Component {
    htmlEditorAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <HtmlEditor ...
                elementAttr={this.htmlEditorAttributes}>
            </HtmlEditor>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Default Value: true

height

Specifies the UI component's height.

Type:

|

|

Return Value:

|

The UI component's height.

Default Value: undefined

This property accepts a value of one of the following types:

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".
Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Default Value: false

imageUpload

Configures the image upload.

Type:

dxHtmlEditorImageUpload

Default Value: { tabs: ['url'], fileUploadMode: 'base64', uploadUrl: undefined, uploadDirectory: undefined }

Click the 'Add Image' toolbar button to invoke the 'Add an Image' dialog.

DevExtreme Html Editor - Upload Images Dialog

Use the fileUploadMode property to specify whether to upload images as is or in Base64 binary format. The tabs property specifies the visibility of tabs in the 'Add Image' dialog.

jQuery

index.js

$(function() {
    $("#htmlEditorContainer").dxHtmlEditor({
        // ...
        imageUpload: {
            fileUploadMode: 'both',
            tabs: ['url', 'file'],
            uploadUrl: 'https://js.devexpress.com/Demos/Upload'
            uploadDirectory: '/Images'
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-html-editor ...>
    <dxo-image-upload
        fileUploadMode="both"
        [tabs]="['url', 'file']"
        uploadUrl="https://js.devexpress.com/Demos/Upload"
        uploadDirectory="/Images">
    </dxo-image-upload>
</dx-html-editor>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxHtmlEditorModule } from 'devextreme-angular';
@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxHtmlEditorModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxHtmlEditor ...>
        <DxImageUpload
            fileUploadMode="both"
            :tabs="dialogTabs"
            uploadUrl="https://js.devexpress.com/Demos/Upload"
            uploadDirectory="/Images"
         />
    </DxHtmlEditor>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxHtmlEditor from 'devextreme-vue/html-editor';

export default {
    components: {
        DxHtmlEditor
    },
    methods: {
        // ...
    },
    data() {
        return {
            dialogTabs: ['url', 'file']
        };
    }         
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import HtmlEditor from 'devextreme-react/html-editor';

const dialogTabs = ['url', 'file'];

class App extends React.Component {
    render() {
        return (
            <HtmlEditor ...>
                <ImageUpload 
                    fileUploadMode="both"
                    :tabs={dialogTabs}
                    uploadUrl="https://js.devexpress.com/Demos/Upload"
                    uploadDirectory="/Images"
                />
            </HtmlEditor>
        );
    }
}
export default App;

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Default Value: true

NOTE

When you use async rules, isValid is true if the status is "pending" or "valid".

mediaResizing

Configures media resizing.

Type:

Default Value: null

mentions[]

Configures mentions.

Type:

Array<Object>

Default Value: null

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

Default Value: ''

Specify this property if the UI component lies within an HTML form that will be submitted.

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

HtmlEditor

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

any

Model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

HtmlEditor

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

any

Model data. Available only if you use Knockout.

Default Value: null

onFocusIn

A function that is executed when the UI component gets focus.

Type:

Function parameters:

e:

Information about the event that caused the function execution.

Object structure:

Name	Type	Description
model	any	Model data. Available only if you use Knockout.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	dxHtmlEditor	The UI component's instance.

Default Value: null

onFocusOut

A function that is executed when the UI component loses focus.

Type:

Function parameters:

e:

Information about the event that caused the function execution.

Object structure:

Name	Type	Description
model	any	Model data. Available only if you use Knockout.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	dxHtmlEditor	The UI component's instance.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

HtmlEditor

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

jQuery

Get a UI Component Instance

Angular

Get a UI Component Instance

Vue

Get a UI Component Instance

React

Get a UI Component Instance

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	any	Model data. Available only if you use Knockout.
fullName	String	The path to the modified property that includes all parent properties.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	HtmlEditor	The UI component's instance.
name	String	The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
value	any	The modified property's new value.
previousValue	any	The UI component's previous value.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery

index.js

$(function() {
    $("#htmlEditorContainer").dxHtmlEditor({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-html-editor ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-html-editor>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxHtmlEditorModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxHtmlEditorModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }

Vue

App.vue

<template> 
    <DxHtmlEditor ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxHtmlEditor from 'devextreme-vue/html-editor'; 

export default { 
    components: { 
        DxHtmlEditor
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>

React

App.js

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import HtmlEditor from 'devextreme-react/html-editor'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <HtmlEditor ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onValueChanged

A function that is executed after the UI component's value is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	HtmlEditor	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically.
model	any	Model data. Available only if Knockout is used.
previousValue	Object	The UI component's previous value.
value	Object	The UI component's new value.

Default Value: null

placeholder

Specifies the text displayed when the input field is empty.

Type:

Default Value: ''

readOnly

Specifies whether the editor is read-only.

Type:

Default Value: false

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

stylingMode

Specifies how the HtmlEditor's toolbar and content field are styled.

Type:

dxHtmlEditorTableContextMenu

Default Value: 'outlined'

Accepted Values: 'outlined' | 'underlined' | 'filled'

The following styles are available:

DevExtreme HTML5 JavaScript HtmlEditor Outlined Style

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

tableContextMenu

Configures table context menu settings.

Type:

Default Value: null

Table cells include a context menu with common table operation commands. To activate it, set the enabled property to true.

You can also use the items array to rearrange or hide menu commands.

tableResizing

Configures table resize.

Type:

Default Value: null

toolbar

Configures the UI component's toolbar.

Type:

dxHtmlEditorToolbar

Default Value: null

DevExtreme HTML5 JavaScript HtmlEditor Toolbar

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type: any

Default Value: null

validationErrors

An array of the validation rules that failed.

Type:

Array<any>

Default Value: null

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

Default Value: 'auto'

Accepted Values: 'always' | 'auto'

The following property values are possible:

auto
The tooltip with the message is displayed when the editor is in focus.
always
The tooltip with the message is not hidden when the editor loses focus.

validationMessagePosition

Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.

Type:

Default Value: 'bottom'

Accepted Values: 'bottom' | 'left' | 'right' | 'top'

The following example positions a validation message at the component's right:

jQuery

index.js

$(function() {
    $("#htmlEditorContainer").dxHtmlEditor({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

Angular

app.component.html

<dx-html-editor ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-html-editor>

Vue

App.vue

<template>
    <DxHtmlEditor ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxHtmlEditor>
</template>

<script>
    // ...
</script>

React

App.js

import React from 'react';
// ...

function App() {
    return (
        <HtmlEditor ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </HtmlEditor>
    ); 

};
export default App;

validationStatus

Indicates or specifies the current validation status.

Type:

Default Value: 'valid'

Accepted Values: 'valid' | 'invalid' | 'pending'

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

jQuery

index.js

$(function() {
    const htmlEditor = $("#htmlEditorContainer").dxHtmlEditor({
        // ...
    }).dxHtmlEditor("instance");

    function setInvalidStatus(message) {
        htmlEditor.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

Angular

app.component.html

app.component.ts

<dx-html-editor
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-html-editor>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

Vue

App.vue

<template>
    <DxHtmlEditor ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

React

App.js

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <HtmlEditor
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

value

Specifies the UI component's value.

Type: any

Default Value: null

Raised Events: onValueChanged

valueType

Specifies in which markup language the value is stored.

Type:

Default Value: 'html'

Accepted Values: 'html' | 'markdown'

Markdown requires the turndown and showdown libraries. If you use browser scripts, link them before the DevExtreme scripts as shown below:

<script src="https://unpkg.com/turndown/dist/turndown.js"></script>
<script src="https://unpkg.com/showdown/dist/showdown.min.js"></script>
<!-- DevExtreme scripts go here -->

If you use JavaScript modules, import the Markdown converter:

import "devextreme/ui/html_editor/converters/markdown";
// or
// require("ui/html_editor/converters/markdown");

variables

Configures variables, which are placeholders to be replaced with actual values when processing text.

Type:

dxHtmlEditorVariables

Default Value: null

A user can insert variables in the text and remove them, but never modify them.

jQuery

JavaScript

$(function(){
    $("#htmlEditorContainer").dxHtmlEditor({
        toolbar: {
            // Adds a toolbar item that allows users to insert variables
            items: [ "variable" ]
        },
        variables: {
            dataSource: [ "FirstName", "LastName", "Company" ],
            escapeChar: [ "{", "}" ]
        }
    })
})

Angular

HTML

TypeScript

<dx-html-editor>
    <!-- Adds a toolbar item that allows users to insert variables -->
    <dxo-toolbar>
        <dxi-item name="variable"></dxi-item>
    </dxo-toolbar>
    <dxo-variables
        [dataSource]="[ 'FirstName', 'LastName', 'Company' ]"
        [escapeChar]="[ '{', '}' ]">
    </dxo-variables>
</dx-html-editor>

import { DxHtmlEditorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxHtmlEditorModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxHtmlEditor ... >
        <!-- Adds a toolbar item that allows users to insert variables -->
        <DxToolbar>
            <DxItem name="variable" />
        </DxToolbar>
        <DxVariables
            :data-source="variables"
            :escape-char="escapeCharacters"
        />
    </DxHtmlEditor>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxHtmlEditor, {
    DxToolbar,
    DxItem,
    DxVariables
} from 'devextreme-vue/html-editor';

export default {
    components: {
        DxHtmlEditor,
        DxVariables
    },
    data() {
        return {
            variables: ['FirstName', 'LastName', 'Company'],
            escapeCharacters: ['{', '}']
        };
    }
}
</script>

React

App.js

import 'devextreme/dist/css/dx.light.css';

import HtmlEditor, {
    Variables
} from 'devextreme-react/html-editor';

const variables = ['FirstName', 'LastName', 'Company'];
const escapeCharacters = ['{', '}'];

export default function App() {
    return (
        <HtmlEditor>
            {/* Adds a toolbar item that allows users to insert variables */}
            <Toolbar>
                <Item name="variable" />
            </Toolbar>
            <Variables
                dataSource={variables}
                escapeChar={escapeCharacters}
            />
        </HtmlEditor>
    );
}

visible

Specifies whether the UI component is visible.

Type: