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.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<dx-html-editor height="725px" [value]="valueContent">
<dxo-toolbar [multiline]="isMultiline">
<dxi-item name="undo"></dxi-item>
<dxi-item name="redo"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="size" [acceptedValues]="['8pt', '10pt', '12pt', '14pt', '18pt', '24pt', '36pt']"></dxi-item>
<dxi-item name="font" [acceptedValues]="['Arial', 'Courier New', 'Georgia', 'Impact', 'Lucida Console', 'Tahoma', 'Times New Roman', 'Verdana']"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="bold"></dxi-item>
<dxi-item name="italic"></dxi-item>
<dxi-item name="strike"></dxi-item>
<dxi-item name="underline"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="alignLeft"></dxi-item>
<dxi-item name="alignCenter"></dxi-item>
<dxi-item name="alignRight"></dxi-item>
<dxi-item name="alignJustify"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="orderedList"></dxi-item>
<dxi-item name="bulletList"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="header" [acceptedValues]="[false, 1, 2, 3, 4, 5]"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="color"></dxi-item>
<dxi-item name="background"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="link"></dxi-item>
<dxi-item name="image"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="clear"></dxi-item>
<dxi-item name="codeBlock"></dxi-item>
<dxi-item name="blockquote"></dxi-item>
<dxi-item name="separator"></dxi-item>
<dxi-item name="insertTable"></dxi-item>
<dxi-item name="deleteTable"></dxi-item>
<dxi-item name="insertRowAbove"></dxi-item>
<dxi-item name="insertRowBelow"></dxi-item>
<dxi-item name="deleteRow"></dxi-item>
<dxi-item name="insertColumnLeft"></dxi-item>
<dxi-item name="insertColumnRight"></dxi-item>
<dxi-item name="deleteColumn"></dxi-item>
</dxo-toolbar>
<dxo-media-resizing
[enabled]=true>
</dxo-media-resizing>
</dx-html-editor>
<div class="options">
<div class="caption">Options</div>
<div class="option">
<dx-check-box
text="Multiline toolbar"
[(value)]="isMultiline"
></dx-check-box>
</div>
</div>
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { DxHtmlEditorModule, DxCheckBoxModule } from 'devextreme-angular';
import { Service } from './app.service';
if(!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
selector: 'demo-app',
templateUrl: 'app/app.component.html',
styleUrls: ['app/app.component.css'],
providers: [Service]
})
export class AppComponent {
isMultiline: boolean = true;
valueContent: string;
constructor(service: Service) {
this.valueContent = service.getMarkup();
}
}
@NgModule({
imports: [
BrowserModule,
DxHtmlEditorModule,
DxCheckBoxModule
],
declarations: [AppComponent],
bootstrap: [AppComponent]
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep .dx-htmleditor-content img {
vertical-align: middle;
padding-right: 10px;
}
::ng-deep .dx-htmleditor-content table {
width: 50%;
}
::ng-deep .options {
padding: 20px;
background-color: rgba(191, 191, 191, 0.15);
margin-top: 20px;
}
::ng-deep .caption {
font-size: 18px;
font-weight: 500;
}
::ng-deep .option {
margin-top: 10px;
}
import { Injectable } from '@angular/core';
let markup: string = `
<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>Insert images as a link or base64 (drag and drop images to convert them to base64)</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.x - v10.0.x</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>
`;
@Injectable()
export class Service {
getMarkup(): string {
return markup;
}
}
// In real applications, you should not transpile code in the browser. You can see how to create your own application with Angular and DevExtreme here:
// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/
window.config = {
transpiler: 'ts',
typescriptOptions: {
module: "system",
emitDecoratorMetadata: true,
experimentalDecorators: true
},
meta: {
'typescript': {
"exports": "ts"
},
'devextreme/localization.js': {
"esModule": true
},
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',
'typescript': 'npm:typescript@3.5.3/lib/typescript.js',
'@angular': 'npm:@angular',
'tslib': 'npm:tslib@2.3.1/tslib.js',
'rxjs': 'npm:rxjs@6.4.0',
'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@21.1.6/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@21.1.6/bundles/dx.all.js',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.4.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.1.32',
'devexpress-gantt': 'npm:devexpress-gantt@3.0.14',
'devextreme-angular': 'npm:devextreme-angular@21.1.6',
'@devextreme/vdom': 'npm:@devextreme/vdom@1.2.2',
'inferno': 'npm:inferno@7.4.10/dist/inferno.min.js',
'inferno-compat': 'npm:inferno-compat@7.4.10/dist/inferno-compat.min.js',
'inferno-create-element': 'npm:inferno-create-element@7.4.10/dist/inferno-create-element.min.js',
'inferno-dom': 'npm:inferno-dom@1.0.7/dist/inferno-dom.min.js',
'inferno-hydrate': 'npm:inferno-hydrate@7.4.10/dist/inferno-hydrate.min.js',
'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.10/dist/inferno-clone-vnode.min.js',
'inferno-create-class': 'npm:inferno-create-class@7.4.10/dist/inferno-create-class.min.js',
'inferno-extras': 'npm:inferno-extras@7.4.10/dist/inferno-extras.min.js'
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts'
},
'devextreme': {
defaultExtension: 'js'
},
'@devextreme/vdom': {
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:@angular/*/package.json",
"npm:@angular/common/*/package.json",
"npm:rxjs/package.json",
"npm:rxjs/operators/package.json",
"npm:devextreme-angular/*/package.json",
"npm:devextreme-angular/ui/*/package.json",
"npm:devextreme-angular/package.json",
"npm:devexpress-diagram/package.json",
"npm:devexpress-gantt/package.json",
]
};
System.config(window.config);
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<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/21.1.6/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.6/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/zone.js@0.10.3/dist/zone.js"></script>
<script src="https://unpkg.com/reflect-metadata@0.1.3/Reflect.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script src="config.js"></script>
<script>
System.import('app').catch(console.error.bind(console));
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<demo-app>Loading...</demo-app>
</div>
</body>
</html>