@syncfusion/ej2-richtexteditor 18.1.52 → 18.2.44-4568

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/CHANGELOG.md +614 -572
  2. package/README.md +67 -67
  3. package/dist/ej2-richtexteditor.umd.min.js +1 -10
  4. package/dist/ej2-richtexteditor.umd.min.js.map +1 -1
  5. package/dist/es6/ej2-richtexteditor.es2015.js +353 -136
  6. package/dist/es6/ej2-richtexteditor.es2015.js.map +1 -1
  7. package/dist/es6/ej2-richtexteditor.es5.js +364 -147
  8. package/dist/es6/ej2-richtexteditor.es5.js.map +1 -1
  9. package/license +9 -9
  10. package/package.json +50 -73
  11. package/src/common/interface.d.ts +6 -6
  12. package/src/editor-manager/base/classes.d.ts +1 -1
  13. package/src/editor-manager/base/classes.js +1 -1
  14. package/src/editor-manager/base/editor-manager.d.ts +3 -3
  15. package/src/editor-manager/base/editor-manager.js +3 -3
  16. package/src/editor-manager/base/interface.d.ts +7 -7
  17. package/src/editor-manager/base/types.d.ts +1 -1
  18. package/src/editor-manager/plugin/alignments.d.ts +2 -2
  19. package/src/editor-manager/plugin/alignments.js +2 -2
  20. package/src/editor-manager/plugin/clearformat-exec.d.ts +2 -2
  21. package/src/editor-manager/plugin/clearformat-exec.js +2 -2
  22. package/src/editor-manager/plugin/clearformat.d.ts +1 -1
  23. package/src/editor-manager/plugin/clearformat.js +1 -1
  24. package/src/editor-manager/plugin/dom-node.d.ts +34 -34
  25. package/src/editor-manager/plugin/dom-node.js +34 -34
  26. package/src/editor-manager/plugin/formats.d.ts +2 -2
  27. package/src/editor-manager/plugin/formats.js +2 -2
  28. package/src/editor-manager/plugin/image.d.ts +3 -3
  29. package/src/editor-manager/plugin/image.js +3 -3
  30. package/src/editor-manager/plugin/indents.d.ts +2 -2
  31. package/src/editor-manager/plugin/indents.js +2 -2
  32. package/src/editor-manager/plugin/insert-methods.d.ts +4 -4
  33. package/src/editor-manager/plugin/insert-methods.js +4 -4
  34. package/src/editor-manager/plugin/insert-text.d.ts +2 -2
  35. package/src/editor-manager/plugin/insert-text.js +2 -2
  36. package/src/editor-manager/plugin/inserthtml-exec.d.ts +2 -2
  37. package/src/editor-manager/plugin/inserthtml-exec.js +2 -2
  38. package/src/editor-manager/plugin/inserthtml.d.ts +4 -2
  39. package/src/editor-manager/plugin/inserthtml.js +42 -6
  40. package/src/editor-manager/plugin/isformatted.d.ts +8 -8
  41. package/src/editor-manager/plugin/isformatted.js +8 -8
  42. package/src/editor-manager/plugin/link.d.ts +2 -2
  43. package/src/editor-manager/plugin/link.js +2 -2
  44. package/src/editor-manager/plugin/lists.d.ts +2 -2
  45. package/src/editor-manager/plugin/lists.js +4 -14
  46. package/src/editor-manager/plugin/ms-word-clean-up.d.ts +1 -1
  47. package/src/editor-manager/plugin/ms-word-clean-up.js +1 -1
  48. package/src/editor-manager/plugin/nodecutter.d.ts +6 -6
  49. package/src/editor-manager/plugin/nodecutter.js +6 -6
  50. package/src/editor-manager/plugin/selection-commands.d.ts +1 -1
  51. package/src/editor-manager/plugin/selection-commands.js +1 -1
  52. package/src/editor-manager/plugin/selection-exec.d.ts +2 -2
  53. package/src/editor-manager/plugin/selection-exec.js +2 -2
  54. package/src/editor-manager/plugin/table.d.ts +2 -2
  55. package/src/editor-manager/plugin/table.js +2 -2
  56. package/src/editor-manager/plugin/toolbar-status.d.ts +2 -2
  57. package/src/editor-manager/plugin/toolbar-status.js +2 -2
  58. package/src/editor-manager/plugin/undo.d.ts +6 -6
  59. package/src/editor-manager/plugin/undo.js +6 -6
  60. package/src/markdown-parser/base/interface.d.ts +10 -10
  61. package/src/markdown-parser/base/markdown-parser.d.ts +3 -3
  62. package/src/markdown-parser/base/markdown-parser.js +3 -3
  63. package/src/markdown-parser/base/types.d.ts +1 -1
  64. package/src/markdown-parser/plugin/clearformat.d.ts +2 -2
  65. package/src/markdown-parser/plugin/clearformat.js +2 -2
  66. package/src/markdown-parser/plugin/formats.d.ts +2 -2
  67. package/src/markdown-parser/plugin/formats.js +2 -2
  68. package/src/markdown-parser/plugin/link.d.ts +2 -2
  69. package/src/markdown-parser/plugin/link.js +2 -2
  70. package/src/markdown-parser/plugin/markdown-selection.d.ts +14 -14
  71. package/src/markdown-parser/plugin/markdown-selection.js +14 -14
  72. package/src/markdown-parser/plugin/md-selection-formats.d.ts +2 -2
  73. package/src/markdown-parser/plugin/md-selection-formats.js +2 -2
  74. package/src/markdown-parser/plugin/table.d.ts +3 -3
  75. package/src/markdown-parser/plugin/table.js +3 -3
  76. package/src/markdown-parser/plugin/undo.d.ts +6 -6
  77. package/src/markdown-parser/plugin/undo.js +6 -6
  78. package/src/rich-text-editor/actions/base-quick-toolbar.d.ts +9 -9
  79. package/src/rich-text-editor/actions/base-quick-toolbar.js +9 -9
  80. package/src/rich-text-editor/actions/base-toolbar.d.ts +3 -3
  81. package/src/rich-text-editor/actions/base-toolbar.js +3 -3
  82. package/src/rich-text-editor/actions/color-picker.d.ts +2 -2
  83. package/src/rich-text-editor/actions/color-picker.js +2 -2
  84. package/src/rich-text-editor/actions/count.d.ts +3 -3
  85. package/src/rich-text-editor/actions/count.js +3 -3
  86. package/src/rich-text-editor/actions/dropdown-buttons.d.ts +2 -2
  87. package/src/rich-text-editor/actions/dropdown-buttons.js +2 -2
  88. package/src/rich-text-editor/actions/full-screen.d.ts +3 -3
  89. package/src/rich-text-editor/actions/full-screen.js +3 -3
  90. package/src/rich-text-editor/actions/html-editor.d.ts +3 -3
  91. package/src/rich-text-editor/actions/html-editor.js +3 -3
  92. package/src/rich-text-editor/actions/keyboard-model.d.ts +13 -13
  93. package/src/rich-text-editor/actions/keyboard.d.ts +1 -1
  94. package/src/rich-text-editor/actions/keyboard.js +1 -1
  95. package/src/rich-text-editor/actions/markdown-editor.d.ts +2 -2
  96. package/src/rich-text-editor/actions/markdown-editor.js +2 -2
  97. package/src/rich-text-editor/actions/paste-clean-up.d.ts +1 -1
  98. package/src/rich-text-editor/actions/paste-clean-up.js +34 -3
  99. package/src/rich-text-editor/actions/quick-toolbar.d.ts +19 -9
  100. package/src/rich-text-editor/actions/quick-toolbar.js +17 -7
  101. package/src/rich-text-editor/actions/toolbar.d.ts +13 -13
  102. package/src/rich-text-editor/actions/toolbar.js +13 -13
  103. package/src/rich-text-editor/base/classes.d.ts +102 -102
  104. package/src/rich-text-editor/base/classes.js +102 -102
  105. package/src/rich-text-editor/base/constant.d.ts +111 -101
  106. package/src/rich-text-editor/base/constant.js +111 -101
  107. package/src/rich-text-editor/base/enum.d.ts +1 -1
  108. package/src/rich-text-editor/base/enum.js +1 -1
  109. package/src/rich-text-editor/base/interface.d.ts +51 -40
  110. package/src/rich-text-editor/base/interface.js +1 -1
  111. package/src/rich-text-editor/base/rich-text-editor-model.d.ts +659 -641
  112. package/src/rich-text-editor/base/rich-text-editor.d.ts +84 -52
  113. package/src/rich-text-editor/base/rich-text-editor.js +100 -43
  114. package/src/rich-text-editor/base/util.d.ts +1 -1
  115. package/src/rich-text-editor/base/util.js +1 -1
  116. package/src/rich-text-editor/formatter/formatter.d.ts +9 -8
  117. package/src/rich-text-editor/formatter/formatter.js +10 -8
  118. package/src/rich-text-editor/formatter/html-formatter.d.ts +2 -2
  119. package/src/rich-text-editor/formatter/html-formatter.js +2 -2
  120. package/src/rich-text-editor/formatter/markdown-formatter.d.ts +2 -2
  121. package/src/rich-text-editor/formatter/markdown-formatter.js +2 -2
  122. package/src/rich-text-editor/models/iframe-settings-model.d.ts +21 -21
  123. package/src/rich-text-editor/models/inline-mode-model.d.ts +9 -9
  124. package/src/rich-text-editor/models/toolbar-settings-model.d.ts +228 -228
  125. package/src/rich-text-editor/renderer/content-renderer.d.ts +6 -6
  126. package/src/rich-text-editor/renderer/content-renderer.js +6 -6
  127. package/src/rich-text-editor/renderer/dialog-renderer.d.ts +3 -2
  128. package/src/rich-text-editor/renderer/dialog-renderer.js +8 -8
  129. package/src/rich-text-editor/renderer/iframe-content-renderer.d.ts +4 -4
  130. package/src/rich-text-editor/renderer/iframe-content-renderer.js +4 -4
  131. package/src/rich-text-editor/renderer/image-module.d.ts +1 -1
  132. package/src/rich-text-editor/renderer/image-module.js +96 -29
  133. package/src/rich-text-editor/renderer/link-module.d.ts +1 -1
  134. package/src/rich-text-editor/renderer/link-module.js +1 -1
  135. package/src/rich-text-editor/renderer/markdown-renderer.d.ts +6 -6
  136. package/src/rich-text-editor/renderer/markdown-renderer.js +6 -6
  137. package/src/rich-text-editor/renderer/popup-renderer.d.ts +5 -5
  138. package/src/rich-text-editor/renderer/popup-renderer.js +5 -5
  139. package/src/rich-text-editor/renderer/render.d.ts +2 -2
  140. package/src/rich-text-editor/renderer/render.js +2 -2
  141. package/src/rich-text-editor/renderer/table-module.d.ts +1 -1
  142. package/src/rich-text-editor/renderer/table-module.js +5 -3
  143. package/src/rich-text-editor/renderer/toolbar-renderer.d.ts +8 -8
  144. package/src/rich-text-editor/renderer/toolbar-renderer.js +21 -9
  145. package/src/rich-text-editor/renderer/view-source.d.ts +6 -6
  146. package/src/rich-text-editor/renderer/view-source.js +6 -6
  147. package/src/rich-text-editor/services/renderer-factory.d.ts +3 -3
  148. package/src/rich-text-editor/services/renderer-factory.js +3 -3
  149. package/src/rich-text-editor/services/service-locator.d.ts +3 -3
  150. package/src/rich-text-editor/services/service-locator.js +3 -3
  151. package/src/selection/selection.d.ts +22 -22
  152. package/src/selection/selection.js +22 -22
  153. package/styles/_all.scss +2 -2
  154. package/styles/rich-text-editor/_all.scss +2 -2
  155. package/styles/rich-text-editor/_bootstrap-dark-definition.scss +151 -151
  156. package/styles/rich-text-editor/_bootstrap-definition.scss +184 -184
  157. package/styles/rich-text-editor/_bootstrap4-definition.scss +307 -307
  158. package/styles/rich-text-editor/_fabric-dark-definition.scss +150 -150
  159. package/styles/rich-text-editor/_fabric-definition.scss +148 -148
  160. package/styles/rich-text-editor/_highcontrast-definition.scss +148 -148
  161. package/styles/rich-text-editor/_highcontrast-light-definition.scss +148 -148
  162. package/styles/rich-text-editor/_layout.scss +1332 -1332
  163. package/styles/rich-text-editor/_material-dark-definition.scss +151 -151
  164. package/styles/rich-text-editor/_material-definition.scss +150 -150
  165. package/styles/rich-text-editor/_theme.scss +484 -484
  166. package/styles/rich-text-editor/icons/_bootstrap-dark.scss +285 -285
  167. package/styles/rich-text-editor/icons/_bootstrap.scss +284 -284
  168. package/styles/rich-text-editor/icons/_bootstrap4.scss +284 -284
  169. package/styles/rich-text-editor/icons/_fabric-dark.scss +284 -284
  170. package/styles/rich-text-editor/icons/_fabric.scss +284 -284
  171. package/styles/rich-text-editor/icons/_highcontrast-light.scss +284 -284
  172. package/styles/rich-text-editor/icons/_highcontrast.scss +284 -284
  173. package/styles/rich-text-editor/icons/_material-dark.scss +284 -284
  174. package/styles/rich-text-editor/icons/_material.scss +284 -284
  175. package/dist/global/ej2-richtexteditor.min.js +0 -11
  176. package/dist/global/ej2-richtexteditor.min.js.map +0 -1
  177. package/dist/global/index.d.ts +0 -14
