HtmlEditorCTP

HtmlEditor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML or Markdown. HtmlEditor is built on top of and requires Quill.

NOTE
At this time, the HtmlEditor is available as a community technology preview (CTP) version. You can test the component and share your feedback to influence our R&D process. We do not recommend that you use the HtmlEditor in production environments because of possible implementation issues and a high chance of breaking changes in subsequent versions.
Module: ui/html_editor
Export: default
HtmlEditor interactive configuration
Copy Code
Copy to Codepen
$("#htmleditor").dxHtmlEditor({
});

                    
Type:

Object

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.

customizeModules

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

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.

mediaResizing

Configures media resizing.

mentions

Configures mentions.

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

Specifies whether the editor 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.

See Also

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.

get(componentPath)

Gets a format, module, or Parchment.

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.

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.

register(components)

Registers custom formats and modules.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

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.

See Also

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.

See Also