Vue HtmlEditor - toolbar

Configures the UI component's toolbar.

Selector: DxToolbar
Default Value: null

DevExtreme HTML5 JavaScript HtmlEditor Toolbar

View Demo

See Also

container

Specifies the container in which to place the toolbar.

When this property is not set, the toolbar is placed in the UI component's container.

See Also

items[]

Configures toolbar items. These items allow users to format text and execute commands.

Selector: DxItem
Type:

Array<Object | String>

Accepted Values: 'background' | 'bold' | 'color' | 'font' | 'italic' | 'link' | 'image' | 'size' | 'strike' | 'subscript' | 'superscript' | 'underline' | 'blockquote' | 'header' | 'increaseIndent' | 'decreaseIndent' | 'orderedList' | 'bulletList' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'codeBlock' | 'variable' | 'separator' | 'undo' | 'redo' | 'clear' | 'insertTable' | 'insertRowAbove' | 'insertRowBelow' | 'insertColumnLeft' | 'insertColumnRight' | 'deleteColumn' | 'deleteRow' | 'deleteTable'

The toolbar provides predefined items and supports custom items. To add a predefined item to the toolbar, include it in the items array:

App.vue
  • <template>
  • <DxHtmlEditor ... >
  • <DxToolbar>
  • <DxItem name="bold" />
  • <DxItem name="italic" />
  • <DxItem name="alignCenter" />
  • <DxItem name="undo" />
  • <DxItem name="redo" />
  • </DxToolbar>
  • </DxHtmlEditor>
  • </template>
  •  
  • <script>
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import DxHtmlEditor, {
  • DxToolbar,
  • DxItem
  • } from 'devextreme-vue/html-editor';
  •  
  • export default {
  • components: {
  • DxHtmlEditor,
  • DxToolbar,
  • DxItem
  • },
  • // ...
  • }
  • </script>

Most of the predefined items are buttons. To customize a button, assign its name to the name property and specify the button options in the options object:

App.vue
  • <template>
  • <DxHtmlEditor ... >
  • <DxToolbar>
  • <!-- ... -->
  • <DxItem
  • name="clear"
  • :options="clearFormatOptions"
  • />
  • </DxToolbar>
  • </DxHtmlEditor>
  • </template>
  •  
  • <script>
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import DxHtmlEditor, {
  • DxToolbar,
  • DxItem
  • } from 'devextreme-vue/html-editor';
  •  
  • export default {
  • components: {
  • DxHtmlEditor,
  • DxToolbar,
  • DxItem
  • },
  • data() {
  • return {
  • clearFormatOptions: {
  • icon: "clear",
  • type: "danger"
  • }
  • };
  • }
  • }
  • </script>

To use another UI component instead of a button, specify the widget property and configure the UI component in the options object. In this case, you should also implement all the logic.

The toolbar provides a short syntax for implementing a custom drop-down menu with multiple choices. Refer to the name description for more information.

View Demo

multiline

Specifies whether or not items are arranged into multiple lines when their combined width exceeds the toolbar width.

Type:

Boolean

Default Value: true