@@ -1,4 +1,4 @@
1
- import { Component, ModuleDeclaration, EventHandler, Complex, Browser, EmitType, addClass, select, detach } from '@syncfusion/ej2-base';import { Property, NotifyPropertyChanges, INotifyPropertyChanged, formatUnit, L10n, closest } from '@syncfusion/ej2-base';import { setStyleAttribute, Event, removeClass, print as printWindow, attributes } from '@syncfusion/ej2-base';import { isNullOrUndefined as isNOU, compile, append, extend, debounce, isBlazor } from '@syncfusion/ej2-base';import { Touch as EJ2Touch, TapEventArgs } from '@syncfusion/ej2-base';import { getScrollableParent, BeforeOpenEventArgs } from '@syncfusion/ej2-popups';import * as events from '../base/constant';import * as classes from '../base/classes';import { Render } from '../renderer/render';import { ViewSource } from '../renderer/view-source';import { IRenderer, IFormatter, PrintEventArgs, ActionCompleteEventArgs, ActionBeginEventArgs } from './interface';import { BeforeQuickToolbarOpenArgs, ChangeEventArgs } from './interface';import { IExecutionGroup, executeGroup, CommandName, ResizeArgs } from './interface';import { ILinkCommandsArgs, IImageCommandsArgs, BeforeSanitizeHtmlArgs, ITableCommandsArgs, ExecuteCommandOption } from './interface';import { ServiceLocator } from '../services/service-locator';import { RendererFactory } from '../services/renderer-factory';import { RenderType, ToolbarType } from './enum';import { EditorMode } from './../../common/types';import { Toolbar } from '../actions/toolbar';import { ExecCommandCallBack } from '../actions/execute-command-callback';import { KeyboardEvents, KeyboardEventArgs } from '../actions/keyboard';import { FontFamilyModel, FontSizeModel, FontColorModel, FormatModel, BackgroundColorModel } from '../models/models';import { ToolbarSettingsModel, IFrameSettingsModel, ImageSettingsModel, TableSettingsModel } from '../models/models';import { QuickToolbarSettingsModel, InlineModeModel, PasteCleanupSettingsModel } from '../models/models';import { ToolbarSettings, ImageSettings, QuickToolbarSettings, FontFamily, FontSize, Format } from '../models/toolbar-settings';import { TableSettings, PasteCleanupSettings } from '../models/toolbar-settings';import { FontColor, BackgroundColor } from '../models/toolbar-settings';import { IFrameSettings } from '../models/iframe-settings';import { InlineMode } from '../models/inline-mode';import { Link } from '../renderer/link-module';import { Image } from '../renderer/image-module';import { Table } from '../renderer/table-module';import { Count } from '../actions/count';import { HtmlEditor } from '../actions/html-editor';import { MarkdownEditor } from '../actions/markdown-editor';import { defaultLocale } from '../models/default-locale';import { setAttributes } from '../actions/html-attributes';import { BaseToolbar } from '../actions/base-toolbar';import { QuickToolbar } from '../actions/quick-toolbar';import { FullScreen } from '../actions/full-screen';import { PasteCleanup } from '../actions/paste-clean-up';import * as CONSTANT from '../../common/constant';import { IHtmlKeyboardEvent } from '../../editor-manager/base/interface';import { dispatchEvent, getEditValue, isIDevice, decode, isEditableValueEmpty } from '../base/util';import { DialogRenderer } from '../renderer/dialog-renderer';import { SelectedEventArgs, RemovingEventArgs, UploadingEventArgs } from '@syncfusion/ej2-inputs';import { Resize } from '../actions/resize';
1
+ import { Component, ModuleDeclaration, EventHandler, Complex, Browser, EmitType, addClass, select, detach } from '@syncfusion/ej2-base';
2
2
  import {ComponentModel} from '@syncfusion/ej2-base';
3
3
 
