Vue HtmlEditor API CTP

HtmlEditor is a WYSIWYG text editor build on top of Quill, designed to support HTML and Markdown output formats.

HtmlEditor is at the Community Technology Preview (CTP) development stage. That means that the widget is available for testing, but its concept, design and behavior can be reconsidered and changed without notice.

import DxHtmlEditor from "devextreme-vue/html-editor"

Type: DxHtmlEditorTypes.default

NOTE

The HtmlEditor requires the Quill library.

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the HtmlEditor widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function() {
    $("#htmlEditorContainer").dxHtmlEditor({
        valueType: "html",
        toolbar: {
            items: [
                "bold", "italic", "separator", {
                    formatName: "size",
                    formatValues: ["11px", "12px", "16px"]
                }, "separator", 
                "alignLeft", "alignCenter", "alignRight"
            ]
        }
    })
})

<head>
    <!-- ... -->
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.common.css">
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.light.css">
    <script type="text/javascript" src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>
    <script type="text/javascript" src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
</head>
<body>
    <div id="htmlEditorContainer">
        <p>
            <b>Lorem ipsum dolor sit amet</b>, 
            <i>consectetur adipiscing elit</i>, 
            sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
        </p>
    </div>
</body>

Angular

HTML

TypeScript

<dx-html-editor
    valueType="html">
    <dxo-toolbar [items]="items"></dxo-toolbar>
    <p>
        <b>Lorem ipsum dolor sit amet</b>, 
        <i>consectetur adipiscing elit</i>, 
        sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    </p>
</dx-html-editor>

import { DxHtmlEditorModule } from "devextreme-angular";
// ...
export class AppComponent {
    items: any = [
        "bold", "italic", "separator", {
            formatName: "size",
            formatValues: ["11px", "12px", "16px"]
        }, "separator", 
        "alignLeft", "alignCenter", "alignRight"
    ];
}
@NgModule({
    imports: [
        // ...
        DxHtmlEditorModule
    ],
    // ...
})

AngularJS

HTML

JavaScript

<head>
    <!-- ... -->
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.common.css">
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.light.css">
    <script type="text/javascript" src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>
    <script type="text/javascript" src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
</head>
<body>
    <div ng-controller="DemoController">
        <div dx-html-editor="{
            valueType: 'html',
            toolbar: toolbarConfig
        }">
            <p>
                <b>Lorem ipsum dolor sit amet</b>, 
                <i>consectetur adipiscing elit</i>, 
                sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
            </p>
        </div>
    </div>
</body>

angular.module("DemoApp", ["dx"])
    .controller("DemoController", function ($scope) {
        $scope.toolbarConfig = {
            items: [
                "bold", "italic", "separator", {
                    formatName: "size",
                    formatValues: ["11px", "12px", "16px"]
                }, "separator", 
                "alignLeft", "alignCenter", "alignRight"
            ]
        };
    });

Knockout

HTML

JavaScript

<head>
    <!-- ... -->
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.common.css">
    <link rel="stylesheet" href="https://cdn3.devexpress.com/jslib/18.2.18/css/dx.light.css">
    <script type="text/javascript" src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>
    <script type="text/javascript" src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
</head>
<body>
    <div data-bind="dxHtmlEditor: {
        valueType: 'html',
        toolbar: toolbarConfig
    }">
        <p>
            <b>Lorem ipsum dolor sit amet</b>, 
            <i>consectetur adipiscing elit</i>, 
            sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
        </p>
    </div>
</body>

var viewModel = {
    toolbarConfig: {
        items: [
            "bold", "italic", "separator", {
                formatName: "size",
                formatValues: ["11px", "12px", "16px"]
            }, "separator", 
            "alignLeft", "alignCenter", "alignRight"
        ]
    }
};
ko.applyBindings(viewModel);

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().HtmlEditor()
    .ID("htmlEditor")
    .ValueType(HtmlEditorValueType.Html)
    .Content(@<text>
        <p><b>Lorem ipsum dolor sit amet</b>,
        <i>consectetur adipiscing elit</i>,
        sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
    </text>)
    .Toolbar(t => t
        .Items(i => {
            i.Add().FormatName("bold");
            i.Add().FormatName("italic");
            i.Add().FormatName("separator");
            i.Add().FormatName("size").FormatValues(new[] { "11px", "12px", "16px" });
            i.Add().FormatName("separator");
            i.Add().FormatName("alignLeft");
            i.Add().FormatName("alignCenter");
            i.Add().FormatName("alignRight");
        })
    )
)
<script src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>

