DevExtreme v23.2 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

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.

Backend API
import React, { useCallback, useState } from 'react'; import HtmlEditor, { Toolbar, MediaResizing, ImageUpload, Item, } from 'devextreme-react/html-editor'; import CheckBox, { CheckBoxTypes } from 'devextreme-react/check-box'; import SelectBox, { SelectBoxTypes } from 'devextreme-react/select-box'; import { markup, tabs, tabLabel } from './data.ts'; const sizeValues = ['8pt', '10pt', '12pt', '14pt', '18pt', '24pt', '36pt']; const fontValues = [ 'Arial', 'Courier New', 'Georgia', 'Impact', 'Lucida Console', 'Tahoma', 'Times New Roman', 'Verdana', ]; const headerValues = [false, 1, 2, 3, 4, 5]; const fontSizeOptions = { inputAttr: { 'aria-label': 'Font size', }, }; const fontFamilyOptions = { inputAttr: { 'aria-label': 'Font family', }, }; const headerOptions = { inputAttr: { 'aria-label': 'Font family', }, }; export default function App() { const [isMultiline, setIsMultiline] = useState(true); const [currentTab, setCurrentTab] = useState(tabs[2].value); const multilineChanged = useCallback((e: CheckBoxTypes.ValueChangedEvent) => { setIsMultiline(e.value); }, [setIsMultiline]); const currentTabChanged = useCallback((e: SelectBoxTypes.ValueChangedEvent) => { setCurrentTab(e.value); }, [setCurrentTab]); return ( <div className="widget-container"> <HtmlEditor height="725px" defaultValue={markup}> <MediaResizing enabled={true} /> <ImageUpload tabs={currentTab} fileUploadMode="base64" /> <Toolbar multiline={isMultiline}> <Item name="undo" /> <Item name="redo" /> <Item name="separator" /> <Item name="size" acceptedValues={sizeValues} options={fontSizeOptions} /> <Item name="font" acceptedValues={fontValues} options={fontFamilyOptions} /> <Item name="separator" /> <Item name="bold" /> <Item name="italic" /> <Item name="strike" /> <Item name="underline" /> <Item name="separator" /> <Item name="alignLeft" /> <Item name="alignCenter" /> <Item name="alignRight" /> <Item name="alignJustify" /> <Item name="separator" /> <Item name="orderedList" /> <Item name="bulletList" /> <Item name="separator" /> <Item name="header" acceptedValues={headerValues} options={headerOptions} /> <Item name="separator" /> <Item name="color" /> <Item name="background" /> <Item name="separator" /> <Item name="link" /> <Item name="image" /> <Item name="separator" /> <Item name="clear" /> <Item name="codeBlock" /> <Item name="blockquote" /> <Item name="separator" /> <Item name="insertTable" /> <Item name="deleteTable" /> <Item name="insertRowAbove" /> <Item name="insertRowBelow" /> <Item name="deleteRow" /> <Item name="insertColumnLeft" /> <Item name="insertColumnRight" /> <Item name="deleteColumn" /> </Toolbar> </HtmlEditor> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="Multiline toolbar" value={isMultiline} onValueChanged={multilineChanged} /> </div> <div className="option"> <div className="label">Image upload tabs:</div> <SelectBox items={tabs} value={currentTab} valueExpr="value" inputAttr={tabLabel} displayExpr="name" onValueChanged={currentTabChanged} /> </div> </div> </div> ); }
import React, { useCallback, useState } from 'react'; import HtmlEditor, { Toolbar, MediaResizing, ImageUpload, Item, } from 'devextreme-react/html-editor'; import CheckBox from 'devextreme-react/check-box'; import SelectBox from 'devextreme-react/select-box'; import { markup, tabs, tabLabel } from './data.js'; const sizeValues = ['8pt', '10pt', '12pt', '14pt', '18pt', '24pt', '36pt']; const fontValues = [ 'Arial', 'Courier New', 'Georgia', 'Impact', 'Lucida Console', 'Tahoma', 'Times New Roman', 'Verdana', ]; const headerValues = [false, 1, 2, 3, 4, 5]; const fontSizeOptions = { inputAttr: { 'aria-label': 'Font size', }, }; const fontFamilyOptions = { inputAttr: { 'aria-label': 'Font family', }, }; const headerOptions = { inputAttr: { 'aria-label': 'Font family', }, }; export default function App() { const [isMultiline, setIsMultiline] = useState(true); const [currentTab, setCurrentTab] = useState(tabs[2].value); const multilineChanged = useCallback( (e) => { setIsMultiline(e.value); }, [setIsMultiline], ); const currentTabChanged = useCallback( (e) => { setCurrentTab(e.value); }, [setCurrentTab], ); return ( <div className="widget-container"> <HtmlEditor height="725px" defaultValue={markup} > <MediaResizing enabled={true} /> <ImageUpload tabs={currentTab} fileUploadMode="base64" /> <Toolbar multiline={isMultiline}> <Item name="undo" /> <Item name="redo" /> <Item name="separator" /> <Item name="size" acceptedValues={sizeValues} options={fontSizeOptions} /> <Item name="font" acceptedValues={fontValues} options={fontFamilyOptions} /> <Item name="separator" /> <Item name="bold" /> <Item name="italic" /> <Item name="strike" /> <Item name="underline" /> <Item name="separator" /> <Item name="alignLeft" /> <Item name="alignCenter" /> <Item name="alignRight" /> <Item name="alignJustify" /> <Item name="separator" /> <Item name="orderedList" /> <Item name="bulletList" /> <Item name="separator" /> <Item name="header" acceptedValues={headerValues} options={headerOptions} /> <Item name="separator" /> <Item name="color" /> <Item name="background" /> <Item name="separator" /> <Item name="link" /> <Item name="image" /> <Item name="separator" /> <Item name="clear" /> <Item name="codeBlock" /> <Item name="blockquote" /> <Item name="separator" /> <Item name="insertTable" /> <Item name="deleteTable" /> <Item name="insertRowAbove" /> <Item name="insertRowBelow" /> <Item name="deleteRow" /> <Item name="insertColumnLeft" /> <Item name="insertColumnRight" /> <Item name="deleteColumn" /> </Toolbar> </HtmlEditor> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="Multiline toolbar" value={isMultiline} onValueChanged={multilineChanged} /> </div> <div className="option"> <div className="label">Image upload tabs:</div> <SelectBox items={tabs} value={currentTab} valueExpr="value" inputAttr={tabLabel} displayExpr="name" onValueChanged={currentTabChanged} /> </div> </div> </div> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
export interface Tab { name: string, value: ('file' | 'url')[], } export const tabs: Tab[] = [ { 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> `; export const tabLabel = { 'aria-label': 'Tab' };
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.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.2.5/cjs', 'devextreme-react': 'npm:devextreme-react@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/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', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins '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': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: '', }, '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, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
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> `; export const tabLabel = { 'aria-label': 'Tab' };
<!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.2.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.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.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.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; }