4
4
  /**
@@ -7,681 +7,699 @@ import {ComponentModel} from '@syncfusion/ej2-base';
7
7
  export interface RichTextEditorModel extends ComponentModel{
8
8
 
9
9
  /**
10
- * Specifies the group of items aligned horizontally in the toolbar as well as defined the toolbar rendering type.
11
- * By default, toolbar is float at the top of the RichTextEditor.
12
- * When you scroll down, the toolbar will scroll along with the page on Rich Text Editor with the specified offset value.
13
- * * enable: set boolean value to show or hide the toolbar.
14
- * * enableFloating: Set Boolean value to enable or disable the floating toolbar.
15
- * Preserves the toolbar at top of the Rich Text Editor on scrolling.
16
- * * type: it has two possible options
17
- * 1. Expand: Hide the overflowing toolbar items in the next row. Click the expand arrow to view overflowing toolbar items
18
- * 2. MultiRow: The toolbar overflowing items wrapped in the next row.
19
- * * items: Specifies the array of items aligned horizontally in the toolbar.
20
- * > | and - can insert a vertical and horizontal separator lines in the toolbar.
21
- * * itemConfigs: Modify the default toolbar item configuration like icon class.
22
- *
23
- * > By default, The toolbar is rendered with scrollable in mobile devices and does not support the toolbar type.
24
- *
25
- * {% codeBlock src='rich-text-editor/toolbar-settings/index.md' %}{% endcodeBlock %}
26
- *
27
- * @default
28
- * {
29
- * enable: true,
30
- * enableFloating: true,
31
- * type: ToolbarType.Expand,
32
- * items: ['Bold', 'Italic', 'Underline', '|', 'Formats', 'Alignments', 'OrderedList',
33
- * 'UnorderedList', '|', 'CreateLink', 'Image', '|', 'SourceCode', 'Undo', 'Redo'],
34
- * itemConfigs: {}
35
- * }
36
- */
37
- toolbarSettings?: ToolbarSettingsModel;
38
-
39
- /**
40
- * Specifies the items to be rendered in quick toolbar based on the target element.
41
- * * It has following fields:
42
- * * enable - set boolean value to show or hide the quick toolbar
43
- * * actionOnScroll - it has two possible options
44
- * 1. hide: The quickToolbar is closed when the parent element is scrolled.
45
- * 2. none: The quickToolbar cannot be closed even the parent element is scrolled.
46
- * * link - Specifies the items to be rendered in quick toolbar based on link element such as `Open`, `Edit`, and `UnLink`.
47
- * * image - Specifies the items to be rendered in quick toolbar based on image element such as 'Replace',
48
- * 'Align', 'Caption', 'Remove', 'InsertLink', 'Display', 'AltText', 'Dimension'.
49
- * * text - Specifies the items to be rendered in quick toolbar based on text element such as 'Cut', 'Copy', 'Paste'.
50
- *
51
- * {% codeBlock src='rich-text-editor/quick-toolbar-settings/index.md' %}{% endcodeBlock %}
52
- *
53
- * @default
54
- * {
55
- * enable: true,
56
- * actionOnScroll: 'hide',
57
- * link: ['Open', 'Edit', 'UnLink'],
58
- * image: ['Replace', 'Align', 'Caption', 'Remove', '-', 'InsertLink', 'Display', 'AltText', 'Dimension'],
59
- * text: ['Cut', 'Copy', 'Paste']
60
- * }
61
- */
62
- quickToolbarSettings?: QuickToolbarSettingsModel;
63
-
64
- /**
65
- * Specifies the pasting options in Rich Text Editor component and control with the following properties.
66
- * * prompt - Set boolean value to enable or disable the prompt when pasting.
67
- * * deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
68
- * * allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
69
- * * deniedTags - Specifies the tags to restrict when pasting in RTE.
70
- * * keepFormat - Set boolean value to keep or remove the from when pasting.
71
- * * plainText - Set boolean value to paste as plain text or not.
72
- *
73
- * {% codeBlock src='rich-text-editor/paste-cleanup-settings/index.md' %}{% endcodeBlock %}
74
- *
75
- * @default
76
- * {
77
- * prompt: false,
78
- * deniedAttrs: null,
79
- * allowedStyleProps: ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius',
80
- * 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor',
81
- * 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style',
82
- * 'height', 'left', 'line-height', 'margin', 'margin-top', 'margin-left',
83
- * 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width',
84
- * 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right',
85
- * 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent',
86
- * 'top', 'vertical-align', 'visibility', 'white-space', 'width'],
87
- * deniedTags: null,
88
- * keepFormat: true,
89
- * plainText: false
90
- * }
91
- */
92
- pasteCleanupSettings?: PasteCleanupSettingsModel;
93
-
94
- /**
95
- * Specifies the items to be rendered in an iframe mode, and it has the following properties.
96
- * * enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
97
- * * attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
98
- * * resources - we can add both styles and scripts to the iframe.
99
- * 1. styles[] - An array of CSS style files to inject inside the iframe to display content
100
- * 2. scripts[] - An array of JS script files to inject inside the iframe
101
- *
102
- * {% codeBlock src='rich-text-editor/iframe-settings/index.md' %}{% endcodeBlock %}
103
- *
104
- * @default
105
- * {
106
- * enable: false,
107
- * attributes: null,
108
- * resources: { styles: [], scripts: [] }
109
- * }
110
- */
111
- iframeSettings?: IFrameSettingsModel;
112
-
113
- /**
114
- * Specifies the image insert options in Rich Text Editor component and control with the following properties.
115
- * * allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and
116
- * passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
117
- * * display - Sets the default display for an image when it is inserted in to the RichTextEditor.
118
- * Possible options are: 'inline' and 'block'.
119
- * * width - Sets the default width of the image when it is inserted in the RichTextEditor.
120
- * * saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).
121
- * > If you want to insert a lot of tiny images in the editor and don't want a specific physical location for
122
- * saving images, you can opt to save format as Base64.
123
- * * height - Sets the default height of the image when it is inserted in the RichTextEditor.
124
- * * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
125
- * * path - Specifies the path of the location to store the images and refer it to display the images.
126
- *
127
- * {% codeBlock src='rich-text-editor/insert-image-settings/index.md' %}{% endcodeBlock %}
128
- *
129
- * @default
130
- * {
131
- * allowedTypes: ['.jpeg', '.jpg', '.png'],
132
- * display: 'inline',
133
- * width: 'auto',
134
- * height: 'auto',
135
- * saveFormat: 'Blob'
136
- * saveUrl: null,
137
- * path: null,
138
- * }
139
- */
140
- insertImageSettings?: ImageSettingsModel;
141
-
142
- /**
143
- * Specifies the table insert options in Rich Text Editor component and control with the following properties.
144
- * * styles - Class name should be appended by default in table element.
145
- * It helps to design the table in specific CSS styles always when inserting in editor.
146
- * * width - Sets the default width of the table when it is inserted in the RichTextEditor.
147
- * * minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
148
- * * maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
149
- * * resize - To enable resize the table.
150
- *
151
- * {% codeBlock src='rich-text-editor/table-settings/index.md' %}{% endcodeBlock %}
152
- *
153
- * @default
154
- * {
155
- * width: '100%',
156
- * styles: [{ text: 'Dashed Borders', class: 'e-dashed-borders', command: 'Table', subCommand: 'Dashed' },
157
- * { text: 'Alternate Rows', class: 'e-alternate-rows', command: 'Table', subCommand: 'Alternate' }],
158
- * resize: true,
159
- * minWidth: 0,
160
- * maxWidth: null,
161
- * }
162
- */
163
- tableSettings?: TableSettingsModel;
164
-
165
- /**
166
- * Preserves the toolbar at the top of the Rich Text Editor on scrolling and
167
- * specifies the offset of the floating toolbar from documents top position
168
- * @default 0
169
- */
170
- floatingToolbarOffset?: number;
171
-
172
- /**
173
- * Enable or disable the inline edit mode.
174
- * * enable - set boolean value to enable or disable the inline edit mode.
175
- * * onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline.
176
- * If its set to false, upon clicking to the target element, the toolbar is opened.
177
- *
178
- * {% codeBlock src='rich-text-editor/inline-mode/index.md' %}{% endcodeBlock %}
179
- *
180
- * @default
181
- * {
182
- * enable: false,
183
- * onSelection: true
184
- * }
185
- */
186
- inlineMode?: InlineModeModel;
187
-
188
- /**
189
- * Specifies the width of the RichTextEditor.
190
- * @default '100%'
191
- */
192
- width?: string | number;
193
-
194
- /**
195
- * Enables or disables the persisting component's state between page reloads.
196
- * If enabled, the value of Rich Text Editor is persisted
197
- *
198
- * {% codeBlock src='rich-text-editor/enable-persistence/index.md' %}{% endcodeBlock %}
199
- *
200
- * @default false.
201
- */
202
- enablePersistence?: boolean;
203
-
204
- /**
205
- * Enables or disables the resizing option in the editor.
206
- * If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.
207
- *
208
- * {% codeBlock src='rich-text-editor/enable-resize/index.md' %}{% endcodeBlock %}
209
- *
210
- * @default false.
211
- */
212
- enableResize?: boolean;
213
-
214
- /**
215
- * Allows additional HTML attributes such as title, name, etc., and
216
- * It will be accepts n number of attributes in a key-value pair format.
217
- * @default {}.
218
- */
219
- htmlAttributes?: { [key: string]: string; };
220
-
221
- /**
222
- * Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.
223
- * @default null.
224
- */
225
- placeholder?: string;
226
-
227
- /**
228
- * The user interactions on the component are disabled, when set to true.
229
- * @default false.
230
- */
231
- readonly?: boolean;
232
-
233
- /**
234
- * Specifies a value that indicates whether the component is enabled or not.
235
- *
236
- * {% codeBlock src='rich-text-editor/enabled/index.md' %}{% endcodeBlock %}
237
- *
238
- * @default true.
239
- */
240
- enabled?: boolean;
241
-
242
- /**
243
- * Defines whether to allow the cross-scripting site or not.
244
- * @default true
245
- */
246
- enableHtmlSanitizer?: boolean;
247
-
248
- /**
249
- * specifies the value whether the source code is displayed with encoded format.
250
- * @default false.
251
- */
252
- enableHtmlEncode?: boolean;
253
-
254
- /**
255
- * Specifies a value that indicates whether the xhtml is enabled or not.
256
- * @default false.
257
- */
258
- enableXhtml?: boolean;
259
-
260
- /**
261
- * Specifies the height of the Rich Text Editor component.
262
- * @default "auto"
263
- */
264
- height?: string | number;
265
-
266
- /**
267
- * Specifies the CSS class name appended with the root element of the RichTextEditor.
268
- * One or more custom CSS classes can be added to a RichTextEditor.
269
- * @default null
270
- */
271
- cssClass?: string;
272
-
273
- /**
274
- * Specifies the value displayed in the RichTextEditor's content area and it should be string.
275
- * The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.
276
- *
277
- * {% codeBlock src='rich-text-editor/value/index.md' %}{% endcodeBlock %}
278
- *
279
- * @default null
280
- */
281
- value?: string;
282
-
283
- /**
284
- * Specifies the count of undo history which is stored in undoRedoManager.
285
- *
286
- * {% codeBlock src='rich-text-editor/undo-redo-steps/index.md' %}{% endcodeBlock %}
287
- *
288
- * @default 30
289
- */
290
- undoRedoSteps?: number;
291
-
292
- /**
293
- * Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
294
- * @default 300
295
- */
296
- undoRedoTimer?: number;
297
-
298
- /**
299
- * Specifies the editing mode of the RichTextEditor.
300
- *
301
- * - `HTML` - Render Rich Text Editor as HTML editor using <IFRAME> element or content editable <div> element
302
- * or <textarea> element.
303
- *
304
- * - `Markdown` - Render Rich Text Editor as markdown editor using <textarea>.
305
- *
306
- * @default 'HTML'
307
- */
308
- editorMode?: EditorMode;
309
-
310
- /**
311
- * Customizes the key actions in RichTextEditor.
312
- * For example, when using German keyboard, the key actions can be customized using these shortcuts.
313
- *
314
- * {% codeBlock src='rich-text-editor/keyconfig/index.md' %}{% endcodeBlock %}
315
- *
316
- * @default null
317
- */
318
- keyConfig?: { [key: string]: string };
319
-
320
- /**
321
- * Sets Boolean value to enable or disable the display of the character counter.
322
- *
323
- * {% codeBlock src='rich-text-editor/show-char-count/index.md' %}{% endcodeBlock %}
324
- *
325
- * @default false
326
- */
327
- showCharCount?: boolean;
328
-
329
- /**
330
- * Allows the tab key action in the Rich Text Editor content.
331
- *
332
- * {% codeBlock src='rich-text-editor/enable-tab-key/index.md' %}{% endcodeBlock %}
333
- *
334
- * @default false
335
- */
336
- enableTabKey?: boolean;
337
-
338
- /**
339
- * Enable `enableAutoUrl` to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise
340
- * the given URL will automatically convert to absolute path URL by prefixing `https://` for hyperlinks.
341
- *
342
- * {% codeBlock src='rich-text-editor/enable-autourl/index.md' %}{% endcodeBlock %}
343
- *
344
- * @default false
345
- */
346
- enableAutoUrl?: boolean;
347
-
348
- /**
349
- * Specifies the maximum number of characters allowed in the Rich Text Editor component.
350
- *
351
- * {% codeBlock src='rich-text-editor/max-length/index.md' %}{% endcodeBlock %}
352
- *
353
- * @default -1
354
- */
355
- maxLength?: number;
356
-
357
- /**
358
- * Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
359
- *
360
- * {% codeBlock src='rich-text-editor/format/index.md' %}{% endcodeBlock %}
361
- *
362
- * @default
363
- * {
364
- * default: 'Paragraph',
365
- * width: '65px',
366
- * types: [
367
- * { text: 'Paragraph' },
368
- * { text: 'Code' },
369
- * { text: 'Quotation' },
370
- * { text: 'Heading 1' },
371
- * { text: 'Heading 2' },
372
- * { text: 'Heading 3' },
373
- * { text: 'Heading 4' },
374
- * { text: 'Heading 5' },
375
- * { text: 'Heading 6' }
376
- * ]
377
- * }
378
- */
379
- format?: FormatModel;
380
-
381
- /**
382
- * Predefine the font families that populate in font family dropdown list from the toolbar.
383
- *
384
- * {% codeBlock src='rich-text-editor/font-family/index.md' %}{% endcodeBlock %}
385
- *
386
- * @default
387
- * {
388
- * default: 'Segoe UI',
389
- * width: '65px',
390
- * items: [
391
- * { text: 'Segoe UI', value: 'Segoe UI' },
392
- * { text: 'Arial', value: 'Arial,Helvetica,sans-serif' },
393
- * { text: 'Courier New', value: 'Courier New,Courier,monospace' },
394
- * { text: 'Georgia', value: 'Georgia,serif' },
395
- * { text: 'Impact', value: 'Impact,Charcoal,sans-serif' },
396
- * { text: 'Lucida Console', value: 'Lucida Console,Monaco,monospace' },
397
- * { text: 'Tahoma', value: 'Tahoma,Geneva,sans-serif' },
398
- * { text: 'Times New Roman', value: 'Times New Roman,Times,serif' },
399
- * { text: 'Trebuchet MS', value: 'Trebuchet MS,Helvetica,sans-serif' },
400
- * { text: 'Verdana', value: 'Verdana,Geneva,sans-serif' }
401
- * ]
402
- * }
403
- */
404
- fontFamily?: FontFamilyModel;
405
-
406
- /**
407
- * Predefine the font sizes that populate in font size dropdown list from the toolbar.
408
- *
409
- * {% codeBlock src='rich-text-editor/font-size/index.md' %}{% endcodeBlock %}
410
- *
411
- * @default
412
- * {
413
- * default: '10',
414
- * width: '35px',
415
- * items: [
416
- * { text: '8', value: '8pt' },
417
- * { text: '10', value: '10pt' },
418
- * { text: '12', value: '12pt' },
419
- * { text: '14', value: '14pt' },
420
- * { text: '18', value: '18pt' },
421
- * { text: '24', value: '24pt' },
422
- * { text: '36', value: '36pt' }
423
- * ]
424
- * }
425
- */
426
- fontSize?: FontSizeModel;
427
-
428
- /**
429
- * Predefine the color palette that can be rendered for font color toolbar command .
430
- *
431
- * {% codeBlock src='rich-text-editor/font-color/index.md' %}{% endcodeBlock %}
432
- *
433
- * @default
434
- * {
435
- * columns: 10,
436
- * colorCode: {
437
- * 'Custom': [
438
- * '', '#000000', '#e7e6e6', '#44546a', '#4472c4', '#ed7d31', '#a5a5a5', '#ffc000', '#70ad47', '#ff0000',
439
- * '#f2f2f2', '#808080', '#cfcdcd', '#d5dce4', '#d9e2f3', '#fbe4d5', '#ededed', '#fff2cc', '#e2efd9', '#ffcccc',
440
- * '#d9d9d9', '#595959', '#aeaaaa', '#acb9ca', '#b4c6e7', '#f7caac', '#dbdbdb', '#ffe599', '#c5e0b3', '#ff8080',
441
- * '#bfbfbf', '#404040', '#747070', '#8496b0', '#8eaadb', '#f4b083', '#c9c9c9', '#ffd966', '#a8d08d', '#ff3333',
442
- * '#a6a6a6', '#262626', '#3b3838', '#323e4f', '#2f5496', '#c45911', '#7b7b7b', '#bf8f00', '#538135', '#b30000',
443
- * '#7f7f7f', '#0d0d0d', '#161616', '#212934', '#1f3763', '#823b0b', '#525252', '#7f5f00', '#375623', '#660000']
444
- * }
445
- * }
446
- */
447
- fontColor?: FontColorModel;
448
-
449
- /**
450
- * Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
451
- *
452
- * {% codeBlock src='rich-text-editor/background-color/index.md' %}{% endcodeBlock %}
453
- *
454
- * @default
455
- * {
456
- * columns: 5,
457
- * colorCode: {
458
- * 'Custom': ['#ffff00', '#00ff00', '#00ffff', '#ff00ff', '#0000ff', '#ff0000',
459
- * '#000080', '#008080', '#008000', '#800080', '#800000', '#808000',
460
- * '#c0c0c0', '#000000', '']
461
- * }
462
- * }
463
- */
464
- backgroundColor?: BackgroundColorModel;
465
-
466
- /**
467
- * Accepts the template design and assigns it as RichTextEditor’s content.
468
- * The built-in template engine which provides options to compile template string into a executable function.
469
- * For EX: We have expression evolution as like ES6 expression string literals
470
- *
471
- * {% codeBlock src='rich-text-editor/value-template/index.md' %}{% endcodeBlock %}
472
- *
473
- * @default null
474
- */
475
- valueTemplate?: string;
476
-
477
- /**
478
- * Specifies the saveInterval in milliseconds for autosave the value.
479
- * The change event will be triggered if the content was changed from the last saved interval.
480
- *
481
- * {% codeBlock src='rich-text-editor/save-interval/index.md' %}{% endcodeBlock %}
482
- *
483
- * @default 10000
484
- */
485
- saveInterval?: number;
486
-
487
- /**
488
- * Triggers before command execution using toolbar items or executeCommand method.
489
- * If you cancel this event, the command cannot be executed.
490
- * Set the cancel argument to true to cancel the command execution.
491
- * @event
492
- * @blazorProperty 'OnActionBegin'
493
- */
494
- actionBegin?: EmitType<ActionBeginEventArgs>;
495
-
496
- /**
497
- * Triggers after command execution using toolbar items or executeCommand method.
498
- * @event
499
- * @blazorProperty 'OnActionComplete'
500
- */
501
- actionComplete?: EmitType<ActionCompleteEventArgs>;
502
-
503
- /**
504
- * Event triggers when the dialog is being opened.
505
- * If you cancel this event, the dialog remains closed.
506
- * Set the cancel argument to true to cancel the open of a dialog.
507
- * @event
508
- * @blazorProperty 'OnDialogOpen'
509
- * @blazorType Syncfusion.EJ2.Blazor.Popups.BeforeOpenEventArgs
510
- */
511
-
512
- beforeDialogOpen?: EmitType<BeforeOpenEventArgs>;
513
-
514
- /**
515
- * Event triggers when a dialog is opened.
516
- * @event
517
- * @blazorProperty 'DialogOpened'
518
- * @blazorType DialogOpenEventArgs
519
- */
520
- dialogOpen?: EmitType<Object>;
521
-
522
- /**
523
- * Event triggers after the dialog has been closed.
524
- * @event
525
- * @blazorProperty 'DialogClosed'
526
- * @blazorType DialogCloseEventArgs
527
- */
528
- dialogClose?: EmitType<Object>;
529
-
530
- /**
531
- * Event triggers when the quick toolbar is being opened.
532
- * @event
533
- * @blazorProperty 'OnQuickToolbarOpen'
534
- */
535
-
536
- beforeQuickToolbarOpen?: EmitType<BeforeQuickToolbarOpenArgs>;
537
-
538
- /**
539
- * Event triggers when a quick toolbar is opened.
540
- * @event
541
- * @blazorProperty 'QuickToolbarOpened'
542
- * @blazorType QuickToolbarEventArgs
543
- */
544
- quickToolbarOpen?: EmitType<Object>;
10
+ * Specifies the group of items aligned horizontally in the toolbar as well as defined the toolbar rendering type.
11
+ * By default, toolbar is float at the top of the RichTextEditor.
12
+ * When you scroll down, the toolbar will scroll along with the page on Rich Text Editor with the specified offset value.
13
+ * * enable: set boolean value to show or hide the toolbar.
14
+ * * enableFloating: Set Boolean value to enable or disable the floating toolbar.
15
+ * Preserves the toolbar at top of the Rich Text Editor on scrolling.
16
+ * * type: it has two possible options
17
+ * 1. Expand: Hide the overflowing toolbar items in the next row. Click the expand arrow to view overflowing toolbar items
18
+ * 2. MultiRow: The toolbar overflowing items wrapped in the next row.
19
+ * * items: Specifies the array of items aligned horizontally in the toolbar.
20
+ * > | and - can insert a vertical and horizontal separator lines in the toolbar.
21
+ * * itemConfigs: Modify the default toolbar item configuration like icon class.
22
+ *
23
+ * > By default, The toolbar is rendered with scrollable in mobile devices and does not support the toolbar type.
24
+ *
25
+ * {% codeBlock src='rich-text-editor/toolbar-settings/index.md' %}{% endcodeBlock %}
26
+ *
27
+ * @default
28
+ * {
29
+ * enable: true,
30
+ * enableFloating: true,
31
+ * type: ToolbarType.Expand,
32
+ * items: ['Bold', 'Italic', 'Underline', '|', 'Formats', 'Alignments', 'OrderedList',
33
+ * 'UnorderedList', '|', 'CreateLink', 'Image', '|', 'SourceCode', 'Undo', 'Redo'],
34
+ * itemConfigs: {}
35
+ * }
36
+ */
37
+ toolbarSettings?: ToolbarSettingsModel;
38
+
39
+ /**
40
+ * Specifies the items to be rendered in quick toolbar based on the target element.
41
+ * * It has following fields:
42
+ * * enable - set boolean value to show or hide the quick toolbar
43
+ * * actionOnScroll - it has two possible options
44
+ * 1. hide: The quickToolbar is closed when the parent element is scrolled.
45
+ * 2. none: The quickToolbar cannot be closed even the parent element is scrolled.
46
+ * * link - Specifies the items to be rendered in quick toolbar based on link element such as `Open`, `Edit`, and `UnLink`.
47
+ * * image - Specifies the items to be rendered in quick toolbar based on image element such as 'Replace',
48
+ * 'Align', 'Caption', 'Remove', 'InsertLink', 'Display', 'AltText', 'Dimension'.
49
+ * * text - Specifies the items to be rendered in quick toolbar based on text element such as 'Cut', 'Copy', 'Paste'.
50
+ *
51
+ * {% codeBlock src='rich-text-editor/quick-toolbar-settings/index.md' %}{% endcodeBlock %}
52
+ *
53
+ * @default
54
+ * {
55
+ * enable: true,
56
+ * actionOnScroll: 'hide',
57
+ * link: ['Open', 'Edit', 'UnLink'],
58
+ * image: ['Replace', 'Align', 'Caption', 'Remove', '-', 'InsertLink', 'Display', 'AltText', 'Dimension'],
59
+ * text: ['Cut', 'Copy', 'Paste']
60
+ * }
61
+ */
62
+ quickToolbarSettings?: QuickToolbarSettingsModel;
63
+
64
+ /**
65
+ * Specifies the pasting options in Rich Text Editor component and control with the following properties.
66
+ * * prompt - Set boolean value to enable or disable the prompt when pasting.
67
+ * * deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
68
+ * * allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
69
+ * * deniedTags - Specifies the tags to restrict when pasting in RTE.
70
+ * * keepFormat - Set boolean value to keep or remove the from when pasting.
71
+ * * plainText - Set boolean value to paste as plain text or not.
72
+ *
73
+ * {% codeBlock src='rich-text-editor/paste-cleanup-settings/index.md' %}{% endcodeBlock %}
74
+ *
75
+ * @default
76
+ * {
77
+ * prompt: false,
78
+ * deniedAttrs: null,
79
+ * allowedStyleProps: ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius',
80
+ * 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor',
81
+ * 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style',
82
+ * 'height', 'left', 'line-height', 'margin', 'margin-top', 'margin-left',
83
+ * 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width',
84
+ * 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right',
85
+ * 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent',
86
+ * 'top', 'vertical-align', 'visibility', 'white-space', 'width'],
87
+ * deniedTags: null,
88
+ * keepFormat: true,
89
+ * plainText: false
90
+ * }
91
+ */
92
+ pasteCleanupSettings?: PasteCleanupSettingsModel;
93
+
94
+ /**
95
+ * Specifies the items to be rendered in an iframe mode, and it has the following properties.
96
+ * * enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
97
+ * * attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
98
+ * * resources - we can add both styles and scripts to the iframe.
99
+ * 1. styles[] - An array of CSS style files to inject inside the iframe to display content
100
+ * 2. scripts[] - An array of JS script files to inject inside the iframe
101
+ *
102
+ * {% codeBlock src='rich-text-editor/iframe-settings/index.md' %}{% endcodeBlock %}
103
+ *
104
+ * @default
105
+ * {
106
+ * enable: false,
107
+ * attributes: null,
108
+ * resources: { styles: [], scripts: [] }
109
+ * }
110
+ */
111
+ iframeSettings?: IFrameSettingsModel;
112
+
113
+ /**
114
+ * Specifies the image insert options in Rich Text Editor component and control with the following properties.
115
+ * * allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and
116
+ * passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
117
+ * * display - Sets the default display for an image when it is inserted in to the RichTextEditor.
118
+ * Possible options are: 'inline' and 'block'.
119
+ * * width - Sets the default width of the image when it is inserted in the RichTextEditor.
120
+ * * saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).
121
+ * > If you want to insert a lot of tiny images in the editor and don't want a specific physical location for
122
+ * saving images, you can opt to save format as Base64.
123
+ * * height - Sets the default height of the image when it is inserted in the RichTextEditor.
124
+ * * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
125
+ * * path - Specifies the path of the location to store the images and refer it to display the images.
126
+ *
127
+ * {% codeBlock src='rich-text-editor/insert-image-settings/index.md' %}{% endcodeBlock %}
128
+ *
129
+ * @default
130
+ * {
131
+ * allowedTypes: ['.jpeg', '.jpg', '.png'],
132
+ * display: 'inline',
133
+ * width: 'auto',
134
+ * height: 'auto',
135
+ * saveFormat: 'Blob'
136
+ * saveUrl: null,
137
+ * path: null,
138
+ * }
139
+ */
140
+ insertImageSettings?: ImageSettingsModel;
141
+
142
+ /**
143
+ * Specifies the table insert options in Rich Text Editor component and control with the following properties.
144
+ * * styles - Class name should be appended by default in table element.
145
+ * It helps to design the table in specific CSS styles always when inserting in editor.
146
+ * * width - Sets the default width of the table when it is inserted in the RichTextEditor.
147
+ * * minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
148
+ * * maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
149
+ * * resize - To enable resize the table.
150
+ *
151
+ * {% codeBlock src='rich-text-editor/table-settings/index.md' %}{% endcodeBlock %}
152
+ *
153
+ * @default
154
+ * {
155
+ * width: '100%',
156
+ * styles: [{ text: 'Dashed Borders', class: 'e-dashed-borders', command: 'Table', subCommand: 'Dashed' },
157
+ * { text: 'Alternate Rows', class: 'e-alternate-rows', command: 'Table', subCommand: 'Alternate' }],
158
+ * resize: true,
159
+ * minWidth: 0,
160
+ * maxWidth: null,
161
+ * }
162
+ */
163
+ tableSettings?: TableSettingsModel;
164
+
165
+ /**
166
+ * Preserves the toolbar at the top of the Rich Text Editor on scrolling and
167
+ * specifies the offset of the floating toolbar from documents top position
168
+ * @default 0
169
+ */
170
+ floatingToolbarOffset?: number;
171
+
172
+ /**
173
+ * Enable or disable the inline edit mode.
174
+ * * enable - set boolean value to enable or disable the inline edit mode.
175
+ * * onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline.
176
+ * If its set to false, upon clicking to the target element, the toolbar is opened.
177
+ *
178
+ * {% codeBlock src='rich-text-editor/inline-mode/index.md' %}{% endcodeBlock %}
179
+ *
180
+ * @default
181
+ * {
182
+ * enable: false,
183
+ * onSelection: true
184
+ * }
185
+ */
186
+ inlineMode?: InlineModeModel;
187
+
188
+ /**
189
+ * Specifies the width of the RichTextEditor.
190
+ * @default '100%'
191
+ */
192
+ width?: string | number;
193
+
194
+ /**
195
+ * Enables or disables the persisting component's state between page reloads.
196
+ * If enabled, the value of Rich Text Editor is persisted
197
+ *
198
+ * {% codeBlock src='rich-text-editor/enable-persistence/index.md' %}{% endcodeBlock %}
199
+ *
200
+ * @default false.
201
+ */
202
+ enablePersistence?: boolean;
203
+
204
+ /**
205
+ * Enables or disables the resizing option in the editor.
206
+ * If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.
207
+ *
208
+ * {% codeBlock src='rich-text-editor/enable-resize/index.md' %}{% endcodeBlock %}
209
+ *
210
+ * @default false.
211
+ */
212
+ enableResize?: boolean;
213
+
214
+ /**
215
+ * Allows additional HTML attributes such as title, name, etc., and
216
+ * It will be accepts n number of attributes in a key-value pair format.
217
+ * @default {}.
218
+ */
219
+ htmlAttributes?: { [key: string]: string; };
220
+
221
+ /**
222
+ * Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.
223
+ * @default null.
224
+ */
225
+ placeholder?: string;
226
+
227
+ /**
228
+ * Enables or disables the auto-save option which performs the save action while in the idle state after typed content.
229
+ * If enabled, the Rich Text Editor will save the content on idle state with `saveInterval` property's value.
230
+ * The change event will be triggered if the content has changed from the last saved state.
231
+ * @default false.
232
+ */
233
+ autoSaveOnIdle?: boolean;
234
+
235
+ /**
236
+ * The user interactions on the component are disabled, when set to true.
237
+ * @default false.
238
+ */
239
+ readonly?: boolean;
240
+
241
+ /**
242
+ * Specifies a value that indicates whether the component is enabled or not.
243
+ *
244
+ * {% codeBlock src='rich-text-editor/enabled/index.md' %}{% endcodeBlock %}
245
+ *
246
+ * @default true.
247
+ */
248
+ enabled?: boolean;
249
+
250
+ /**
251
+ * Defines whether to allow the cross-scripting site or not.
252
+ * @default true
253
+ */
254
+ enableHtmlSanitizer?: boolean;
255
+
256
+ /**
257
+ * specifies the value whether the source code is displayed with encoded format.
258
+ * @default false.
259
+ */
260
+ enableHtmlEncode?: boolean;
261
+
262
+ /**
263
+ * Specifies a value that indicates whether the xhtml is enabled or not.
264
+ * @default false.
265
+ */
266
+ enableXhtml?: boolean;
267
+
268
+ /**
269
+ * Specifies the height of the Rich Text Editor component.
270
+ * @default "auto"
271
+ */
272
+ height?: string | number;
273
+
274
+ /**
275
+ * Specifies the CSS class name appended with the root element of the RichTextEditor.
276
+ * One or more custom CSS classes can be added to a RichTextEditor.
277
+ * @default null
278
+ */
279
+ cssClass?: string;
280
+
281
+ /**
282
+ * Specifies the value displayed in the RichTextEditor's content area and it should be string.
283
+ * The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.
284
+ *
285
+ * {% codeBlock src='rich-text-editor/value/index.md' %}{% endcodeBlock %}
286
+ *
287
+ * @default null
288
+ */
289
+ value?: string;
290
+
291
+ /**
292
+ * Specifies the count of undo history which is stored in undoRedoManager.
293
+ *
294
+ * {% codeBlock src='rich-text-editor/undo-redo-steps/index.md' %}{% endcodeBlock %}
295
+ *
296
+ * @default 30
297
+ */
298
+ undoRedoSteps?: number;
299
+
300
+ /**
301
+ * Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
302
+ * @default 300
303
+ */
304
+ undoRedoTimer?: number;
305
+
306
+ /**
307
+ * Specifies the editing mode of the RichTextEditor.
308
+ *
309
+ * - `HTML` - Render Rich Text Editor as HTML editor using &lt;IFRAME&gt; element or content editable &lt;div&gt; element
310
+ * or &lt;textarea&gt; element.
311
+ *
312
+ * - `Markdown` - Render Rich Text Editor as markdown editor using &lt;textarea&gt;.
313
+ *
314
+ * @default 'HTML'
315
+ */
316
+ editorMode?: EditorMode;
317
+
318
+ /**
319
+ * Customizes the key actions in RichTextEditor.
320
+ * For example, when using German keyboard, the key actions can be customized using these shortcuts.
321
+ *
322
+ * {% codeBlock src='rich-text-editor/keyconfig/index.md' %}{% endcodeBlock %}
323
+ *
324
+ * @default null
325
+ */
326
+ keyConfig?: { [key: string]: string };
327
+
328
+ /**
329
+ * Sets Boolean value to enable or disable the display of the character counter.
330
+ *
331
+ * {% codeBlock src='rich-text-editor/show-char-count/index.md' %}{% endcodeBlock %}
332
+ *
333
+ * @default false
334
+ */
335
+ showCharCount?: boolean;
336
+
337
+ /**
338
+ * Allows the tab key action in the Rich Text Editor content.
339
+ *
340
+ * {% codeBlock src='rich-text-editor/enable-tab-key/index.md' %}{% endcodeBlock %}
341
+ *
342
+ * @default false
343
+ */
344
+ enableTabKey?: boolean;
345
+
346
+ /**
347
+ * Enable `enableAutoUrl` to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise
348
+ * the given URL will automatically convert to absolute path URL by prefixing `https://` for hyperlinks.
349
+ *
350
+ * {% codeBlock src='rich-text-editor/enable-autourl/index.md' %}{% endcodeBlock %}
351
+ *
352
+ * @default false
353
+ */
354
+ enableAutoUrl?: boolean;
355
+
356
+ /**
357
+ * Specifies the maximum number of characters allowed in the Rich Text Editor component.
358
+ *
359
+ * {% codeBlock src='rich-text-editor/max-length/index.md' %}{% endcodeBlock %}
360
+ *
361
+ * @default -1
362
+ */
363
+ maxLength?: number;
364
+
365
+ /**
366
+ * Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
367
+ *
368
+ * {% codeBlock src='rich-text-editor/format/index.md' %}{% endcodeBlock %}
369
+ *
370
+ * @default
371
+ * {
372
+ * default: 'Paragraph',
373
+ * width: '65px',
374
+ * types: [
375
+ * { text: 'Paragraph' },
376
+ * { text: 'Code' },
377
+ * { text: 'Quotation' },
378
+ * { text: 'Heading 1' },
379
+ * { text: 'Heading 2' },
380
+ * { text: 'Heading 3' },
381
+ * { text: 'Heading 4' },
382
+ * { text: 'Heading 5' },
383
+ * { text: 'Heading 6' }
384
+ * ]
385
+ * }
386
+ */
387
+ format?: FormatModel;
388
+
389
+ /**
390
+ * Predefine the font families that populate in font family dropdown list from the toolbar.
391
+ *
392
+ * {% codeBlock src='rich-text-editor/font-family/index.md' %}{% endcodeBlock %}
393
+ *
394
+ * @default
395
+ * {
396
+ * default: 'Segoe UI',
397
+ * width: '65px',
398
+ * items: [
399
+ * { text: 'Segoe UI', value: 'Segoe UI' },
400
+ * { text: 'Arial', value: 'Arial,Helvetica,sans-serif' },
401
+ * { text: 'Courier New', value: 'Courier New,Courier,monospace' },
402
+ * { text: 'Georgia', value: 'Georgia,serif' },
403
+ * { text: 'Impact', value: 'Impact,Charcoal,sans-serif' },
404
+ * { text: 'Lucida Console', value: 'Lucida Console,Monaco,monospace' },
405
+ * { text: 'Tahoma', value: 'Tahoma,Geneva,sans-serif' },
406
+ * { text: 'Times New Roman', value: 'Times New Roman,Times,serif' },
407
+ * { text: 'Trebuchet MS', value: 'Trebuchet MS,Helvetica,sans-serif' },
408
+ * { text: 'Verdana', value: 'Verdana,Geneva,sans-serif' }
409
+ * ]
410
+ * }
411
+ */
412
+ fontFamily?: FontFamilyModel;
413
+
414
+ /**
415
+ * Predefine the font sizes that populate in font size dropdown list from the toolbar.
416
+ *
417
+ * {% codeBlock src='rich-text-editor/font-size/index.md' %}{% endcodeBlock %}
418
+ *
419
+ * @default
420
+ * {
421
+ * default: '10',
422
+ * width: '35px',
423
+ * items: [
424
+ * { text: '8', value: '8pt' },
425
+ * { text: '10', value: '10pt' },
426
+ * { text: '12', value: '12pt' },
427
+ * { text: '14', value: '14pt' },
428
+ * { text: '18', value: '18pt' },
429
+ * { text: '24', value: '24pt' },
430
+ * { text: '36', value: '36pt' }
431
+ * ]
432
+ * }
433
+ */
434
+ fontSize?: FontSizeModel;
435
+
436
+ /**
437
+ * Predefine the color palette that can be rendered for font color toolbar command .
438
+ *
439
+ * {% codeBlock src='rich-text-editor/font-color/index.md' %}{% endcodeBlock %}
440
+ *
441
+ * @default
442
+ * {
443
+ * columns: 10,
444
+ * colorCode: {
445
+ * 'Custom': [
446
+ * '', '#000000', '#e7e6e6', '#44546a', '#4472c4', '#ed7d31', '#a5a5a5', '#ffc000', '#70ad47', '#ff0000',
447
+ * '#f2f2f2', '#808080', '#cfcdcd', '#d5dce4', '#d9e2f3', '#fbe4d5', '#ededed', '#fff2cc', '#e2efd9', '#ffcccc',
448
+ * '#d9d9d9', '#595959', '#aeaaaa', '#acb9ca', '#b4c6e7', '#f7caac', '#dbdbdb', '#ffe599', '#c5e0b3', '#ff8080',
449
+ * '#bfbfbf', '#404040', '#747070', '#8496b0', '#8eaadb', '#f4b083', '#c9c9c9', '#ffd966', '#a8d08d', '#ff3333',
450
+ * '#a6a6a6', '#262626', '#3b3838', '#323e4f', '#2f5496', '#c45911', '#7b7b7b', '#bf8f00', '#538135', '#b30000',
451
+ * '#7f7f7f', '#0d0d0d', '#161616', '#212934', '#1f3763', '#823b0b', '#525252', '#7f5f00', '#375623', '#660000']
452
+ * }
453
+ * }
454
+ */
455
+ fontColor?: FontColorModel;
456
+
457
+ /**
458
+ * Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
459
+ *
460
+ * {% codeBlock src='rich-text-editor/background-color/index.md' %}{% endcodeBlock %}
461
+ *
462
+ * @default
463
+ * {
464
+ * columns: 5,
465
+ * colorCode: {
466
+ * 'Custom': ['#ffff00', '#00ff00', '#00ffff', '#ff00ff', '#0000ff', '#ff0000',
467
+ * '#000080', '#008080', '#008000', '#800080', '#800000', '#808000',
468
+ * '#c0c0c0', '#000000', '']
469
+ * }
470
+ * }
471
+ */
472
+ backgroundColor?: BackgroundColorModel;
473
+
474
+ /**
475
+ * Accepts the template design and assigns it as RichTextEditor’s content.
476
+ * The built-in template engine which provides options to compile template string into a executable function.
477
+ * For EX: We have expression evolution as like ES6 expression string literals
478
+ *
479
+ * {% codeBlock src='rich-text-editor/value-template/index.md' %}{% endcodeBlock %}
480
+ *
481
+ * @default null
482
+ */
483
+ valueTemplate?: string;
484
+
485
+ /**
486
+ * Specifies the saveInterval in milliseconds for autosave the value.
487
+ * The change event will be triggered if the content was changed from the last saved interval.
488
+ *
489
+ * {% codeBlock src='rich-text-editor/save-interval/index.md' %}{% endcodeBlock %}
490
+ *
491
+ * @default 10000
492
+ */
493
+ saveInterval?: number;
494
+
495
+ /**
496
+ * Triggers before command execution using toolbar items or executeCommand method.
497
+ * If you cancel this event, the command cannot be executed.
498
+ * Set the cancel argument to true to cancel the command execution.
499
+ * @event
500
+ * @blazorProperty 'OnActionBegin'
501
+ */
502
+ actionBegin?: EmitType<ActionBeginEventArgs>;
503
+
504
+ /**
505
+ * Triggers after command execution using toolbar items or executeCommand method.
506
+ * @event
507
+ * @blazorProperty 'OnActionComplete'
508
+ */
509
+ actionComplete?: EmitType<ActionCompleteEventArgs>;
510
+
511
+ /**
512
+ * Event triggers when the dialog is being opened.
513
+ * If you cancel this event, the dialog remains closed.
514
+ * Set the cancel argument to true to cancel the open of a dialog.
515
+ * @event
516
+ * @blazorProperty 'OnDialogOpen'
517
+ * @blazorType Syncfusion.EJ2.Blazor.Popups.BeforeOpenEventArgs
518
+ */
519
+
520
+ beforeDialogOpen?: EmitType<BeforeOpenEventArgs>;
521
+
522
+ /**
523
+ * Event triggers when a dialog is opened.
524
+ * @event
525
+ * @blazorProperty 'DialogOpened'
526
+ * @blazorType DialogOpenEventArgs
527
+ */
528
+ dialogOpen?: EmitType<Object>;
529
+
530
+ /**
531
+ * Event triggers when the dialog is being closed.
532
+ * If you cancel this event, the dialog remains opened.
533
+ * Set the cancel argument to true to prevent closing a dialog.
534
+ * @event
535
+ * @blazorProperty 'OnDialogClose'
536
+ * @blazorType Syncfusion.EJ2.Blazor.Popups.BeforeOpenEventArgs
537
+ */
538
+ beforeDialogClose?: EmitType<BeforeCloseEventArgs>;
539
+
540
+ /**
541
+ * Event triggers after the dialog has been closed.
542
+ * @event
543
+ * @blazorProperty 'DialogClosed'
544
+ * @blazorType DialogCloseEventArgs
545
+ */
546
+ dialogClose?: EmitType<Object>;
547
+
548
+ /**
549
+ * Event triggers when the quick toolbar is being opened.
550
+ * @event
551
+ * @blazorProperty 'OnQuickToolbarOpen'
552
+ */
553
+
554
+ beforeQuickToolbarOpen?: EmitType<BeforeQuickToolbarOpenArgs>;
555
+
556
+ /**
557
+ * Event triggers when a quick toolbar is opened.
558
+ * @event
559
+ * @blazorProperty 'QuickToolbarOpened'
560
+ * @blazorType QuickToolbarEventArgs
561
+ */
562
+ quickToolbarOpen?: EmitType<Object>;
563
+
564
+ /**
565
+ * Event triggers after the quick toolbar has been closed.
566
+ * @event
567
+ * @blazorProperty 'QuickToolbarClosed'
568
+ * @blazorType QuickToolbarEventArgs
569
+ */
570
+ quickToolbarClose?: EmitType<Object>;
545
571
 
