Vue HtmlEditor - Predefined Items

Toolbar items allow users to format the HtmlEditor's content and perform actions on it.

Predefined toolbar items include:

  • Buttons that apply single-choice formats to the text.
  • Action buttons.
  • Select boxes that apply multiple-choice formats.
  • Separators that are not user-interactive and only divide other elements.

DevExtreme HTML5 JavaScript HtmlEditor Toolbar

The following table lists toolbar items and the formats they apply (if applicable):

Toolbar Item formatName formatValue
"background" "background" Any value the background-color CSS property accepts.
"bold" "bold" true or false
"color" "color" Any value the color CSS property accepts.
"italic" "italic" true or false
"link" "link" String
or
Object ({ href: String, text: String, target: Boolean })
"image" "extendedImage" String
or
Object ({ src: String, width: Number, height: Number, alt: String })
"strike" "strike" true or false
"subscript" "script" "sub"
"superscript" "script" "super"
"underline" "underline" true or false
"blockquote" "blockquote" true or false
"header" "header" 1, 2, 3, 4, 5, or 6
"increaseIndent" "indent" "+1"
"decreaseIndent" "indent" "-1"
"orderedList" "list" "ordered"
"bulletList" "list" "bullet"
"alignLeft" "align" "left"
"alignCenter" "align" "center"
"alignRight" "align" "right"
"alignJustify" "align" "justify"
"codeBlock" "code-block" true or false
"variable" "variable" Object {{ value: String, escapeChar: String | Array<String> }}
"undo" - -
"redo" - -
"clear" - -
"separator" - -

To add a button to the toolbar, add its name to the items array:

HTML
TypeScript
  • <dx-html-editor>
  • <dxo-toolbar>
  • <dxi-item formatName="bold"/>
  • <dxi-item formatName="italic"/>
  • <dxi-item formatName="alignRight"/>
  • <dxi-item formatName="alignLeft"/>
  • </dxo-toolbar>
  • </dx-html-editor>
  • import { DxHtmlEditorModule } from "devextreme-angular";
  • // ...
  • export class AppComponent {
  • // ...
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxHtmlEditorModule
  • ],
  • // ...
  • })

To add a select box, specify the formatName and formatValues:

HTML
TypeScript
  • <dx-html-editor>
  • <dxo-toolbar>
  • <dxi-item
  • [formatValues]="headerFormatValues"
  • formatName="header"
  • />
  • <dxi-item
  • [formatValues]="alignFormatValues"
  • formatName="align"
  • />
  • </dxo-toolbar>
  • </dx-html-editor>
  • import { DxHtmlEditorModule } from "devextreme-angular";
  • // ...
  • export class AppComponent {
  • headerFormatValues = [1, 2, 3, false];
  • alignFormatValues = ["left", "right", "center"];
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxHtmlEditorModule
  • ],
  • // ...
  • })

Customize Predefined Items

To customize a button, assign its name to the formatName property and specify button properties in the options object:

HTML
TypeScript
  • <dx-html-editor>
  • <dxo-toolbar>
  • <dxi-item
  • [options]="clearFormatOptions"
  • formatName="clear"
  • />
  • </dxo-toolbar>
  • </dx-html-editor>
  • import { DxHtmlEditorModule } from "devextreme-angular";
  • // ...
  • export class AppComponent {
  • clearFormatOptions = { icon: "clear", type: "danger" };
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxHtmlEditorModule
  • ],
  • // ...
  • })

To customize a select box, specify select box properties in the options object in addition to the formatName and formatValues options:

HTML
TypeScript
  • <dx-html-editor>
  • <dxo-toolbar>
  • <dxi-item
  • [options]="sizeFormatOptions"
  • [formatValues]="sizeFormatValues"
  • formatName="size"
  • />
  • </dxo-toolbar>
  • </dx-html-editor>
  • import { DxHtmlEditorModule } from "devextreme-angular";
  • // ...
  • export class AppComponent {
  • sizeFormatValues = ["11px", "14px", "16px"];
  • sizeFormatOptions = { width: 150 };
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxHtmlEditorModule
  • ],
  • // ...
  • })
See Also