JavaScript/jQuery HtmlEditor - Predefined Items
Toolbar items allow users to format the HTML Editor'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.
The following table lists toolbar items and the formats they apply (if applicable):
Toolbar item name | Format | acceptedValues |
---|---|---|
"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> }) |
"font" | "font" | Any value the font-family CSS property accepts. |
"size" | "size" | Any value the font-size CSS property accepts. |
"undo" | - | - |
"redo" | - | - |
"clear" | - | - |
"separator" | - | - |
"cellProperties" | - | - |
"tableProperties" | - | - |
"insertTable" | - | - |
"insertHeaderRow" | - | - |
"insertRowAbove" | - | - |
"insertRowBelow" | - | - |
"insertColumnLeft" | - | - |
"insertColumnRight" | - | - |
"deleteColumn" | - | - |
"deleteRow" | - | - |
"deleteTable" | - | - |
To add a button to the toolbar, add its name to the items array:
- $(function(){
- $("#htmlEditorContainer").dxHtmlEditor({
- toolbar: {
- items: [ "bold", "italic", "alignRight", "alignLeft" ]
- }
- })
- })
To add a select box, specify the name and acceptedValues:
- $(function(){
- $("#htmlEditorContainer").dxHtmlEditor({
- toolbar: {
- items: [{
- name: "header",
- acceptedValues: [1, 2, 3, false]
- }, {
- name: "align",
- acceptedValues: ["left", "right", "center"]
- }]
- }
- })
- })
Customize Predefined Items
To customize a button, assign its name to the name property and specify button properties in the options object:
- $(function(){
- $("#htmlEditorContainer").dxHtmlEditor({
- toolbar: {
- items: [{
- name: "clear",
- options: { icon: "clear", type: "danger" }
- }, // ...
- ]
- }
- })
- })
To customize a select box, specify select box properties in the options object in addition to the name and acceptedValues properties:
- $(function(){
- $("#htmlEditorContainer").dxHtmlEditor({
- toolbar: {
- items: [{
- name: "size",
- acceptedValues: ["11px", "14px", "16px"],
- options: {
- width: 150
- }
- }, // ...
- ]
- }
- })
- })
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.