546
572
  /**
547
- * Event triggers after the quick toolbar has been closed.
548
- * @event
549
- * @blazorProperty 'QuickToolbarClosed'
550
- * @blazorType QuickToolbarEventArgs
551
- */
552
- quickToolbarClose?: EmitType<Object>;
573
+ * Triggers when the undo and redo status is updated.
574
+ * @event
575
+ * @blazorType ToolbarUpdateEventArgs
576
+ */
577
+ toolbarStatusUpdate?: EmitType<Object>;
553
578
 
554
579
  /**
555
- * Triggers when the undo and redo status is updated.
556
- * @event
557
- * @blazorType ToolbarUpdateEventArgs
558
- */
559
- toolbarStatusUpdate?: EmitType<Object>;
580
+ * Event triggers when the image is selected or dragged into the insert image dialog.
581
+ * @event
582
+ * @blazorProperty 'OnImageSelected'
583
+ */
584
+ imageSelected?: EmitType<SelectedEventArgs>;
560
585
 
561
586
  /**
562
- * Event triggers when the image is selected or dragged into the insert image dialog.
563
- * @event
564
- * @blazorProperty 'OnImageSelected'
565
- */
566
- imageSelected?: EmitType<SelectedEventArgs>;
587
+ * Event triggers when the selected image begins to upload in the insert image dialog.
588
+ * @event
589
+ * @blazorProperty 'OnImageUploading'
590
+ */
591
+ imageUploading?: EmitType<UploadingEventArgs>;
567
592
 