@(Html.DevExtreme().HtmlEditor() _
    .ID("htmlEditor") _
    .ValueType(HtmlEditorValueType.Html) _
    .Content(
        "<p><b>Lorem ipsum dolor sit amet</b>, " _
        & "<i>consectetur adipiscing elit</i>, " _
        & "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>"
    ) _
    .Toolbar(Sub(t)
        t.Items(Sub(items)
            items.Add().FormatName("bold")
            items.Add().FormatName("italic")
            items.Add().FormatName("separator");
            items.Add().FormatName("size").FormatValues({"11px", "12px", "16px"})
            items.Add().FormatName("separator");
            items.Add().FormatName("alignLeft")
            items.Add().FormatName("alignCenter")
            items.Add().FormatName("alignRight")
        End Sub)
    End Sub)
)
<script src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>

Vue

<template>
    <dx-html-editor
        value-type="html">
        <dx-toolbar :items="items" />
            <p>
                <b>Lorem ipsum dolor sit amet</b>, 
                <i>consectetur adipiscing elit</i>, 
                sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
            </p>
    </dx-html-editor>
</template>
<script>
import { DxHtmlEditor, DxToolbar } from "devextreme-vue/html-editor";

export default {
    components: {
        DxHtmlEditor,
        DxToolbar
    },
    data() {
        return {
            items: [
                "bold", "italic", "separator", {
                    formatName: "size",
                    formatValues: ["11px", "12px", "16px"]
                }, "separator",
                "alignLeft", "alignCenter", "alignRight"
            ]
        };
    }
}
</script>

React

import React from "react";
import HtmlEditor, { Toolbar } from "devextreme-react/html-editor";

const items = [
    "bold", "italic", "separator", {
        formatName: "size",
        formatValues: ["11px", "12px", "16px"]
    }, "separator",
    "alignLeft", "alignCenter", "alignRight"
];

class App extends React.Component {
    render() {
        return (
            <HtmlEditor
                valueType="html">
                    <Toolbar items={items} />
                    <p>
                        <b>Lorem ipsum dolor sit amet</b>, 
                        <i>consectetur adipiscing elit</i>, 
                        sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
                    </p>
            </HtmlEditor>
        );
    }
}

export default App;

View Demo

Configuration

This section describes options that configure the HtmlEditor widget's contents, behavior, and appearance.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
isValid	Specifies whether the editor's value is valid.
name	The value to be assigned to the `name` attribute of the underlying HTML element.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onFocusIn	A function that is executed when the widget gets focus.
onFocusOut	A function that is executed when the widget loses focus.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option is changed.
onValueChanged	A function that is executed after the widget's value is changed.
placeholder	Specifies the text displayed when the input field is empty.
readOnly	A Boolean value specifying whether or not the widget is read-only.
rtlEnabled	Switches the widget to a right-to-left representation.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
toolbar	Configures the widget's toolbar.
validationError	Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
validationMessageMode	Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
value	Specifies the widget's value.
valueType	Specifies in which markup language the value is stored.
variables	Configures variables, which are placeholders to be replaced with actual values when processing text.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes methods that control the HtmlEditor widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
clearHistory()	Clears the history of changes.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
delete(index, length)	Deletes content from the given range.
dispose()	Disposes of all the resources allocated to the HtmlEditor instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
format(formatName, formatValue)	Applies a format to the selected content. Cannot be used with embedded formats.
formatLine(index, length, formatName, formatValue)	Applies a single block format to all lines in the given range.
formatLine(index, length, formats)	Applies several block formats to all lines in the given range.
formatText(index, length, formatName, formatValue)	Applies a single text format to all characters in the given range.
formatText(index, length, formats)	Applies several text formats to all characters in the given range.
getFormat(index, length)	Gets formats applied to the content in the specified range.
getInstance(element)	Gets the instance of a widget found using its DOM node.
getLength()	Gets the entire content's length.
getModule(modulePath)	Gets a format, module, or Parchment.
getQuillInstance()	Gets Quill's instance.
getSelection()	Gets the selected content's position and length.
insertEmbed(index, type, config)	Inserts an embedded content at the specified position.
insertText(index, text, formats)	Inserts formatted text at the specified position. Used with all formats except embedded.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
redo()	Reapplies the most recent undone change. Repeated calls reapply preceding undone changes.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
registerModules(modules)	Registers formats and modules.
removeFormat(index, length)	Removes all formatting and embedded content from the specified range.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.
reset()	Resets the value option to the default value.
setSelection(index, length)	Selects and highlights content in the specified range.
undo()	Reverses the most recent change. Repeated calls reverse preceding changes.

Events

This section describes events that the HtmlEditor widget raises.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
focusIn	Raised when the widget gets focus.
focusOut	Raised when the widget loses focus.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
valueChanged	Raised after the widget's value is changed.

Vue HtmlEditor API CTP

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

Vue

React

See Also

Configuration

See Also

Methods

Events

See Also