Overview
Documentation
The HtmlEditor component is a client-side WYSIWYG text editor. The editor allows users to format text and integrate media elements into documents. The result can be exported to HTML or Markdown.
Users can edit and customize content using the toolbar that can contain predefined and custom controls. To specify the available controls, use the items array. In this demo, the toolbar contains predefined controls.
You can use the toolbar.multiline property to arrange the toolbar controls into multiple rows.
Users can resize media files when the mediaResizing is enabled. Currently, only images are supported.
To get started with the DevExtreme HtmlEditor component, refer to the following tutorial for step-by-step instructions: Getting Started with HtmlEditor.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you for the feedback!
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Backend API
<template>
<div>
<DxHtmlEditor
:value="markup"
height="725px"
>
<DxMediaResizing :enabled="true"/>
<DxImageUpload
:tabs="currentTabs"
file-upload-mode="base64"
/>
<DxToolbar :multiline="isMultiline">
<DxItem name="undo"/>
<DxItem name="redo"/>
<DxItem name="separator"/>
<DxItem
name="size"
:accepted-values="sizeValues"
:options="fontSizeOptions"
/>
<DxItem
name="font"
:accepted-values="fontValues"
:options="fontFamilyOptions"
/>
<DxItem name="separator"/>
<DxItem name="bold"/>
<DxItem name="italic"/>
<DxItem name="strike"/>
<DxItem name="underline"/>
<DxItem name="separator"/>
<DxItem name="alignLeft"/>
<DxItem name="alignCenter"/>
<DxItem name="alignRight"/>
<DxItem name="alignJustify"/>
<DxItem name="separator"/>
<DxItem name="orderedList"/>
<DxItem name="bulletList"/>
<DxItem name="separator"/>
<DxItem
name="header"
:accepted-values="headerValues"
:options="headerOptions"
/>
<DxItem name="separator"/>
<DxItem name="color"/>
<DxItem name="background"/>
<DxItem name="separator"/>
<DxItem name="link"/>
<DxItem name="image"/>
<DxItem name="separator"/>
<DxItem name="clear"/>
<DxItem name="codeBlock"/>
<DxItem name="blockquote"/>
<DxItem name="separator"/>
<DxItem name="insertTable"/>
<DxItem name="deleteTable"/>
<DxItem name="insertRowAbove"/>
<DxItem name="insertRowBelow"/>
<DxItem name="deleteRow"/>
<DxItem name="insertColumnLeft"/>
<DxItem name="insertColumnRight"/>
<DxItem name="deleteColumn"/>
</DxToolbar>
</DxHtmlEditor>
<div class="options">
<div class="caption">Options</div>
<div class="option">
<DxCheckBox
v-model:value="isMultiline"
text="Multiline toolbar"
/>
</div>
<div class="option">
<div class="label">Image upload tabs:</div>
<DxSelectBox
:items="tabs"
:input-attr="{ 'aria-label': 'Tab' }"
v-model:value="currentTabs"
display-expr="name"
value-expr="value"
/>
</div>
</div>
</div>
</template>
<script>
import {
DxHtmlEditor,
DxToolbar,
DxMediaResizing,
DxImageUpload,
DxItem,
} from 'devextreme-vue/html-editor';
import {
DxCheckBox,
} from 'devextreme-vue/check-box';
import {
DxSelectBox,
} from 'devextreme-vue/select-box';
import { markup, tabs } from './data.js';
export default {
components: {
DxHtmlEditor,
DxMediaResizing,
DxToolbar,
DxItem,
DxImageUpload,
DxCheckBox,
DxSelectBox,
},
data() {
return {
markup,
tabs,
sizeValues: ['8pt', '10pt', '12pt', '14pt', '18pt', '24pt', '36pt'],
fontValues: ['Arial', 'Courier New', 'Georgia', 'Impact', 'Lucida Console', 'Tahoma', 'Times New Roman', 'Verdana'],
headerValues: [false, 1, 2, 3, 4, 5],
currentTabs: tabs[2].value,
isMultiline: true,
fontSizeOptions: { inputAttr: { 'aria-label': 'Font size' } },
fontFamilyOptions: { inputAttr: { 'aria-label': 'Font family' } },
headerOptions: { inputAttr: { 'aria-label': 'Font family' } },
};
},
};
</script>
<style>
.dx-htmleditor-content img {
vertical-align: middle;
padding-right: 10px;
}
.dx-htmleditor-content table {
width: 50%;
}
.options {
padding: 20px;
background-color: rgba(191, 191, 191, 0.15);
margin-top: 20px;
}
.caption {
font-size: 18px;
font-weight: 500;
}
.option {
margin-top: 10px;
display: inline-block;
margin-right: 40px;
}
.option > .dx-selectbox,
.option > .label {
display: inline-block;
vertical-align: middle;
}
.option > .label {
margin-right: 10px;
}
</style>
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
<!DOCTYPE html>
<html>
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.1.5/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import("./index.js");
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"> </div>
</div>
</body>
</html>
export const tabs = [
{ name: 'From This Device', value: ['file'] },
{ name: 'From the Web', value: ['url'] },
{ name: 'Both', value: ['file', 'url'] },
];
export const markup = `
<h2>
<img src="../../../../images/widgets/HtmlEditor.svg" alt="HtmlEditor">
Formatted Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML or Markdown.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
<ul>
<li><strong>Bold</strong>, <em>italic</em>, <s>strikethrough</s> text formatting</li>
<li>Font, size, color changes (HTML only)</li>
</ul>
</li>
<li>Block formats:
<ul>
<li>Headers</li>
<li>Text alignment</li>
<li>Lists (ordered and unordered)</li>
<li>Code blocks</li>
<li>Quotes</li>
</ul>
</li>
<li>Custom formats</li>
<li>HTML and Markdown support</li>
<li>Mail-merge placeholders (for example, %username%)</li>
<li>Adaptive toolbar for working images, links, and color formats</li>
<li>Image upload: drag-and-drop images onto the form, select files from the file system, or specify a URL.</li>
<li>Copy-paste rich content (unsupported formats are removed)</li>
<li>Tables support</li>
</ul>
<br>
<p>Supported frameworks and libraries</p>
<table>
<tr>
<td><strong>jQuery</strong></td>
<td style="text-align: right;">v2.1 - v2.2 and v3.x</td>
</tr>
<tr>
<td><strong>Angular</strong></td>
<td style="text-align: right;">v7.0+</td>
</tr>
<tr>
<td><strong>React</strong></td>
<td style="text-align: right;">v16.2+</td>
</tr>
<tr>
<td><strong>Vue</strong></td>
<td style="text-align: right;">v2.6.3+</td>
</tr>
</table>
`;
window.exports = window.exports || {};
window.config = {
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader',
},
'*.ts': {
loader: 'demo-ts-loader',
},
'*.svg': {
loader: 'svg-loader',
},
'devextreme/localization.js': {
'esModule': true,
},
},
paths: {
'root:': '../../../../../',
'npm:': 'https://unpkg.com/',
},
map: {
'vue': 'npm:vue@3.3.4/dist/vue.esm-browser.js',
'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js',
'demo-ts-loader': 'root:utils/demo-ts-loader.js',
'svg-loader': 'root:utils/svg-loader.js',
'mitt': 'npm:mitt/dist/mitt.umd.js',
'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@23.1.6/cjs',
'devextreme-vue': 'npm:devextreme-vue@23.1.6',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.2/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.49/dist/dx-gantt.js',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12',
'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',
'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js',
},
packages: {
'devextreme-vue': {
main: 'index.js',
},
'devextreme': {
defaultExtension: 'js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/events': {
main: 'index',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
'npm:@devextreme/runtime@3.0.12/inferno/package.json',
],
babelOptions: {
sourceMaps: false,
stage0: true,
},
};
System.config(window.config);