568
593
  /**
569
- * Event triggers when the selected image begins to upload in the insert image dialog.
570
- * @event
571
- * @blazorProperty 'OnImageUploading'
572
- */
573
- imageUploading?: EmitType<UploadingEventArgs>;
594
+ * Event triggers when the image is successfully uploaded to the server side.
595
+ * @event
596
+ * @blazorProperty 'OnImageUploadSuccess'
597
+ * @blazorType ImageSuccessEventArgs
598
+ */
599
+ imageUploadSuccess?: EmitType<Object>;
574
600
 
575
601
  /**
576
- * Event triggers when the image is successfully uploaded to the server side.
577
- * @event
578
- * @blazorProperty 'OnImageUploadSuccess'
579
- * @blazorType ImageSuccessEventArgs
580
- */
581
- imageUploadSuccess?: EmitType<Object>;
602
+ * Event triggers when there is an error in the image upload.
603
+ * @event
604
+ * @blazorProperty 'OnImageUploadFailed'
605
+ * @blazorType ImageFailedEventArgs
606
+ */
607
+ imageUploadFailed?: EmitType<Object>;
582
608
 
583
609
  /**
584
- * Event triggers when there is an error in the image upload.
585
- * @event
586
- * @blazorProperty 'OnImageUploadFailed'
587
- * @blazorType ImageFailedEventArgs
588
- */
589
- imageUploadFailed?: EmitType<Object>;
610
+ * Event triggers when the selected image is cleared from the insert image dialog.
611
+ * @event
612
+ * @blazorProperty 'OnImageRemoving'
613
+ */
614
+ imageRemoving?: EmitType<RemovingEventArgs>;
590
615
 
591
616
  /**
592
- * Event triggers when the selected image is cleared from the insert image dialog.
593
- * @event
594
- * @blazorProperty 'OnImageRemoving'
595
- */
596
- imageRemoving?: EmitType<RemovingEventArgs>;
617
+ * Event triggers when the selected image is cleared from the Rich Text Editor Content.
618
+ * @event
619
+ * @blazorProperty 'OnImageDelete'
620
+ */
621
+ afterImageDelete?: EmitType<AfterImageDeleteEventArgs>;
597
622
 
598
623
  /**
599
- * Event triggers when the selected image is cleared from the Rich Text Editor Content.
600
- * @event
601
- * @blazorProperty 'ImageDelete'
602
- */
603
- afterImageDelete?: EmitType<Object>;
624
+ * Triggers when the Rich Text Editor is rendered.
625
+ * @event
626
+ * @blazorProperty 'Created'
627
+ */
628
+ created?: EmitType<Object>;
604
629
 
605
630
  /**
606
- * Triggers when the Rich Text Editor is rendered.
607
- * @event
608
- * @blazorProperty 'Created'
609
- */
610
- created?: EmitType<Object>;
631
+ * Triggers when the Rich Text Editor is destroyed.
632
+ * @event
633
+ * @blazorProperty 'Destroyed'
634
+ * @blazorType DestroyedEventArgs
635
+ */
636
+ destroyed?: EmitType<Object>;
611
637
 
612
638
  /**
613
- * Triggers when the Rich Text Editor is destroyed.
614
- * @event
615
- * @blazorProperty 'Destroyed'
616
- * @blazorType DestroyedEventArgs
617
- */
618
- destroyed?: EmitType<Object>;
639
+ * Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.
640
+ * @event
641
+ * @blazorProperty 'OnSanitizeHtml'
642
+ */
643
+ beforeSanitizeHtml?: EmitType<BeforeSanitizeHtmlArgs>;
619
644
 
620
645
  /**
621
- * Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.
622
- * @event
623
- * @blazorProperty 'OnSanitizeHtml'
624
- */
625
- beforeSanitizeHtml?: EmitType<BeforeSanitizeHtmlArgs>;
646
+ * Triggers when Rich Text Editor is focused out.
647
+ * @event
648
+ * @blazorType BlurEventArgs
649
+ */
650
+ blur?: EmitType<Object>;
626
651
 
627
652
  /**
628
- * Triggers when Rich Text Editor is focused out.
629
- * @event
630
- * @blazorType BlurEventArgs
631
- */
632
- blur?: EmitType<Object>;
653
+ * Triggers when Rich Text Editor Toolbar items is clicked.
654
+ * @event
655
+ * @blazorProperty 'OnToolbarClick'
656
+ * @blazorType ToolbarClickEventArgs
657
+ */
658
+ toolbarClick?: EmitType<Object>;
633
659
 
634
660
  /**
635
- * Triggers when Rich Text Editor Toolbar items is clicked.
636
- * @event
637
- * @blazorProperty 'OnToolbarClick'
638
- * @blazorType ToolbarClickEventArgs
639
- */
640
- toolbarClick?: EmitType<Object>;
661
+ * Triggers when Rich Text Editor is focused in
662
+ * @event
663
+ * @blazorType FocusEventArgs
664
+ */
665
+ focus?: EmitType<Object>;
641
666
 
642
667
  /**
643
- * Triggers when Rich Text Editor is focused in
644
- * @event
645
- * @blazorType FocusEventArgs
646
- */
647
- focus?: EmitType<Object>;
668
+ * Triggers only when Rich Text Editor is blurred and changes are done to the content.
669
+ * @event
670
+ * @blazorProperty 'ValueChange'
671
+ */
672
+ change?: EmitType<ChangeEventArgs>;
648
673
 
649
674
  /**
650
- * Triggers only when Rich Text Editor is blurred and changes are done to the content.
651
- * @event
652
- * @blazorProperty 'ValueChange'
653
- */
654
- change?: EmitType<ChangeEventArgs>;
675
+ * Triggers only when resizing the image.
676
+ * @event
677
+ * @blazorProperty 'Resizing'
678
+ */
679
+ resizing?: EmitType<ResizeArgs>;
655
680
 
656
681
  /**
657
- * Triggers only when resizing the image.
658
- * @event
659
- * @blazorProperty 'Resizing'
660
- */
661
- resizing?: EmitType<ResizeArgs>;
682
+ * Triggers only when start resize the image.
683
+ * @event
684
+ * @blazorProperty 'OnResizeStart'
685
+ */
686
+ resizeStart?: EmitType<ResizeArgs>;
662
687
 
663
688
  /**
664
- * Triggers only when start resize the image.
665
- * @event
666
- * @blazorProperty 'OnResizeStart'
667
- */
668
- resizeStart?: EmitType<ResizeArgs>;
689
+ * Triggers only when stop resize the image.
690
+ * @event
691
+ * @blazorProperty 'OnResizeStop'
692
+ */
693
+ resizeStop?: EmitType<ResizeArgs>;
669
694
 
670
695
  /**
671
- * Triggers only when stop resize the image.
672
- * @event
673
- * @blazorProperty 'OnResizeStop'
674
- */
675
- resizeStop?: EmitType<ResizeArgs>;
676
-
677
- /**
678
- * Customize keyCode to change the key value.
679
- *
680
- * {% codeBlock src='rich-text-editor/formatter/index.md' %}{% endcodeBlock %}
681
- *
682
- * @default null
683
- * @blazorType object
684
- */
685
- formatter?: IFormatter;
696
+ * Customize keyCode to change the key value.
697
+ *
698
+ * {% codeBlock src='rich-text-editor/formatter/index.md' %}{% endcodeBlock %}
699
+ *
700
+ * @default null
701
+ * @blazorType object
702
+ */
703
+ formatter?: IFormatter;
686
704
 
687
705
  }