@syncfusion/ej2-richtexteditor 23.2.5 → 23.2.7-52849
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.
- package/.github/PULL_REQUEST_TEMPLATE/Bug.md +40 -40
- package/.github/PULL_REQUEST_TEMPLATE/Feature.md +27 -27
- package/CHANGELOG.md +1751 -1713
- package/README.md +76 -76
- package/dist/ej2-richtexteditor.umd.min.js +1 -10
- package/dist/ej2-richtexteditor.umd.min.js.map +1 -1
- package/dist/es6/ej2-richtexteditor.es2015.js +349 -199
- package/dist/es6/ej2-richtexteditor.es2015.js.map +1 -1
- package/dist/es6/ej2-richtexteditor.es5.js +459 -309
- package/dist/es6/ej2-richtexteditor.es5.js.map +1 -1
- package/helpers/e2e/index.js +3 -3
- package/helpers/e2e/rte-helper.js +13 -13
- package/license +9 -9
- package/package.json +74 -74
- package/src/common/interface.d.ts +7 -7
- package/src/editor-manager/base/classes.d.ts +1 -1
- package/src/editor-manager/base/classes.js +1 -1
- package/src/editor-manager/base/editor-manager.d.ts +3 -3
- package/src/editor-manager/base/editor-manager.js +3 -3
- package/src/editor-manager/base/enum.d.ts +2 -2
- package/src/editor-manager/base/interface.d.ts +10 -9
- package/src/editor-manager/base/types.d.ts +1 -1
- package/src/editor-manager/plugin/alignments.d.ts +2 -2
- package/src/editor-manager/plugin/alignments.js +2 -2
- package/src/editor-manager/plugin/audio.d.ts +3 -3
- package/src/editor-manager/plugin/audio.js +3 -3
- package/src/editor-manager/plugin/clearformat-exec.d.ts +2 -2
- package/src/editor-manager/plugin/clearformat-exec.js +2 -2
- package/src/editor-manager/plugin/clearformat.d.ts +1 -1
- package/src/editor-manager/plugin/clearformat.js +1 -1
- package/src/editor-manager/plugin/dom-node.d.ts +34 -34
- package/src/editor-manager/plugin/dom-node.js +34 -34
- package/src/editor-manager/plugin/format-painter-actions.d.ts +1 -1
- package/src/editor-manager/plugin/format-painter-actions.js +1 -1
- package/src/editor-manager/plugin/formats.d.ts +2 -2
- package/src/editor-manager/plugin/formats.js +2 -2
- package/src/editor-manager/plugin/image.d.ts +3 -3
- package/src/editor-manager/plugin/image.js +3 -3
- package/src/editor-manager/plugin/indents.d.ts +2 -2
- package/src/editor-manager/plugin/indents.js +2 -2
- package/src/editor-manager/plugin/insert-methods.d.ts +4 -4
- package/src/editor-manager/plugin/insert-methods.js +4 -4
- package/src/editor-manager/plugin/insert-text.d.ts +2 -2
- package/src/editor-manager/plugin/insert-text.js +2 -2
- package/src/editor-manager/plugin/inserthtml-exec.d.ts +2 -2
- package/src/editor-manager/plugin/inserthtml-exec.js +2 -2
- package/src/editor-manager/plugin/inserthtml.d.ts +2 -2
- package/src/editor-manager/plugin/inserthtml.js +5 -3
- package/src/editor-manager/plugin/isformatted.d.ts +8 -8
- package/src/editor-manager/plugin/isformatted.js +8 -8
- package/src/editor-manager/plugin/link.d.ts +2 -2
- package/src/editor-manager/plugin/link.js +4 -2
- package/src/editor-manager/plugin/lists.d.ts +2 -2
- package/src/editor-manager/plugin/lists.js +2 -2
- package/src/editor-manager/plugin/ms-word-clean-up.d.ts +1 -1
- package/src/editor-manager/plugin/ms-word-clean-up.js +7 -3
- package/src/editor-manager/plugin/nodecutter.d.ts +6 -6
- package/src/editor-manager/plugin/nodecutter.js +6 -6
- package/src/editor-manager/plugin/selection-commands.d.ts +1 -1
- package/src/editor-manager/plugin/selection-commands.js +1 -1
- package/src/editor-manager/plugin/selection-exec.d.ts +2 -2
- package/src/editor-manager/plugin/selection-exec.js +2 -2
- package/src/editor-manager/plugin/table.d.ts +2 -2
- package/src/editor-manager/plugin/table.js +2 -2
- package/src/editor-manager/plugin/toolbar-status.d.ts +2 -2
- package/src/editor-manager/plugin/toolbar-status.js +2 -2
- package/src/editor-manager/plugin/undo.d.ts +6 -6
- package/src/editor-manager/plugin/undo.js +6 -6
- package/src/editor-manager/plugin/video.d.ts +3 -3
- package/src/editor-manager/plugin/video.js +3 -3
- package/src/global.d.ts +1 -0
- package/src/markdown-parser/base/interface.d.ts +10 -10
- package/src/markdown-parser/base/markdown-parser.d.ts +3 -3
- package/src/markdown-parser/base/markdown-parser.js +3 -3
- package/src/markdown-parser/base/types.d.ts +1 -1
- package/src/markdown-parser/plugin/clearformat.d.ts +2 -2
- package/src/markdown-parser/plugin/clearformat.js +2 -2
- package/src/markdown-parser/plugin/formats.d.ts +2 -2
- package/src/markdown-parser/plugin/formats.js +2 -2
- package/src/markdown-parser/plugin/insert-text.d.ts +2 -2
- package/src/markdown-parser/plugin/insert-text.js +2 -2
- package/src/markdown-parser/plugin/link.d.ts +2 -2
- package/src/markdown-parser/plugin/link.js +2 -2
- package/src/markdown-parser/plugin/markdown-selection.d.ts +14 -14
- package/src/markdown-parser/plugin/markdown-selection.js +14 -14
- package/src/markdown-parser/plugin/md-selection-formats.d.ts +1 -1
- package/src/markdown-parser/plugin/md-selection-formats.js +1 -1
- package/src/markdown-parser/plugin/table.d.ts +3 -3
- package/src/markdown-parser/plugin/table.js +3 -3
- package/src/markdown-parser/plugin/undo.d.ts +6 -6
- package/src/markdown-parser/plugin/undo.js +6 -6
- package/src/rich-text-editor/actions/base-quick-toolbar.d.ts +9 -9
- package/src/rich-text-editor/actions/base-quick-toolbar.js +9 -9
- package/src/rich-text-editor/actions/base-toolbar.d.ts +3 -3
- package/src/rich-text-editor/actions/base-toolbar.js +3 -3
- package/src/rich-text-editor/actions/color-picker.d.ts +2 -2
- package/src/rich-text-editor/actions/color-picker.js +2 -2
- package/src/rich-text-editor/actions/count.d.ts +3 -3
- package/src/rich-text-editor/actions/count.js +3 -3
- package/src/rich-text-editor/actions/dropdown-buttons.d.ts +2 -2
- package/src/rich-text-editor/actions/dropdown-buttons.js +2 -2
- package/src/rich-text-editor/actions/emoji-picker.d.ts +1 -1
- package/src/rich-text-editor/actions/emoji-picker.js +1 -1
- package/src/rich-text-editor/actions/enter-key.js +1 -1
- package/src/rich-text-editor/actions/full-screen.d.ts +3 -3
- package/src/rich-text-editor/actions/full-screen.js +3 -3
- package/src/rich-text-editor/actions/html-editor.d.ts +3 -3
- package/src/rich-text-editor/actions/html-editor.js +13 -5
- package/src/rich-text-editor/actions/keyboard-model.d.ts +16 -16
- package/src/rich-text-editor/actions/keyboard.d.ts +1 -1
- package/src/rich-text-editor/actions/keyboard.js +20 -20
- package/src/rich-text-editor/actions/markdown-editor.d.ts +2 -2
- package/src/rich-text-editor/actions/markdown-editor.js +2 -2
- package/src/rich-text-editor/actions/paste-clean-up.d.ts +1 -1
- package/src/rich-text-editor/actions/paste-clean-up.js +6 -4
- package/src/rich-text-editor/actions/quick-toolbar.d.ts +9 -9
- package/src/rich-text-editor/actions/quick-toolbar.js +13 -10
- package/src/rich-text-editor/actions/toolbar.d.ts +13 -14
- package/src/rich-text-editor/actions/toolbar.js +13 -21
- package/src/rich-text-editor/actions/xhtml-validation.d.ts +1 -1
- package/src/rich-text-editor/actions/xhtml-validation.js +1 -1
- package/src/rich-text-editor/base/classes.d.ts +125 -120
- package/src/rich-text-editor/base/classes.js +125 -120
- package/src/rich-text-editor/base/constant.d.ts +149 -149
- package/src/rich-text-editor/base/constant.js +149 -149
- package/src/rich-text-editor/base/enum.d.ts +1 -1
- package/src/rich-text-editor/base/enum.js +1 -1
- package/src/rich-text-editor/base/interface.d.ts +50 -49
- package/src/rich-text-editor/base/interface.js +1 -1
- package/src/rich-text-editor/base/rich-text-editor-model.d.ts +891 -891
- package/src/rich-text-editor/base/rich-text-editor.d.ts +72 -60
- package/src/rich-text-editor/base/rich-text-editor.js +112 -76
- package/src/rich-text-editor/base/util.d.ts +1 -1
- package/src/rich-text-editor/base/util.js +1 -1
- package/src/rich-text-editor/formatter/formatter.d.ts +8 -8
- package/src/rich-text-editor/formatter/formatter.js +8 -8
- package/src/rich-text-editor/formatter/html-formatter.d.ts +2 -2
- package/src/rich-text-editor/formatter/html-formatter.js +15 -15
- package/src/rich-text-editor/formatter/markdown-formatter.d.ts +2 -2
- package/src/rich-text-editor/formatter/markdown-formatter.js +15 -15
- package/src/rich-text-editor/models/default-locale.js +1 -0
- package/src/rich-text-editor/models/iframe-settings-model.d.ts +26 -26
- package/src/rich-text-editor/models/iframe-settings.js +19 -19
- package/src/rich-text-editor/models/inline-mode-model.d.ts +11 -11
- package/src/rich-text-editor/models/inline-mode.js +19 -19
- package/src/rich-text-editor/models/toolbar-settings-model.d.ts +760 -760
- package/src/rich-text-editor/models/toolbar-settings.js +19 -19
- package/src/rich-text-editor/renderer/audio-module.d.ts +1 -1
- package/src/rich-text-editor/renderer/audio-module.js +1 -2
- package/src/rich-text-editor/renderer/content-renderer.d.ts +6 -6
- package/src/rich-text-editor/renderer/content-renderer.js +6 -6
- package/src/rich-text-editor/renderer/dialog-renderer.d.ts +3 -2
- package/src/rich-text-editor/renderer/dialog-renderer.js +13 -2
- package/src/rich-text-editor/renderer/iframe-content-renderer.d.ts +4 -4
- package/src/rich-text-editor/renderer/iframe-content-renderer.js +17 -17
- package/src/rich-text-editor/renderer/image-module.d.ts +1 -1
- package/src/rich-text-editor/renderer/image-module.js +19 -12
- package/src/rich-text-editor/renderer/link-module.d.ts +1 -1
- package/src/rich-text-editor/renderer/link-module.js +3 -2
- package/src/rich-text-editor/renderer/markdown-renderer.d.ts +6 -6
- package/src/rich-text-editor/renderer/markdown-renderer.js +6 -6
- package/src/rich-text-editor/renderer/popup-renderer.d.ts +5 -5
- package/src/rich-text-editor/renderer/popup-renderer.js +5 -5
- package/src/rich-text-editor/renderer/render.d.ts +2 -2
- package/src/rich-text-editor/renderer/render.js +2 -2
- package/src/rich-text-editor/renderer/table-module.d.ts +2 -1
- package/src/rich-text-editor/renderer/table-module.js +10 -2
- package/src/rich-text-editor/renderer/toolbar-renderer.d.ts +9 -9
- package/src/rich-text-editor/renderer/toolbar-renderer.js +88 -19
- package/src/rich-text-editor/renderer/video-module.d.ts +1 -1
- package/src/rich-text-editor/renderer/video-module.js +2 -3
- package/src/rich-text-editor/renderer/view-source.d.ts +6 -6
- package/src/rich-text-editor/renderer/view-source.js +15 -14
- package/src/rich-text-editor/services/renderer-factory.d.ts +3 -3
- package/src/rich-text-editor/services/renderer-factory.js +3 -3
- package/src/rich-text-editor/services/service-locator.d.ts +3 -3
- package/src/rich-text-editor/services/service-locator.js +3 -3
- package/src/selection/selection.d.ts +22 -22
- package/src/selection/selection.js +22 -22
- package/styles/_all.scss +1 -1
- package/styles/material3-dark.scss +1 -1
- package/styles/material3.scss +1 -1
- package/styles/rich-text-editor/_all.scss +2 -2
- package/styles/rich-text-editor/_bootstrap-dark-definition.scss +277 -277
- package/styles/rich-text-editor/_bootstrap-definition.scss +334 -334
- package/styles/rich-text-editor/_bootstrap4-definition.scss +460 -460
- package/styles/rich-text-editor/_bootstrap5-definition.scss +262 -262
- package/styles/rich-text-editor/_fabric-dark-definition.scss +259 -259
- package/styles/rich-text-editor/_fabric-definition.scss +257 -257
- package/styles/rich-text-editor/_fluent-definition.scss +263 -263
- package/styles/rich-text-editor/_fusionnew-definition.scss +261 -261
- package/styles/rich-text-editor/_highcontrast-definition.scss +257 -257
- package/styles/rich-text-editor/_highcontrast-light-definition.scss +257 -257
- package/styles/rich-text-editor/_layout.scss +2072 -2072
- package/styles/rich-text-editor/_material-dark-definition.scss +262 -262
- package/styles/rich-text-editor/_material-definition.scss +260 -260
- package/styles/rich-text-editor/_material3-definition.scss +262 -262
- package/styles/rich-text-editor/_tailwind-definition.scss +257 -257
- package/styles/rich-text-editor/_theme.scss +837 -837
- package/styles/rich-text-editor/icons/_bootstrap-dark.scss +349 -349
- package/styles/rich-text-editor/icons/_bootstrap.scss +349 -349
- package/styles/rich-text-editor/icons/_bootstrap4.scss +349 -349
- package/styles/rich-text-editor/icons/_bootstrap5.scss +348 -348
- package/styles/rich-text-editor/icons/_fabric-dark.scss +349 -349
- package/styles/rich-text-editor/icons/_fabric.scss +349 -349
- package/styles/rich-text-editor/icons/_fluent.scss +348 -348
- package/styles/rich-text-editor/icons/_fusionnew.scss +348 -348
- package/styles/rich-text-editor/icons/_highcontrast-light.scss +349 -349
- package/styles/rich-text-editor/icons/_highcontrast.scss +349 -349
- package/styles/rich-text-editor/icons/_material-dark.scss +349 -349
- package/styles/rich-text-editor/icons/_material.scss +349 -349
- package/styles/rich-text-editor/icons/_material3.scss +348 -348
- package/styles/rich-text-editor/icons/_tailwind.scss +348 -348
- package/styles/rich-text-editor/material3-dark.scss +1 -1
- package/styles/rich-text-editor/material3.scss +1 -1
- package/.eslintrc.json +0 -260
- package/dist/ej2-richtexteditor.min.js +0 -10
- package/dist/global/ej2-richtexteditor.min.js +0 -11
- package/dist/global/ej2-richtexteditor.min.js.map +0 -1
- package/dist/global/index.d.ts +0 -14
- package/tslint.json +0 -111
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Component, ModuleDeclaration, EventHandler, Complex, Browser, EmitType, addClass, select, detach } from '@syncfusion/ej2-base';
|
|
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,959 +7,959 @@ 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
|
-
* audio: ['AudioReplace', 'AudioRemove', 'AudioLayoutOption'],
|
|
60
|
-
* video: ['VideoReplace', 'VideoAlign', 'VideoRemove', 'VideoLayoutOption', 'VideoDimension'],
|
|
61
|
-
* }
|
|
62
|
-
*/
|
|
63
|
-
quickToolbarSettings?: QuickToolbarSettingsModel;
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* Specifies the pasting options in Rich Text Editor component and control with the following properties.
|
|
67
|
-
* * prompt - Set boolean value to enable or disable the prompt when pasting.
|
|
68
|
-
* * deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
|
|
69
|
-
* * allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
|
|
70
|
-
* * deniedTags - Specifies the tags to restrict when pasting in RTE.
|
|
71
|
-
* * keepFormat - Set boolean value to keep or remove the from when pasting.
|
|
72
|
-
* * plainText - Set boolean value to paste as plain text or not.
|
|
73
|
-
*
|
|
74
|
-
* {% codeBlock src='rich-text-editor/paste-cleanup-settings/index.md' %}{% endcodeBlock %}
|
|
75
|
-
*
|
|
76
|
-
* @default
|
|
77
|
-
* {
|
|
78
|
-
* prompt: false,
|
|
79
|
-
* deniedAttrs: null,
|
|
80
|
-
* allowedStyleProps: ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius',
|
|
81
|
-
* 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor',
|
|
82
|
-
* 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style',
|
|
83
|
-
* 'height', 'left', 'line-height', 'list-style-type', 'margin', 'margin-top', 'margin-left',
|
|
84
|
-
* 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width',
|
|
85
|
-
* 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right',
|
|
86
|
-
* 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent',
|
|
87
|
-
* 'top', 'vertical-align', 'visibility', 'white-space', 'width'],
|
|
88
|
-
* deniedTags: null,
|
|
89
|
-
* keepFormat: true,
|
|
90
|
-
* plainText: false
|
|
91
|
-
* }
|
|
92
|
-
*/
|
|
93
|
-
pasteCleanupSettings?: PasteCleanupSettingsModel;
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
* Specifies the format painter options in Rich Text Editor with the following properties.
|
|
97
|
-
* * allowedFormats - Sets the tag name selectors for elements from which the formats can be copied.
|
|
98
|
-
* * deniedFormats - Sets the selectors for elements from which formats cannot be copied.
|
|
99
|
-
*
|
|
100
|
-
* {% codeBlock src='rich-text-editor/format-painter-settings/index.md' %}{% endcodeBlock %}
|
|
101
|
-
*
|
|
102
|
-
* @default
|
|
103
|
-
* {
|
|
104
|
-
* allowedFormats: 'b; em; font; sub; sup; kbd; i; s; u; code; strong; span; p; div; h1; h2; h3; h4; h5; h6; blockquote; ol; ul; li; pre;',
|
|
105
|
-
* deniedFormats: null
|
|
106
|
-
* }
|
|
107
|
-
*/
|
|
108
|
-
formatPainterSettings?: FormatPainterSettingsModel
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Specifies the emoji picker options in Rich Text Editor with the following properties.
|
|
112
|
-
* * iconsSet – Specify an array of items representing emoji icons.
|
|
113
|
-
* * showSearchBox - Enables or disables the search box in an emoji picker.
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*/
|
|
117
|
-
emojiPickerSettings?: EmojiSettingsModel
|
|
118
|
-
|
|
119
|
-
/**
|
|
120
|
-
* Specifies the items to be rendered in an iframe mode, and it has the following properties.
|
|
121
|
-
* * enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
|
|
122
|
-
* * attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
|
|
123
|
-
* * resources - we can add both styles and scripts to the iframe.
|
|
124
|
-
* 1. styles[] - An array of CSS style files to inject inside the iframe to display content
|
|
125
|
-
* 2. scripts[] - An array of JS script files to inject inside the iframe
|
|
126
|
-
*
|
|
127
|
-
* {% codeBlock src='rich-text-editor/iframe-settings/index.md' %}{% endcodeBlock %}
|
|
128
|
-
*
|
|
129
|
-
* @default
|
|
130
|
-
* {
|
|
131
|
-
* enable: false,
|
|
132
|
-
* attributes: null,
|
|
133
|
-
* resources: { styles: [], scripts: [] }
|
|
134
|
-
* }
|
|
135
|
-
*/
|
|
136
|
-
iframeSettings?: IFrameSettingsModel;
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* Specifies the image insert options in Rich Text Editor component and control with the following properties.
|
|
140
|
-
* * allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and
|
|
141
|
-
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
142
|
-
* * display - Sets the default display for an image when it is inserted in to the RichTextEditor.
|
|
143
|
-
* Possible options are: 'inline' and 'block'.
|
|
144
|
-
* * width - Sets the default width of the image when it is inserted in the RichTextEditor.
|
|
145
|
-
* * saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).
|
|
146
|
-
* > If you want to insert a lot of tiny images in the editor and don't want a specific physical location for
|
|
147
|
-
* saving images, you can opt to save format as Base64.
|
|
148
|
-
* * height - Sets the default height of the image when it is inserted in the RichTextEditor.
|
|
149
|
-
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
150
|
-
* * path - Specifies the path of the location to store the images and refer it to display the images.
|
|
151
|
-
*
|
|
152
|
-
* {% codeBlock src='rich-text-editor/insert-image-settings/index.md' %}{% endcodeBlock %}
|
|
153
|
-
*
|
|
154
|
-
* @default
|
|
155
|
-
* {
|
|
156
|
-
* allowedTypes: ['.jpeg', '.jpg', '.png'],
|
|
157
|
-
* display: 'inline',
|
|
158
|
-
* width: 'auto',
|
|
159
|
-
* height: 'auto',
|
|
160
|
-
* saveFormat: 'Blob'
|
|
161
|
-
* saveUrl: null,
|
|
162
|
-
* path: null,
|
|
163
|
-
* }
|
|
164
|
-
*/
|
|
165
|
-
insertImageSettings?: ImageSettingsModel;
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
* Specifies the audio insert options in Rich Text Editor component and control with the following properties.
|
|
169
|
-
* * allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and
|
|
170
|
-
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
171
|
-
* * layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor.
|
|
172
|
-
* Possible options are: 'Inline' and 'Break'.
|
|
173
|
-
* * saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).
|
|
174
|
-
* > If you want to insert a lot of tiny audios in the editor and don't want a specific physical location for
|
|
175
|
-
* saving audios, you can opt to save format as Base64.
|
|
176
|
-
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
177
|
-
* * path - Specifies the path of the location to store the audios and refer it to display the audios.
|
|
178
|
-
*
|
|
179
|
-
* @default
|
|
180
|
-
* {
|
|
181
|
-
* allowedTypes: ['.wav', '.mp3', '.m4a','.wma'],
|
|
182
|
-
* layoutOption: 'Inline',
|
|
183
|
-
* saveFormat: 'Blob'
|
|
184
|
-
* saveUrl: null,
|
|
185
|
-
* path: null,
|
|
186
|
-
* }
|
|
187
|
-
*/
|
|
188
|
-
insertAudioSettings?: AudioSettingsModel;
|
|
189
|
-
|
|
190
|
-
/**
|
|
191
|
-
* Specifies the video insert options in Rich Text Editor component and control with the following properties.
|
|
192
|
-
* * allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and
|
|
193
|
-
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
194
|
-
* * layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor.
|
|
195
|
-
* Possible options are: 'Inline' and 'Break'.
|
|
196
|
-
* * width - Sets the default width of the video when it is inserted in the RichTextEditor.
|
|
197
|
-
* * saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).
|
|
198
|
-
* > If you want to insert a lot of tiny videos in the editor and don't want a specific physical location for
|
|
199
|
-
* saving videos, you can opt to save format as Base64.
|
|
200
|
-
* * height - Sets the default height of the video when it is inserted in the RichTextEditor.
|
|
201
|
-
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
202
|
-
* * path - Specifies the path of the location to store the videos and refer it to display the videos.
|
|
203
|
-
*
|
|
204
|
-
* @default
|
|
205
|
-
* {
|
|
206
|
-
* allowedTypes: ['.mp4', '.mov', '.wmv','.avi'],
|
|
207
|
-
* layoutOption: 'Inline',
|
|
208
|
-
* width: 'auto',
|
|
209
|
-
* height: 'auto',
|
|
210
|
-
* saveFormat: 'Blob'
|
|
211
|
-
* saveUrl: null,
|
|
212
|
-
* path: null,
|
|
213
|
-
* }
|
|
214
|
-
*/
|
|
215
|
-
insertVideoSettings?: VideoSettingsModel;
|
|
216
|
-
|
|
217
|
-
/**
|
|
218
|
-
* Specifies the table insert options in Rich Text Editor component and control with the following properties.
|
|
219
|
-
* * styles - Class name should be appended by default in table element.
|
|
220
|
-
* It helps to design the table in specific CSS styles always when inserting in editor.
|
|
221
|
-
* * width - Sets the default width of the table when it is inserted in the RichTextEditor.
|
|
222
|
-
* * minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
|
|
223
|
-
* * maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
|
|
224
|
-
* * resize - To enable resize the table.
|
|
225
|
-
*
|
|
226
|
-
* {% codeBlock src='rich-text-editor/table-settings/index.md' %}{% endcodeBlock %}
|
|
227
|
-
*
|
|
228
|
-
* @default
|
|
229
|
-
* {
|
|
230
|
-
* width: '100%',
|
|
231
|
-
* styles: [{ text: 'Dashed Borders', class: 'e-dashed-borders', command: 'Table', subCommand: 'Dashed' },
|
|
232
|
-
* { text: 'Alternate Rows', class: 'e-alternate-rows', command: 'Table', subCommand: 'Alternate' }],
|
|
233
|
-
* resize: true,
|
|
234
|
-
* minWidth: 0,
|
|
235
|
-
* maxWidth: null,
|
|
236
|
-
* }
|
|
237
|
-
*/
|
|
238
|
-
tableSettings?: TableSettingsModel;
|
|
239
|
-
|
|
240
|
-
/**
|
|
241
|
-
* Preserves the toolbar at the top of the Rich Text Editor on scrolling and
|
|
242
|
-
* specifies the offset of the floating toolbar from documents top position
|
|
243
|
-
*
|
|
244
|
-
* @default 0
|
|
245
|
-
*/
|
|
246
|
-
floatingToolbarOffset?: number;
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
* Enable or disable the inline edit mode.
|
|
250
|
-
* * enable - set boolean value to enable or disable the inline edit mode.
|
|
251
|
-
* * onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline.
|
|
252
|
-
* If its set to false, upon clicking to the target element, the toolbar is opened.
|
|
253
|
-
*
|
|
254
|
-
* {% codeBlock src='rich-text-editor/inline-mode/index.md' %}{% endcodeBlock %}
|
|
255
|
-
*
|
|
256
|
-
* @default
|
|
257
|
-
* {
|
|
258
|
-
* enable: false,
|
|
259
|
-
* onSelection: true
|
|
260
|
-
* }
|
|
261
|
-
*/
|
|
262
|
-
inlineMode?: InlineModeModel;
|
|
263
|
-
|
|
264
|
-
/**
|
|
265
|
-
* Specifies the image manager options in Rich Text Editor component and control with the following properties.
|
|
266
|
-
* * enable - set boolean value to enable or disable the image manager.
|
|
267
|
-
* * ajaxSettings - Specifies the AJAX settings of the image manager.
|
|
268
|
-
* * contextMenuSettings - Specifies the context menu settings of the image manager.
|
|
269
|
-
* * navigationPaneSettings - Specifies the navigation pane settings of the image manager.
|
|
270
|
-
* * toolbarSettings - Specifies the group of items aligned horizontally in the toolbar.
|
|
271
|
-
* * uploadSettings - Specifies the upload settings for the image manager.
|
|
272
|
-
*
|
|
273
|
-
* @default
|
|
274
|
-
* {
|
|
275
|
-
* enable: false,
|
|
276
|
-
* path: '/',
|
|
277
|
-
* ajaxSettings: { getImageUrl: null, url: null, uploadUrl: null },
|
|
278
|
-
* contextMenuSettings: {
|
|
279
|
-
* visible: true,
|
|
280
|
-
* file: ['Open', '|', 'Cut', 'Copy', '|', 'Delete', 'Rename', '|', 'Details'],
|
|
281
|
-
* folder: ['Open', '|', 'Cut', 'Copy', 'Paste', '|', 'Delete', 'Rename', '|', 'Details'],
|
|
282
|
-
* layout: ['SortBy', 'View', 'Refresh', '|', 'Paste', '|', 'NewFolder', 'Upload', '|', 'Details', '|', 'SelectAll']
|
|
283
|
-
* },
|
|
284
|
-
* navigationPaneSettings: {
|
|
285
|
-
* visible: true,
|
|
286
|
-
* items: [
|
|
287
|
-
* 'NewFolder', 'Upload', 'Cut', 'Copy', 'Paste', 'Delete', 'Download',
|
|
288
|
-
* 'Rename', 'SortBy', 'Refresh', 'Selection', 'View', 'Details'
|
|
289
|
-
* ]
|
|
290
|
-
* },
|
|
291
|
-
* toolbarSettings: { visible: true, items: ['Upload', 'NewFolder'] },
|
|
292
|
-
* uploadSettings: { autoUpload: true, minFileSize: 0, maxFileSize: 30000000, allowedExtensions: '', autoClose: false }
|
|
293
|
-
* }
|
|
294
|
-
*/
|
|
295
|
-
fileManagerSettings?: FileManagerSettingsModel;
|
|
296
|
-
|
|
297
|
-
/**
|
|
298
|
-
* Specifies the width of the RichTextEditor.
|
|
299
|
-
*
|
|
300
|
-
* @default '100%'
|
|
301
|
-
*/
|
|
302
|
-
width?: string | number;
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* Enables or disables the persisting component's state between page reloads.
|
|
306
|
-
* If enabled, the value of Rich Text Editor is persisted
|
|
307
|
-
*
|
|
308
|
-
* {% codeBlock src='rich-text-editor/enable-persistence/index.md' %}{% endcodeBlock %}
|
|
309
|
-
*
|
|
310
|
-
* @default false.
|
|
311
|
-
*/
|
|
312
|
-
enablePersistence?: boolean;
|
|
313
|
-
|
|
314
|
-
/**
|
|
315
|
-
* Specify the value whether tooltip will be displayed for the Rich Text Editor toolbar.
|
|
316
|
-
*
|
|
317
|
-
* @default true.
|
|
318
|
-
*/
|
|
319
|
-
showTooltip?: boolean;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
* Enables or disables the resizing option in the editor.
|
|
323
|
-
* If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.
|
|
324
|
-
*
|
|
325
|
-
* {% codeBlock src='rich-text-editor/enable-resize/index.md' %}{% endcodeBlock %}
|
|
326
|
-
*
|
|
327
|
-
* @default false.
|
|
328
|
-
*/
|
|
329
|
-
enableResize?: boolean;
|
|
330
|
-
|
|
331
|
-
/**
|
|
332
|
-
* Allows additional HTML attributes such as title, name, etc., and
|
|
333
|
-
* It will be accepts n number of attributes in a key-value pair format.
|
|
334
|
-
*
|
|
335
|
-
* @default {}.
|
|
336
|
-
*/
|
|
337
|
-
htmlAttributes?: { [key: string]: string };
|
|
338
|
-
|
|
339
|
-
/**
|
|
340
|
-
* Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.
|
|
341
|
-
*
|
|
342
|
-
* @default null.
|
|
343
|
-
*/
|
|
344
|
-
placeholder?: string;
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* Enables or disables the auto-save option which performs the save action while in the idle state after typed content.
|
|
348
|
-
* If enabled, the Rich Text Editor will save the content on idle state with `saveInterval` property's value.
|
|
349
|
-
* The change event will be triggered if the content has changed from the last saved state.
|
|
350
|
-
*
|
|
351
|
-
* @default false.
|
|
352
|
-
*/
|
|
353
|
-
autoSaveOnIdle?: boolean;
|
|
354
|
-
|
|
355
|
-
/**
|
|
356
|
-
* The user interactions on the component are disabled, when set to true.
|
|
357
|
-
*
|
|
358
|
-
* @default false.
|
|
359
|
-
*/
|
|
360
|
-
readonly?: boolean;
|
|
361
|
-
|
|
362
|
-
/**
|
|
363
|
-
* Specifies a value that indicates whether the component is enabled or not.
|
|
364
|
-
*
|
|
365
|
-
* {% codeBlock src='rich-text-editor/enabled/index.md' %}{% endcodeBlock %}
|
|
366
|
-
*
|
|
367
|
-
* @default true.
|
|
368
|
-
*/
|
|
369
|
-
enabled?: boolean;
|
|
370
|
-
|
|
371
|
-
/**
|
|
372
|
-
* Defines whether to allow the cross-scripting site or not.
|
|
373
|
-
*
|
|
374
|
-
* @default true
|
|
375
|
-
*/
|
|
376
|
-
enableHtmlSanitizer?: boolean;
|
|
377
|
-
|
|
378
|
-
/**
|
|
379
|
-
* specifies the value whether the source code is displayed with encoded format.
|
|
380
|
-
*
|
|
381
|
-
* @default false.
|
|
382
|
-
*/
|
|
383
|
-
enableHtmlEncode?: boolean;
|
|
384
|
-
|
|
385
|
-
/**
|
|
386
|
-
* Specifies a value that indicates whether the xhtml is enabled or not.
|
|
387
|
-
*
|
|
388
|
-
* @default false.
|
|
389
|
-
*/
|
|
390
|
-
enableXhtml?: boolean;
|
|
391
|
-
|
|
392
|
-
/**
|
|
393
|
-
* Specifies the height of the Rich Text Editor component.
|
|
394
|
-
*
|
|
395
|
-
* @default "auto"
|
|
396
|
-
*/
|
|
397
|
-
height?: string | number;
|
|
398
|
-
|
|
399
|
-
/**
|
|
400
|
-
* Specifies the CSS class name appended with the root element of the RichTextEditor.
|
|
401
|
-
* One or more custom CSS classes can be added to a RichTextEditor.
|
|
402
|
-
*
|
|
403
|
-
* @default null
|
|
404
|
-
*/
|
|
405
|
-
cssClass?: string;
|
|
406
|
-
|
|
407
|
-
/**
|
|
408
|
-
* Specifies the value displayed in the RichTextEditor's content area and it should be string.
|
|
409
|
-
* The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.
|
|
410
|
-
*
|
|
411
|
-
* {% codeBlock src='rich-text-editor/value/index.md' %}{% endcodeBlock %}
|
|
412
|
-
*
|
|
413
|
-
* @default null
|
|
414
|
-
*/
|
|
415
|
-
value?: string;
|
|
416
|
-
|
|
417
|
-
/**
|
|
418
|
-
* Specifies tag to be inserted when enter key is pressed.
|
|
419
|
-
*
|
|
420
|
-
* - `P` - When the enter key is pressed a `p` tag will be inserted and the default value of the Rich Text Editor will be <p><br></p>.
|
|
421
|
-
*
|
|
422
|
-
* - `DIV` - When the enter key is pressed a `div` tag will be inserted instead of the default `P` tag and the default value of the Rich Text Editor will be <div><br></div>.
|
|
423
|
-
*
|
|
424
|
-
* - `BR` - When the enter key is pressed a `br` tag will be inserted instead of the default `P` tag and the default value of the Rich Text Editor will be <br>.
|
|
425
|
-
*
|
|
426
|
-
* @default 'P'
|
|
427
|
-
*/
|
|
428
|
-
enterKey?: EnterKey;
|
|
429
|
-
|
|
430
|
-
/**
|
|
431
|
-
* Specifies tags to be inserted when shift+enter key is pressed.
|
|
432
|
-
*
|
|
433
|
-
* - `BR` - When the shift + enter key is pressed a `br` tag will be inserted which is the default behavior.
|
|
434
|
-
*
|
|
435
|
-
* - `P` - When the shift + enter key is pressed a `p` tag will be inserted instead of the default `br` tag.
|
|
436
|
-
*
|
|
437
|
-
* - `DIV` - When the shift + enter key is pressed a `div` tag will be inserted instead of the default `br` tag.
|
|
438
|
-
*
|
|
439
|
-
* @default 'BR'
|
|
440
|
-
*/
|
|
441
|
-
shiftEnterKey?: ShiftEnterKey;
|
|
442
|
-
|
|
443
|
-
/**
|
|
444
|
-
* Specifies the count of undo history which is stored in undoRedoManager.
|
|
445
|
-
*
|
|
446
|
-
* {% codeBlock src='rich-text-editor/undo-redo-steps/index.md' %}{% endcodeBlock %}
|
|
447
|
-
*
|
|
448
|
-
* @default 30
|
|
449
|
-
*/
|
|
450
|
-
undoRedoSteps?: number;
|
|
451
|
-
|
|
452
|
-
/**
|
|
453
|
-
* Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
|
|
454
|
-
*
|
|
455
|
-
* @default 300
|
|
456
|
-
*/
|
|
457
|
-
undoRedoTimer?: number;
|
|
458
|
-
|
|
459
|
-
/**
|
|
460
|
-
* Specifies the editing mode of the RichTextEditor.
|
|
461
|
-
*
|
|
462
|
-
* - `HTML` - Render Rich Text Editor as HTML editor using <IFRAME> element or content editable <div> element
|
|
463
|
-
* or <textarea> element.
|
|
464
|
-
*
|
|
465
|
-
* - `Markdown` - Render Rich Text Editor as markdown editor using <textarea>.
|
|
466
|
-
*
|
|
467
|
-
* @default 'HTML'
|
|
468
|
-
*/
|
|
469
|
-
editorMode?: EditorMode;
|
|
470
|
-
|
|
471
|
-
/**
|
|
472
|
-
* Customizes the key actions in RichTextEditor.
|
|
473
|
-
* For example, when using German keyboard, the key actions can be customized using these shortcuts.
|
|
474
|
-
*
|
|
475
|
-
* {% codeBlock src='rich-text-editor/keyconfig/index.md' %}{% endcodeBlock %}
|
|
476
|
-
*
|
|
477
|
-
* @default null
|
|
478
|
-
*/
|
|
479
|
-
keyConfig?: { [key: string]: string };
|
|
480
|
-
|
|
481
|
-
/**
|
|
482
|
-
* Sets Boolean value to enable or disable the display of the character counter.
|
|
483
|
-
*
|
|
484
|
-
* {% codeBlock src='rich-text-editor/show-char-count/index.md' %}{% endcodeBlock %}
|
|
485
|
-
*
|
|
486
|
-
* @default false
|
|
487
|
-
*/
|
|
488
|
-
showCharCount?: boolean;
|
|
489
|
-
|
|
490
|
-
/**
|
|
491
|
-
* Allows the tab key action in the Rich Text Editor content.
|
|
492
|
-
*
|
|
493
|
-
* {% codeBlock src='rich-text-editor/enable-tab-key/index.md' %}{% endcodeBlock %}
|
|
494
|
-
*
|
|
495
|
-
* @default false
|
|
496
|
-
*/
|
|
497
|
-
enableTabKey?: boolean;
|
|
498
|
-
|
|
499
|
-
/**
|
|
500
|
-
* Enable `enableAutoUrl` to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise
|
|
501
|
-
* the given URL will automatically convert to absolute path URL by prefixing `https://` for hyperlinks.
|
|
502
|
-
*
|
|
503
|
-
* {% codeBlock src='rich-text-editor/enable-autourl/index.md' %}{% endcodeBlock %}
|
|
504
|
-
*
|
|
505
|
-
* @default false
|
|
506
|
-
*/
|
|
507
|
-
enableAutoUrl?: boolean;
|
|
508
|
-
|
|
509
|
-
/**
|
|
510
|
-
* Specifies the maximum number of characters allowed in the Rich Text Editor component.
|
|
511
|
-
*
|
|
512
|
-
* {% codeBlock src='rich-text-editor/max-length/index.md' %}{% endcodeBlock %}
|
|
513
|
-
*
|
|
514
|
-
* @default -1
|
|
515
|
-
*/
|
|
516
|
-
maxLength?: number;
|
|
517
|
-
|
|
518
|
-
/**
|
|
519
|
-
* Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
|
|
520
|
-
*
|
|
521
|
-
* {% codeBlock src='rich-text-editor/format/index.md' %}{% endcodeBlock %}
|
|
522
|
-
*
|
|
523
|
-
* @default
|
|
524
|
-
* {
|
|
525
|
-
* default: 'Paragraph',
|
|
526
|
-
* width: '65px',
|
|
527
|
-
* types: [
|
|
528
|
-
* { text: 'Paragraph' },
|
|
529
|
-
* { text: 'Code' },
|
|
530
|
-
* { text: 'Quotation' },
|
|
531
|
-
* { text: 'Heading 1' },
|
|
532
|
-
* { text: 'Heading 2' },
|
|
533
|
-
* { text: 'Heading 3' },
|
|
534
|
-
* { text: 'Heading 4' },
|
|
535
|
-
* { text: 'Heading 5' },
|
|
536
|
-
* { text: 'Heading 6' }
|
|
537
|
-
* ]
|
|
538
|
-
* }
|
|
539
|
-
*/
|
|
540
|
-
format?: FormatModel;
|
|
541
|
-
|
|
542
|
-
/**
|
|
543
|
-
* Predefine the advanced list types that populate in the numberFormatList dropdown list from the toolbar.
|
|
544
|
-
*
|
|
545
|
-
* @default
|
|
546
|
-
* {
|
|
547
|
-
* types: [
|
|
548
|
-
* { text: 'None', value: 'none' },
|
|
549
|
-
* { text: 'Number', value: 'decimal' },
|
|
550
|
-
* { text: 'Lower Greek', value: 'lowerGreek' },
|
|
551
|
-
* { text: 'Lower Roman', value: 'lowerRoman' },
|
|
552
|
-
* { text: 'Upper Alpha', value: 'upperAlpha' },
|
|
553
|
-
* { text: 'Lower Alpha', value: 'lowerAlpha' },
|
|
554
|
-
* { text: 'Upper Roman', value: 'upperRoman' },
|
|
555
|
-
* ]
|
|
556
|
-
* }
|
|
557
|
-
*/
|
|
558
|
-
numberFormatList?: NumberFormatListModel;
|
|
559
|
-
|
|
560
|
-
/**
|
|
561
|
-
* Predefine the advanced list types that populate in the bulletFormatList dropdown list from the toolbar.
|
|
562
|
-
*
|
|
563
|
-
* @default
|
|
564
|
-
* {
|
|
565
|
-
* types: [
|
|
566
|
-
* { text: 'None', value: 'none' },
|
|
567
|
-
* { text: 'Disc', value: 'disc' },
|
|
568
|
-
* { text: 'Circle', value: 'circle' },
|
|
569
|
-
* { text: 'Square', value: 'square' }
|
|
570
|
-
* ]
|
|
571
|
-
* }
|
|
572
|
-
*/
|
|
573
|
-
bulletFormatList?: BulletFormatListModel;
|
|
574
|
-
|
|
575
|
-
/**
|
|
576
|
-
* Predefine the font families that populate in font family dropdown list from the toolbar.
|
|
577
|
-
*
|
|
578
|
-
* {% codeBlock src='rich-text-editor/font-family/index.md' %}{% endcodeBlock %}
|
|
579
|
-
*
|
|
580
|
-
* @default
|
|
581
|
-
* {
|
|
582
|
-
* default: 'Segoe UI',
|
|
583
|
-
* width: '65px',
|
|
584
|
-
* items: [
|
|
585
|
-
* { text: 'Segoe UI', value: 'Segoe UI' },
|
|
586
|
-
* { text: 'Arial', value: 'Arial,Helvetica,sans-serif' },
|
|
587
|
-
* { text: 'Courier New', value: 'Courier New,Courier,monospace' },
|
|
588
|
-
* { text: 'Georgia', value: 'Georgia,serif' },
|
|
589
|
-
* { text: 'Impact', value: 'Impact,Charcoal,sans-serif' },
|
|
590
|
-
* { text: 'Lucida Console', value: 'Lucida Console,Monaco,monospace' },
|
|
591
|
-
* { text: 'Tahoma', value: 'Tahoma,Geneva,sans-serif' },
|
|
592
|
-
* { text: 'Times New Roman', value: 'Times New Roman,Times,serif' },
|
|
593
|
-
* { text: 'Trebuchet MS', value: 'Trebuchet MS,Helvetica,sans-serif' },
|
|
594
|
-
* { text: 'Verdana', value: 'Verdana,Geneva,sans-serif' }
|
|
595
|
-
* ]
|
|
596
|
-
* }
|
|
597
|
-
*/
|
|
598
|
-
fontFamily?: FontFamilyModel;
|
|
599
|
-
|
|
600
|
-
/**
|
|
601
|
-
* Predefine the font sizes that populate in font size dropdown list from the toolbar.
|
|
602
|
-
*
|
|
603
|
-
* {% codeBlock src='rich-text-editor/font-size/index.md' %}{% endcodeBlock %}
|
|
604
|
-
*
|
|
605
|
-
* @default
|
|
606
|
-
* {
|
|
607
|
-
* default: '10',
|
|
608
|
-
* width: '35px',
|
|
609
|
-
* items: [
|
|
610
|
-
* { text: '8', value: '8pt' },
|
|
611
|
-
* { text: '10', value: '10pt' },
|
|
612
|
-
* { text: '12', value: '12pt' },
|
|
613
|
-
* { text: '14', value: '14pt' },
|
|
614
|
-
* { text: '18', value: '18pt' },
|
|
615
|
-
* { text: '24', value: '24pt' },
|
|
616
|
-
* { text: '36', value: '36pt' }
|
|
617
|
-
* ]
|
|
618
|
-
* }
|
|
619
|
-
*/
|
|
620
|
-
fontSize?: FontSizeModel;
|
|
621
|
-
|
|
622
|
-
/**
|
|
623
|
-
* Predefine the color palette that can be rendered for font color toolbar command .
|
|
624
|
-
*
|
|
625
|
-
* {% codeBlock src='rich-text-editor/font-color/index.md' %}{% endcodeBlock %}
|
|
626
|
-
*
|
|
627
|
-
* @default
|
|
628
|
-
* {
|
|
629
|
-
* columns: 10,
|
|
630
|
-
* colorCode: {
|
|
631
|
-
* 'Custom': [
|
|
632
|
-
* '', '#000000', '#e7e6e6', '#44546a', '#4472c4', '#ed7d31', '#a5a5a5', '#ffc000', '#70ad47', '#ff0000',
|
|
633
|
-
* '#f2f2f2', '#808080', '#cfcdcd', '#d5dce4', '#d9e2f3', '#fbe4d5', '#ededed', '#fff2cc', '#e2efd9', '#ffcccc',
|
|
634
|
-
* '#d9d9d9', '#595959', '#aeaaaa', '#acb9ca', '#b4c6e7', '#f7caac', '#dbdbdb', '#ffe599', '#c5e0b3', '#ff8080',
|
|
635
|
-
* '#bfbfbf', '#404040', '#747070', '#8496b0', '#8eaadb', '#f4b083', '#c9c9c9', '#ffd966', '#a8d08d', '#ff3333',
|
|
636
|
-
* '#a6a6a6', '#262626', '#3b3838', '#323e4f', '#2f5496', '#c45911', '#7b7b7b', '#bf8f00', '#538135', '#b30000',
|
|
637
|
-
* '#7f7f7f', '#0d0d0d', '#161616', '#212934', '#1f3763', '#823b0b', '#525252', '#7f5f00', '#375623', '#660000']
|
|
638
|
-
* }
|
|
639
|
-
* }
|
|
640
|
-
*/
|
|
641
|
-
fontColor?: FontColorModel;
|
|
642
|
-
|
|
643
|
-
/**
|
|
644
|
-
* Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
|
|
645
|
-
*
|
|
646
|
-
* {% codeBlock src='rich-text-editor/background-color/index.md' %}{% endcodeBlock %}
|
|
647
|
-
*
|
|
648
|
-
* @default
|
|
649
|
-
* {
|
|
650
|
-
* columns: 5,
|
|
651
|
-
* colorCode: {
|
|
652
|
-
* 'Custom': ['#ffff00', '#00ff00', '#00ffff', '#ff00ff', '#0000ff', '#ff0000',
|
|
653
|
-
* '#000080', '#008080', '#008000', '#800080', '#800000', '#808000',
|
|
654
|
-
* '#c0c0c0', '#000000', '']
|
|
655
|
-
* }
|
|
656
|
-
* }
|
|
657
|
-
*/
|
|
658
|
-
backgroundColor?: BackgroundColorModel;
|
|
659
|
-
|
|
660
|
-
/**
|
|
661
|
-
* Accepts the template design and assigns it as RichTextEditor’s content.
|
|
662
|
-
* The built-in template engine which provides options to compile template string into a executable function.
|
|
663
|
-
* For EX: We have expression evolution as like ES6 expression string literals
|
|
664
|
-
*
|
|
665
|
-
* {% codeBlock src='rich-text-editor/value-template/index.md' %}{% endcodeBlock %}
|
|
666
|
-
*
|
|
667
|
-
* @default null
|
|
668
|
-
* @aspType string
|
|
669
|
-
*/
|
|
670
|
-
valueTemplate?: string | Function;
|
|
671
|
-
|
|
672
|
-
/**
|
|
673
|
-
* Specifies the saveInterval in milliseconds for autosave the value.
|
|
674
|
-
* The change event will be triggered if the content was changed from the last saved interval.
|
|
675
|
-
*
|
|
676
|
-
* {% codeBlock src='rich-text-editor/save-interval/index.md' %}{% endcodeBlock %}
|
|
677
|
-
*
|
|
678
|
-
* @default 10000
|
|
679
|
-
*/
|
|
680
|
-
saveInterval?: number;
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* Triggers before command execution using toolbar items or executeCommand method.
|
|
684
|
-
* If you cancel this event, the command cannot be executed.
|
|
685
|
-
* Set the cancel argument to true to cancel the command execution.
|
|
686
|
-
*
|
|
687
|
-
* @event 'actionBegin'
|
|
688
|
-
*/
|
|
689
|
-
actionBegin?: EmitType<ActionBeginEventArgs>;
|
|
690
|
-
|
|
691
|
-
/**
|
|
692
|
-
* Triggers after command execution using toolbar items or executeCommand method.
|
|
693
|
-
*
|
|
694
|
-
* @event 'actionComplete'
|
|
695
|
-
*/
|
|
696
|
-
actionComplete?: EmitType<ActionCompleteEventArgs>;
|
|
697
|
-
|
|
698
|
-
/**
|
|
699
|
-
* Event triggers when the dialog is being opened.
|
|
700
|
-
* If you cancel this event, the dialog remains closed.
|
|
701
|
-
* Set the cancel argument to true to cancel the open of a dialog.
|
|
702
|
-
*
|
|
703
|
-
* @event 'beforeDialogOpen'
|
|
704
|
-
*/
|
|
705
|
-
|
|
706
|
-
beforeDialogOpen?: EmitType<BeforeOpenEventArgs>;
|
|
707
|
-
|
|
708
|
-
/**
|
|
709
|
-
* Event triggers when a dialog is opened.
|
|
710
|
-
*
|
|
711
|
-
* @event 'dialogOpen'
|
|
712
|
-
*/
|
|
713
|
-
dialogOpen?: EmitType<Object>;
|
|
714
|
-
|
|
715
|
-
/**
|
|
716
|
-
* Event triggers when the dialog is being closed.
|
|
717
|
-
* If you cancel this event, the dialog remains opened.
|
|
718
|
-
* Set the cancel argument to true to prevent closing a dialog.
|
|
719
|
-
*
|
|
720
|
-
* @event 'beforeDialogClose'
|
|
721
|
-
*/
|
|
722
|
-
beforeDialogClose?: EmitType<BeforeCloseEventArgs>;
|
|
723
|
-
|
|
724
|
-
/**
|
|
725
|
-
* Event triggers after the dialog has been closed.
|
|
726
|
-
*
|
|
727
|
-
* @event 'dialogClose'
|
|
728
|
-
*/
|
|
729
|
-
dialogClose?: 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
|
+
* audio: ['AudioReplace', 'AudioRemove', 'AudioLayoutOption'],
|
|
60
|
+
* video: ['VideoReplace', 'VideoAlign', 'VideoRemove', 'VideoLayoutOption', 'VideoDimension'],
|
|
61
|
+
* }
|
|
62
|
+
*/
|
|
63
|
+
quickToolbarSettings?: QuickToolbarSettingsModel;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Specifies the pasting options in Rich Text Editor component and control with the following properties.
|
|
67
|
+
* * prompt - Set boolean value to enable or disable the prompt when pasting.
|
|
68
|
+
* * deniedAttrs - Specifies the attributes to restrict when pasting in RTE.
|
|
69
|
+
* * allowedStyleProps - Specifies the allowed style properties when pasting in RTE.
|
|
70
|
+
* * deniedTags - Specifies the tags to restrict when pasting in RTE.
|
|
71
|
+
* * keepFormat - Set boolean value to keep or remove the from when pasting.
|
|
72
|
+
* * plainText - Set boolean value to paste as plain text or not.
|
|
73
|
+
*
|
|
74
|
+
* {% codeBlock src='rich-text-editor/paste-cleanup-settings/index.md' %}{% endcodeBlock %}
|
|
75
|
+
*
|
|
76
|
+
* @default
|
|
77
|
+
* {
|
|
78
|
+
* prompt: false,
|
|
79
|
+
* deniedAttrs: null,
|
|
80
|
+
* allowedStyleProps: ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius',
|
|
81
|
+
* 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor',
|
|
82
|
+
* 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style',
|
|
83
|
+
* 'height', 'left', 'line-height', 'list-style-type', 'margin', 'margin-top', 'margin-left',
|
|
84
|
+
* 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width',
|
|
85
|
+
* 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right',
|
|
86
|
+
* 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent',
|
|
87
|
+
* 'top', 'vertical-align', 'visibility', 'white-space', 'width'],
|
|
88
|
+
* deniedTags: null,
|
|
89
|
+
* keepFormat: true,
|
|
90
|
+
* plainText: false
|
|
91
|
+
* }
|
|
92
|
+
*/
|
|
93
|
+
pasteCleanupSettings?: PasteCleanupSettingsModel;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Specifies the format painter options in Rich Text Editor with the following properties.
|
|
97
|
+
* * allowedFormats - Sets the tag name selectors for elements from which the formats can be copied.
|
|
98
|
+
* * deniedFormats - Sets the selectors for elements from which formats cannot be copied.
|
|
99
|
+
*
|
|
100
|
+
* {% codeBlock src='rich-text-editor/format-painter-settings/index.md' %}{% endcodeBlock %}
|
|
101
|
+
*
|
|
102
|
+
* @default
|
|
103
|
+
* {
|
|
104
|
+
* allowedFormats: 'b; em; font; sub; sup; kbd; i; s; u; code; strong; span; p; div; h1; h2; h3; h4; h5; h6; blockquote; ol; ul; li; pre;',
|
|
105
|
+
* deniedFormats: null
|
|
106
|
+
* }
|
|
107
|
+
*/
|
|
108
|
+
formatPainterSettings?: FormatPainterSettingsModel
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Specifies the emoji picker options in Rich Text Editor with the following properties.
|
|
112
|
+
* * iconsSet – Specify an array of items representing emoji icons.
|
|
113
|
+
* * showSearchBox - Enables or disables the search box in an emoji picker.
|
|
114
|
+
*
|
|
115
|
+
*
|
|
116
|
+
*/
|
|
117
|
+
emojiPickerSettings?: EmojiSettingsModel
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Specifies the items to be rendered in an iframe mode, and it has the following properties.
|
|
121
|
+
* * enable - Set Boolean value to enable, the editors content is placed in an iframe and isolated from the rest of the page.
|
|
122
|
+
* * attributes - Custom style to be used inside the iframe to display content. This style is added to the iframe body.
|
|
123
|
+
* * resources - we can add both styles and scripts to the iframe.
|
|
124
|
+
* 1. styles[] - An array of CSS style files to inject inside the iframe to display content
|
|
125
|
+
* 2. scripts[] - An array of JS script files to inject inside the iframe
|
|
126
|
+
*
|
|
127
|
+
* {% codeBlock src='rich-text-editor/iframe-settings/index.md' %}{% endcodeBlock %}
|
|
128
|
+
*
|
|
129
|
+
* @default
|
|
130
|
+
* {
|
|
131
|
+
* enable: false,
|
|
132
|
+
* attributes: null,
|
|
133
|
+
* resources: { styles: [], scripts: [] }
|
|
134
|
+
* }
|
|
135
|
+
*/
|
|
136
|
+
iframeSettings?: IFrameSettingsModel;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Specifies the image insert options in Rich Text Editor component and control with the following properties.
|
|
140
|
+
* * allowedTypes - Specifies the extensions of the image types allowed to insert on bowering and
|
|
141
|
+
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
142
|
+
* * display - Sets the default display for an image when it is inserted in to the RichTextEditor.
|
|
143
|
+
* Possible options are: 'inline' and 'block'.
|
|
144
|
+
* * width - Sets the default width of the image when it is inserted in the RichTextEditor.
|
|
145
|
+
* * saveFormat - Specifies the format to store the image in the Rich Text Editor (Base64 or Blob).
|
|
146
|
+
* > If you want to insert a lot of tiny images in the editor and don't want a specific physical location for
|
|
147
|
+
* saving images, you can opt to save format as Base64.
|
|
148
|
+
* * height - Sets the default height of the image when it is inserted in the RichTextEditor.
|
|
149
|
+
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
150
|
+
* * path - Specifies the path of the location to store the images and refer it to display the images.
|
|
151
|
+
*
|
|
152
|
+
* {% codeBlock src='rich-text-editor/insert-image-settings/index.md' %}{% endcodeBlock %}
|
|
153
|
+
*
|
|
154
|
+
* @default
|
|
155
|
+
* {
|
|
156
|
+
* allowedTypes: ['.jpeg', '.jpg', '.png'],
|
|
157
|
+
* display: 'inline',
|
|
158
|
+
* width: 'auto',
|
|
159
|
+
* height: 'auto',
|
|
160
|
+
* saveFormat: 'Blob'
|
|
161
|
+
* saveUrl: null,
|
|
162
|
+
* path: null,
|
|
163
|
+
* }
|
|
164
|
+
*/
|
|
165
|
+
insertImageSettings?: ImageSettingsModel;
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Specifies the audio insert options in Rich Text Editor component and control with the following properties.
|
|
169
|
+
* * allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and
|
|
170
|
+
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
171
|
+
* * layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor.
|
|
172
|
+
* Possible options are: 'Inline' and 'Break'.
|
|
173
|
+
* * saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).
|
|
174
|
+
* > If you want to insert a lot of tiny audios in the editor and don't want a specific physical location for
|
|
175
|
+
* saving audios, you can opt to save format as Base64.
|
|
176
|
+
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
177
|
+
* * path - Specifies the path of the location to store the audios and refer it to display the audios.
|
|
178
|
+
*
|
|
179
|
+
* @default
|
|
180
|
+
* {
|
|
181
|
+
* allowedTypes: ['.wav', '.mp3', '.m4a','.wma'],
|
|
182
|
+
* layoutOption: 'Inline',
|
|
183
|
+
* saveFormat: 'Blob'
|
|
184
|
+
* saveUrl: null,
|
|
185
|
+
* path: null,
|
|
186
|
+
* }
|
|
187
|
+
*/
|
|
188
|
+
insertAudioSettings?: AudioSettingsModel;
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* Specifies the video insert options in Rich Text Editor component and control with the following properties.
|
|
192
|
+
* * allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and
|
|
193
|
+
* passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
|
|
194
|
+
* * layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor.
|
|
195
|
+
* Possible options are: 'Inline' and 'Break'.
|
|
196
|
+
* * width - Sets the default width of the video when it is inserted in the RichTextEditor.
|
|
197
|
+
* * saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).
|
|
198
|
+
* > If you want to insert a lot of tiny videos in the editor and don't want a specific physical location for
|
|
199
|
+
* saving videos, you can opt to save format as Base64.
|
|
200
|
+
* * height - Sets the default height of the video when it is inserted in the RichTextEditor.
|
|
201
|
+
* * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
|
|
202
|
+
* * path - Specifies the path of the location to store the videos and refer it to display the videos.
|
|
203
|
+
*
|
|
204
|
+
* @default
|
|
205
|
+
* {
|
|
206
|
+
* allowedTypes: ['.mp4', '.mov', '.wmv','.avi'],
|
|
207
|
+
* layoutOption: 'Inline',
|
|
208
|
+
* width: 'auto',
|
|
209
|
+
* height: 'auto',
|
|
210
|
+
* saveFormat: 'Blob'
|
|
211
|
+
* saveUrl: null,
|
|
212
|
+
* path: null,
|
|
213
|
+
* }
|
|
214
|
+
*/
|
|
215
|
+
insertVideoSettings?: VideoSettingsModel;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Specifies the table insert options in Rich Text Editor component and control with the following properties.
|
|
219
|
+
* * styles - Class name should be appended by default in table element.
|
|
220
|
+
* It helps to design the table in specific CSS styles always when inserting in editor.
|
|
221
|
+
* * width - Sets the default width of the table when it is inserted in the RichTextEditor.
|
|
222
|
+
* * minWidth - Sets the default minWidth of the table when it is inserted in the RichTextEditor.
|
|
223
|
+
* * maxWidth - Sets the default maxWidth of the table when it is inserted in the RichTextEditor.
|
|
224
|
+
* * resize - To enable resize the table.
|
|
225
|
+
*
|
|
226
|
+
* {% codeBlock src='rich-text-editor/table-settings/index.md' %}{% endcodeBlock %}
|
|
227
|
+
*
|
|
228
|
+
* @default
|
|
229
|
+
* {
|
|
230
|
+
* width: '100%',
|
|
231
|
+
* styles: [{ text: 'Dashed Borders', class: 'e-dashed-borders', command: 'Table', subCommand: 'Dashed' },
|
|
232
|
+
* { text: 'Alternate Rows', class: 'e-alternate-rows', command: 'Table', subCommand: 'Alternate' }],
|
|
233
|
+
* resize: true,
|
|
234
|
+
* minWidth: 0,
|
|
235
|
+
* maxWidth: null,
|
|
236
|
+
* }
|
|
237
|
+
*/
|
|
238
|
+
tableSettings?: TableSettingsModel;
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Preserves the toolbar at the top of the Rich Text Editor on scrolling and
|
|
242
|
+
* specifies the offset of the floating toolbar from documents top position
|
|
243
|
+
*
|
|
244
|
+
* @default 0
|
|
245
|
+
*/
|
|
246
|
+
floatingToolbarOffset?: number;
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Enable or disable the inline edit mode.
|
|
250
|
+
* * enable - set boolean value to enable or disable the inline edit mode.
|
|
251
|
+
* * onSelection - If its set to true, upon selecting the text, the toolbar is opened in inline.
|
|
252
|
+
* If its set to false, upon clicking to the target element, the toolbar is opened.
|
|
253
|
+
*
|
|
254
|
+
* {% codeBlock src='rich-text-editor/inline-mode/index.md' %}{% endcodeBlock %}
|
|
255
|
+
*
|
|
256
|
+
* @default
|
|
257
|
+
* {
|
|
258
|
+
* enable: false,
|
|
259
|
+
* onSelection: true
|
|
260
|
+
* }
|
|
261
|
+
*/
|
|
262
|
+
inlineMode?: InlineModeModel;
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Specifies the image manager options in Rich Text Editor component and control with the following properties.
|
|
266
|
+
* * enable - set boolean value to enable or disable the image manager.
|
|
267
|
+
* * ajaxSettings - Specifies the AJAX settings of the image manager.
|
|
268
|
+
* * contextMenuSettings - Specifies the context menu settings of the image manager.
|
|
269
|
+
* * navigationPaneSettings - Specifies the navigation pane settings of the image manager.
|
|
270
|
+
* * toolbarSettings - Specifies the group of items aligned horizontally in the toolbar.
|
|
271
|
+
* * uploadSettings - Specifies the upload settings for the image manager.
|
|
272
|
+
*
|
|
273
|
+
* @default
|
|
274
|
+
* {
|
|
275
|
+
* enable: false,
|
|
276
|
+
* path: '/',
|
|
277
|
+
* ajaxSettings: { getImageUrl: null, url: null, uploadUrl: null },
|
|
278
|
+
* contextMenuSettings: {
|
|
279
|
+
* visible: true,
|
|
280
|
+
* file: ['Open', '|', 'Cut', 'Copy', '|', 'Delete', 'Rename', '|', 'Details'],
|
|
281
|
+
* folder: ['Open', '|', 'Cut', 'Copy', 'Paste', '|', 'Delete', 'Rename', '|', 'Details'],
|
|
282
|
+
* layout: ['SortBy', 'View', 'Refresh', '|', 'Paste', '|', 'NewFolder', 'Upload', '|', 'Details', '|', 'SelectAll']
|
|
283
|
+
* },
|
|
284
|
+
* navigationPaneSettings: {
|
|
285
|
+
* visible: true,
|
|
286
|
+
* items: [
|
|
287
|
+
* 'NewFolder', 'Upload', 'Cut', 'Copy', 'Paste', 'Delete', 'Download',
|
|
288
|
+
* 'Rename', 'SortBy', 'Refresh', 'Selection', 'View', 'Details'
|
|
289
|
+
* ]
|
|
290
|
+
* },
|
|
291
|
+
* toolbarSettings: { visible: true, items: ['Upload', 'NewFolder'] },
|
|
292
|
+
* uploadSettings: { autoUpload: true, minFileSize: 0, maxFileSize: 30000000, allowedExtensions: '', autoClose: false }
|
|
293
|
+
* }
|
|
294
|
+
*/
|
|
295
|
+
fileManagerSettings?: FileManagerSettingsModel;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Specifies the width of the RichTextEditor.
|
|
299
|
+
*
|
|
300
|
+
* @default '100%'
|
|
301
|
+
*/
|
|
302
|
+
width?: string | number;
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* Enables or disables the persisting component's state between page reloads.
|
|
306
|
+
* If enabled, the value of Rich Text Editor is persisted
|
|
307
|
+
*
|
|
308
|
+
* {% codeBlock src='rich-text-editor/enable-persistence/index.md' %}{% endcodeBlock %}
|
|
309
|
+
*
|
|
310
|
+
* @default false.
|
|
311
|
+
*/
|
|
312
|
+
enablePersistence?: boolean;
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Specify the value whether tooltip will be displayed for the Rich Text Editor toolbar.
|
|
316
|
+
*
|
|
317
|
+
* @default true.
|
|
318
|
+
*/
|
|
319
|
+
showTooltip?: boolean;
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* Enables or disables the resizing option in the editor.
|
|
323
|
+
* If enabled, the Rich Text Editor can be resized by dragging the resize icon in the bottom right corner.
|
|
324
|
+
*
|
|
325
|
+
* {% codeBlock src='rich-text-editor/enable-resize/index.md' %}{% endcodeBlock %}
|
|
326
|
+
*
|
|
327
|
+
* @default false.
|
|
328
|
+
*/
|
|
329
|
+
enableResize?: boolean;
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* Allows additional HTML attributes such as title, name, etc., and
|
|
333
|
+
* It will be accepts n number of attributes in a key-value pair format.
|
|
334
|
+
*
|
|
335
|
+
* @default {}.
|
|
336
|
+
*/
|
|
337
|
+
htmlAttributes?: { [key: string]: string };
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Specifies the placeholder for the RichTextEditor’s content used when the Rich Text Editor body is empty.
|
|
341
|
+
*
|
|
342
|
+
* @default null.
|
|
343
|
+
*/
|
|
344
|
+
placeholder?: string;
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* Enables or disables the auto-save option which performs the save action while in the idle state after typed content.
|
|
348
|
+
* If enabled, the Rich Text Editor will save the content on idle state with `saveInterval` property's value.
|
|
349
|
+
* The change event will be triggered if the content has changed from the last saved state.
|
|
350
|
+
*
|
|
351
|
+
* @default false.
|
|
352
|
+
*/
|
|
353
|
+
autoSaveOnIdle?: boolean;
|
|
354
|
+
|
|
355
|
+
/**
|
|
356
|
+
* The user interactions on the component are disabled, when set to true.
|
|
357
|
+
*
|
|
358
|
+
* @default false.
|
|
359
|
+
*/
|
|
360
|
+
readonly?: boolean;
|
|
361
|
+
|
|
362
|
+
/**
|
|
363
|
+
* Specifies a value that indicates whether the component is enabled or not.
|
|
364
|
+
*
|
|
365
|
+
* {% codeBlock src='rich-text-editor/enabled/index.md' %}{% endcodeBlock %}
|
|
366
|
+
*
|
|
367
|
+
* @default true.
|
|
368
|
+
*/
|
|
369
|
+
enabled?: boolean;
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* Defines whether to allow the cross-scripting site or not.
|
|
373
|
+
*
|
|
374
|
+
* @default true
|
|
375
|
+
*/
|
|
376
|
+
enableHtmlSanitizer?: boolean;
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* specifies the value whether the source code is displayed with encoded format.
|
|
380
|
+
*
|
|
381
|
+
* @default false.
|
|
382
|
+
*/
|
|
383
|
+
enableHtmlEncode?: boolean;
|
|
384
|
+
|
|
385
|
+
/**
|
|
386
|
+
* Specifies a value that indicates whether the xhtml is enabled or not.
|
|
387
|
+
*
|
|
388
|
+
* @default false.
|
|
389
|
+
*/
|
|
390
|
+
enableXhtml?: boolean;
|
|
391
|
+
|
|
392
|
+
/**
|
|
393
|
+
* Specifies the height of the Rich Text Editor component.
|
|
394
|
+
*
|
|
395
|
+
* @default "auto"
|
|
396
|
+
*/
|
|
397
|
+
height?: string | number;
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* Specifies the CSS class name appended with the root element of the RichTextEditor.
|
|
401
|
+
* One or more custom CSS classes can be added to a RichTextEditor.
|
|
402
|
+
*
|
|
403
|
+
* @default null
|
|
404
|
+
*/
|
|
405
|
+
cssClass?: string;
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* Specifies the value displayed in the RichTextEditor's content area and it should be string.
|
|
409
|
+
* The content of Rich Text Editor can be loaded with dynamic data such as database, AJAX content, and more.
|
|
410
|
+
*
|
|
411
|
+
* {% codeBlock src='rich-text-editor/value/index.md' %}{% endcodeBlock %}
|
|
412
|
+
*
|
|
413
|
+
* @default null
|
|
414
|
+
*/
|
|
415
|
+
value?: string;
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* Specifies tag to be inserted when enter key is pressed.
|
|
419
|
+
*
|
|
420
|
+
* - `P` - When the enter key is pressed a `p` tag will be inserted and the default value of the Rich Text Editor will be <p><br></p>.
|
|
421
|
+
*
|
|
422
|
+
* - `DIV` - When the enter key is pressed a `div` tag will be inserted instead of the default `P` tag and the default value of the Rich Text Editor will be <div><br></div>.
|
|
423
|
+
*
|
|
424
|
+
* - `BR` - When the enter key is pressed a `br` tag will be inserted instead of the default `P` tag and the default value of the Rich Text Editor will be <br>.
|
|
425
|
+
*
|
|
426
|
+
* @default 'P'
|
|
427
|
+
*/
|
|
428
|
+
enterKey?: EnterKey;
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Specifies tags to be inserted when shift+enter key is pressed.
|
|
432
|
+
*
|
|
433
|
+
* - `BR` - When the shift + enter key is pressed a `br` tag will be inserted which is the default behavior.
|
|
434
|
+
*
|
|
435
|
+
* - `P` - When the shift + enter key is pressed a `p` tag will be inserted instead of the default `br` tag.
|
|
436
|
+
*
|
|
437
|
+
* - `DIV` - When the shift + enter key is pressed a `div` tag will be inserted instead of the default `br` tag.
|
|
438
|
+
*
|
|
439
|
+
* @default 'BR'
|
|
440
|
+
*/
|
|
441
|
+
shiftEnterKey?: ShiftEnterKey;
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
* Specifies the count of undo history which is stored in undoRedoManager.
|
|
445
|
+
*
|
|
446
|
+
* {% codeBlock src='rich-text-editor/undo-redo-steps/index.md' %}{% endcodeBlock %}
|
|
447
|
+
*
|
|
448
|
+
* @default 30
|
|
449
|
+
*/
|
|
450
|
+
undoRedoSteps?: number;
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Specifies the interval value in milliseconds that store actions in undoRedoManager. The minimum value is 300 milliseconds.
|
|
454
|
+
*
|
|
455
|
+
* @default 300
|
|
456
|
+
*/
|
|
457
|
+
undoRedoTimer?: number;
|
|
458
|
+
|
|
459
|
+
/**
|
|
460
|
+
* Specifies the editing mode of the RichTextEditor.
|
|
461
|
+
*
|
|
462
|
+
* - `HTML` - Render Rich Text Editor as HTML editor using <IFRAME> element or content editable <div> element
|
|
463
|
+
* or <textarea> element.
|
|
464
|
+
*
|
|
465
|
+
* - `Markdown` - Render Rich Text Editor as markdown editor using <textarea>.
|
|
466
|
+
*
|
|
467
|
+
* @default 'HTML'
|
|
468
|
+
*/
|
|
469
|
+
editorMode?: EditorMode;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Customizes the key actions in RichTextEditor.
|
|
473
|
+
* For example, when using German keyboard, the key actions can be customized using these shortcuts.
|
|
474
|
+
*
|
|
475
|
+
* {% codeBlock src='rich-text-editor/keyconfig/index.md' %}{% endcodeBlock %}
|
|
476
|
+
*
|
|
477
|
+
* @default null
|
|
478
|
+
*/
|
|
479
|
+
keyConfig?: { [key: string]: string };
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Sets Boolean value to enable or disable the display of the character counter.
|
|
483
|
+
*
|
|
484
|
+
* {% codeBlock src='rich-text-editor/show-char-count/index.md' %}{% endcodeBlock %}
|
|
485
|
+
*
|
|
486
|
+
* @default false
|
|
487
|
+
*/
|
|
488
|
+
showCharCount?: boolean;
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Allows the tab key action in the Rich Text Editor content.
|
|
492
|
+
*
|
|
493
|
+
* {% codeBlock src='rich-text-editor/enable-tab-key/index.md' %}{% endcodeBlock %}
|
|
494
|
+
*
|
|
495
|
+
* @default false
|
|
496
|
+
*/
|
|
497
|
+
enableTabKey?: boolean;
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Enable `enableAutoUrl` to accept the given URL (relative or absolute) without validating the URL for hyperlinks, otherwise
|
|
501
|
+
* the given URL will automatically convert to absolute path URL by prefixing `https://` for hyperlinks.
|
|
502
|
+
*
|
|
503
|
+
* {% codeBlock src='rich-text-editor/enable-autourl/index.md' %}{% endcodeBlock %}
|
|
504
|
+
*
|
|
505
|
+
* @default false
|
|
506
|
+
*/
|
|
507
|
+
enableAutoUrl?: boolean;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* Specifies the maximum number of characters allowed in the Rich Text Editor component.
|
|
511
|
+
*
|
|
512
|
+
* {% codeBlock src='rich-text-editor/max-length/index.md' %}{% endcodeBlock %}
|
|
513
|
+
*
|
|
514
|
+
* @default -1
|
|
515
|
+
*/
|
|
516
|
+
maxLength?: number;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* Predefine the collection of paragraph styles along with quote and code style that populate in format dropdown from the toolbar.
|
|
520
|
+
*
|
|
521
|
+
* {% codeBlock src='rich-text-editor/format/index.md' %}{% endcodeBlock %}
|
|
522
|
+
*
|
|
523
|
+
* @default
|
|
524
|
+
* {
|
|
525
|
+
* default: 'Paragraph',
|
|
526
|
+
* width: '65px',
|
|
527
|
+
* types: [
|
|
528
|
+
* { text: 'Paragraph' },
|
|
529
|
+
* { text: 'Code' },
|
|
530
|
+
* { text: 'Quotation' },
|
|
531
|
+
* { text: 'Heading 1' },
|
|
532
|
+
* { text: 'Heading 2' },
|
|
533
|
+
* { text: 'Heading 3' },
|
|
534
|
+
* { text: 'Heading 4' },
|
|
535
|
+
* { text: 'Heading 5' },
|
|
536
|
+
* { text: 'Heading 6' }
|
|
537
|
+
* ]
|
|
538
|
+
* }
|
|
539
|
+
*/
|
|
540
|
+
format?: FormatModel;
|
|
541
|
+
|
|
542
|
+
/**
|
|
543
|
+
* Predefine the advanced list types that populate in the numberFormatList dropdown list from the toolbar.
|
|
544
|
+
*
|
|
545
|
+
* @default
|
|
546
|
+
* {
|
|
547
|
+
* types: [
|
|
548
|
+
* { text: 'None', value: 'none' },
|
|
549
|
+
* { text: 'Number', value: 'decimal' },
|
|
550
|
+
* { text: 'Lower Greek', value: 'lowerGreek' },
|
|
551
|
+
* { text: 'Lower Roman', value: 'lowerRoman' },
|
|
552
|
+
* { text: 'Upper Alpha', value: 'upperAlpha' },
|
|
553
|
+
* { text: 'Lower Alpha', value: 'lowerAlpha' },
|
|
554
|
+
* { text: 'Upper Roman', value: 'upperRoman' },
|
|
555
|
+
* ]
|
|
556
|
+
* }
|
|
557
|
+
*/
|
|
558
|
+
numberFormatList?: NumberFormatListModel;
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Predefine the advanced list types that populate in the bulletFormatList dropdown list from the toolbar.
|
|
562
|
+
*
|
|
563
|
+
* @default
|
|
564
|
+
* {
|
|
565
|
+
* types: [
|
|
566
|
+
* { text: 'None', value: 'none' },
|
|
567
|
+
* { text: 'Disc', value: 'disc' },
|
|
568
|
+
* { text: 'Circle', value: 'circle' },
|
|
569
|
+
* { text: 'Square', value: 'square' }
|
|
570
|
+
* ]
|
|
571
|
+
* }
|
|
572
|
+
*/
|
|
573
|
+
bulletFormatList?: BulletFormatListModel;
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* Predefine the font families that populate in font family dropdown list from the toolbar.
|
|
577
|
+
*
|
|
578
|
+
* {% codeBlock src='rich-text-editor/font-family/index.md' %}{% endcodeBlock %}
|
|
579
|
+
*
|
|
580
|
+
* @default
|
|
581
|
+
* {
|
|
582
|
+
* default: 'Segoe UI',
|
|
583
|
+
* width: '65px',
|
|
584
|
+
* items: [
|
|
585
|
+
* { text: 'Segoe UI', value: 'Segoe UI' },
|
|
586
|
+
* { text: 'Arial', value: 'Arial,Helvetica,sans-serif' },
|
|
587
|
+
* { text: 'Courier New', value: 'Courier New,Courier,monospace' },
|
|
588
|
+
* { text: 'Georgia', value: 'Georgia,serif' },
|
|
589
|
+
* { text: 'Impact', value: 'Impact,Charcoal,sans-serif' },
|
|
590
|
+
* { text: 'Lucida Console', value: 'Lucida Console,Monaco,monospace' },
|
|
591
|
+
* { text: 'Tahoma', value: 'Tahoma,Geneva,sans-serif' },
|
|
592
|
+
* { text: 'Times New Roman', value: 'Times New Roman,Times,serif' },
|
|
593
|
+
* { text: 'Trebuchet MS', value: 'Trebuchet MS,Helvetica,sans-serif' },
|
|
594
|
+
* { text: 'Verdana', value: 'Verdana,Geneva,sans-serif' }
|
|
595
|
+
* ]
|
|
596
|
+
* }
|
|
597
|
+
*/
|
|
598
|
+
fontFamily?: FontFamilyModel;
|
|
599
|
+
|
|
600
|
+
/**
|
|
601
|
+
* Predefine the font sizes that populate in font size dropdown list from the toolbar.
|
|
602
|
+
*
|
|
603
|
+
* {% codeBlock src='rich-text-editor/font-size/index.md' %}{% endcodeBlock %}
|
|
604
|
+
*
|
|
605
|
+
* @default
|
|
606
|
+
* {
|
|
607
|
+
* default: '10',
|
|
608
|
+
* width: '35px',
|
|
609
|
+
* items: [
|
|
610
|
+
* { text: '8', value: '8pt' },
|
|
611
|
+
* { text: '10', value: '10pt' },
|
|
612
|
+
* { text: '12', value: '12pt' },
|
|
613
|
+
* { text: '14', value: '14pt' },
|
|
614
|
+
* { text: '18', value: '18pt' },
|
|
615
|
+
* { text: '24', value: '24pt' },
|
|
616
|
+
* { text: '36', value: '36pt' }
|
|
617
|
+
* ]
|
|
618
|
+
* }
|
|
619
|
+
*/
|
|
620
|
+
fontSize?: FontSizeModel;
|
|
621
|
+
|
|
622
|
+
/**
|
|
623
|
+
* Predefine the color palette that can be rendered for font color toolbar command .
|
|
624
|
+
*
|
|
625
|
+
* {% codeBlock src='rich-text-editor/font-color/index.md' %}{% endcodeBlock %}
|
|
626
|
+
*
|
|
627
|
+
* @default
|
|
628
|
+
* {
|
|
629
|
+
* columns: 10,
|
|
630
|
+
* colorCode: {
|
|
631
|
+
* 'Custom': [
|
|
632
|
+
* '', '#000000', '#e7e6e6', '#44546a', '#4472c4', '#ed7d31', '#a5a5a5', '#ffc000', '#70ad47', '#ff0000',
|
|
633
|
+
* '#f2f2f2', '#808080', '#cfcdcd', '#d5dce4', '#d9e2f3', '#fbe4d5', '#ededed', '#fff2cc', '#e2efd9', '#ffcccc',
|
|
634
|
+
* '#d9d9d9', '#595959', '#aeaaaa', '#acb9ca', '#b4c6e7', '#f7caac', '#dbdbdb', '#ffe599', '#c5e0b3', '#ff8080',
|
|
635
|
+
* '#bfbfbf', '#404040', '#747070', '#8496b0', '#8eaadb', '#f4b083', '#c9c9c9', '#ffd966', '#a8d08d', '#ff3333',
|
|
636
|
+
* '#a6a6a6', '#262626', '#3b3838', '#323e4f', '#2f5496', '#c45911', '#7b7b7b', '#bf8f00', '#538135', '#b30000',
|
|
637
|
+
* '#7f7f7f', '#0d0d0d', '#161616', '#212934', '#1f3763', '#823b0b', '#525252', '#7f5f00', '#375623', '#660000']
|
|
638
|
+
* }
|
|
639
|
+
* }
|
|
640
|
+
*/
|
|
641
|
+
fontColor?: FontColorModel;
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* Predefine the color palette that can be rendered for background color (text highlighted color) toolbar command.
|
|
645
|
+
*
|
|
646
|
+
* {% codeBlock src='rich-text-editor/background-color/index.md' %}{% endcodeBlock %}
|
|
647
|
+
*
|
|
648
|
+
* @default
|
|
649
|
+
* {
|
|
650
|
+
* columns: 5,
|
|
651
|
+
* colorCode: {
|
|
652
|
+
* 'Custom': ['#ffff00', '#00ff00', '#00ffff', '#ff00ff', '#0000ff', '#ff0000',
|
|
653
|
+
* '#000080', '#008080', '#008000', '#800080', '#800000', '#808000',
|
|
654
|
+
* '#c0c0c0', '#000000', '']
|
|
655
|
+
* }
|
|
656
|
+
* }
|
|
657
|
+
*/
|
|
658
|
+
backgroundColor?: BackgroundColorModel;
|
|
659
|
+
|
|
660
|
+
/**
|
|
661
|
+
* Accepts the template design and assigns it as RichTextEditor’s content.
|
|
662
|
+
* The built-in template engine which provides options to compile template string into a executable function.
|
|
663
|
+
* For EX: We have expression evolution as like ES6 expression string literals
|
|
664
|
+
*
|
|
665
|
+
* {% codeBlock src='rich-text-editor/value-template/index.md' %}{% endcodeBlock %}
|
|
666
|
+
*
|
|
667
|
+
* @default null
|
|
668
|
+
* @aspType string
|
|
669
|
+
*/
|
|
670
|
+
valueTemplate?: string | Function;
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* Specifies the saveInterval in milliseconds for autosave the value.
|
|
674
|
+
* The change event will be triggered if the content was changed from the last saved interval.
|
|
675
|
+
*
|
|
676
|
+
* {% codeBlock src='rich-text-editor/save-interval/index.md' %}{% endcodeBlock %}
|
|
677
|
+
*
|
|
678
|
+
* @default 10000
|
|
679
|
+
*/
|
|
680
|
+
saveInterval?: number;
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* Triggers before command execution using toolbar items or executeCommand method.
|
|
684
|
+
* If you cancel this event, the command cannot be executed.
|
|
685
|
+
* Set the cancel argument to true to cancel the command execution.
|
|
686
|
+
*
|
|
687
|
+
* @event 'actionBegin'
|
|
688
|
+
*/
|
|
689
|
+
actionBegin?: EmitType<ActionBeginEventArgs>;
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* Triggers after command execution using toolbar items or executeCommand method.
|
|
693
|
+
*
|
|
694
|
+
* @event 'actionComplete'
|
|
695
|
+
*/
|
|
696
|
+
actionComplete?: EmitType<ActionCompleteEventArgs>;
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* Event triggers when the dialog is being opened.
|
|
700
|
+
* If you cancel this event, the dialog remains closed.
|
|
701
|
+
* Set the cancel argument to true to cancel the open of a dialog.
|
|
702
|
+
*
|
|
703
|
+
* @event 'beforeDialogOpen'
|
|
704
|
+
*/
|
|
705
|
+
|
|
706
|
+
beforeDialogOpen?: EmitType<BeforeOpenEventArgs>;
|
|
707
|
+
|
|
708
|
+
/**
|
|
709
|
+
* Event triggers when a dialog is opened.
|
|
710
|
+
*
|
|
711
|
+
* @event 'dialogOpen'
|
|
712
|
+
*/
|
|
713
|
+
dialogOpen?: EmitType<Object>;
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
* Event triggers when the dialog is being closed.
|
|
717
|
+
* If you cancel this event, the dialog remains opened.
|
|
718
|
+
* Set the cancel argument to true to prevent closing a dialog.
|
|
719
|
+
*
|
|
720
|
+
* @event 'beforeDialogClose'
|
|
721
|
+
*/
|
|
722
|
+
beforeDialogClose?: EmitType<BeforeCloseEventArgs>;
|
|
723
|
+
|
|
724
|
+
/**
|
|
725
|
+
* Event triggers after the dialog has been closed.
|
|
726
|
+
*
|
|
727
|
+
* @event 'dialogClose'
|
|
728
|
+
*/
|
|
729
|
+
dialogClose?: EmitType<Object>;
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* Event triggers when the quick toolbar is being opened.
|
|
733
|
+
*
|
|
734
|
+
* @event 'beforeQuickToolbarOpen'
|
|
735
|
+
*/
|
|
736
|
+
beforeQuickToolbarOpen?: EmitType<BeforeQuickToolbarOpenArgs>;
|
|
730
737
|
|
|
731
738
|
/**
|
|
732
|
-
* Event triggers when
|
|
733
|
-
*
|
|
734
|
-
* @event '
|
|
735
|
-
*/
|
|
736
|
-
|
|
739
|
+
* Event triggers when a quick toolbar is opened.
|
|
740
|
+
*
|
|
741
|
+
* @event 'quickToolbarOpen'
|
|
742
|
+
*/
|
|
743
|
+
quickToolbarOpen?: EmitType<Object>;
|
|
737
744
|
|
|
738
745
|
/**
|
|
739
|
-
* Event triggers
|
|
740
|
-
*
|
|
741
|
-
* @event '
|
|
742
|
-
*/
|
|
743
|
-
|
|
746
|
+
* Event triggers after the quick toolbar has been closed.
|
|
747
|
+
*
|
|
748
|
+
* @event 'quickToolbarClose'
|
|
749
|
+
*/
|
|
750
|
+
quickToolbarClose?: EmitType<Object>;
|
|
744
751
|
|
|
745
752
|
/**
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
* @
|
|
749
|
-
|
|
750
|
-
|
|
753
|
+
* This event is deprecated and no longer works. Use `updatedToolbarStatus` event to get the undo and redo status.
|
|
754
|
+
*
|
|
755
|
+
* @deprecated
|
|
756
|
+
* @event 'toolbarStatusUpdate'
|
|
757
|
+
*/
|
|
758
|
+
toolbarStatusUpdate?: EmitType<Object>;
|
|
751
759
|
|
|
752
760
|
/**
|
|
753
|
-
*
|
|
754
|
-
*
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
toolbarStatusUpdate?: EmitType<Object>;
|
|
759
|
-
|
|
760
|
-
/**
|
|
761
|
-
* Triggers when the toolbar items status is updated.
|
|
762
|
-
*
|
|
763
|
-
* @event 'updatedToolbarStatus'
|
|
764
|
-
*/
|
|
765
|
-
updatedToolbarStatus?: EmitType<ToolbarStatusEventArgs>;
|
|
761
|
+
* Triggers when the toolbar items status is updated.
|
|
762
|
+
*
|
|
763
|
+
* @event 'updatedToolbarStatus'
|
|
764
|
+
*/
|
|
765
|
+
updatedToolbarStatus?: EmitType<ToolbarStatusEventArgs>;
|
|
766
766
|
|
|
767
767
|
/**
|
|
768
|
-
* Event triggers when the image is selected or dragged into the insert image dialog.
|
|
769
|
-
*
|
|
770
|
-
* @event 'imageSelected'
|
|
771
|
-
*/
|
|
772
|
-
imageSelected?: EmitType<SelectedEventArgs>;
|
|
768
|
+
* Event triggers when the image is selected or dragged into the insert image dialog.
|
|
769
|
+
*
|
|
770
|
+
* @event 'imageSelected'
|
|
771
|
+
*/
|
|
772
|
+
imageSelected?: EmitType<SelectedEventArgs>;
|
|
773
773
|
|
|
774
774
|
/**
|
|
775
|
-
* Event triggers before the image upload process.
|
|
776
|
-
*
|
|
777
|
-
* @event 'beforeImageUpload'
|
|
778
|
-
*/
|
|
779
|
-
beforeImageUpload?: EmitType<BeforeUploadEventArgs>;
|
|
775
|
+
* Event triggers before the image upload process.
|
|
776
|
+
*
|
|
777
|
+
* @event 'beforeImageUpload'
|
|
778
|
+
*/
|
|
779
|
+
beforeImageUpload?: EmitType<BeforeUploadEventArgs>;
|
|
780
780
|
|
|
781
781
|
/**
|
|
782
|
-
* Event triggers when the selected image begins to upload in the insert image dialog.
|
|
783
|
-
*
|
|
784
|
-
* @event 'imageUploading'
|
|
785
|
-
*/
|
|
786
|
-
imageUploading?: EmitType<UploadingEventArgs>;
|
|
782
|
+
* Event triggers when the selected image begins to upload in the insert image dialog.
|
|
783
|
+
*
|
|
784
|
+
* @event 'imageUploading'
|
|
785
|
+
*/
|
|
786
|
+
imageUploading?: EmitType<UploadingEventArgs>;
|
|
787
787
|
|
|
788
788
|
/**
|
|
789
|
-
* Event triggers when the image is successfully uploaded to the server side.
|
|
790
|
-
*
|
|
791
|
-
* @event 'imageUploadSuccess'
|
|
792
|
-
*/
|
|
793
|
-
imageUploadSuccess?: EmitType<Object>;
|
|
789
|
+
* Event triggers when the image is successfully uploaded to the server side.
|
|
790
|
+
*
|
|
791
|
+
* @event 'imageUploadSuccess'
|
|
792
|
+
*/
|
|
793
|
+
imageUploadSuccess?: EmitType<Object>;
|
|
794
794
|
|
|
795
795
|
/**
|
|
796
|
-
* Event triggers when there is an error in the image upload.
|
|
797
|
-
*
|
|
798
|
-
* @event 'imageUploadFailed'
|
|
799
|
-
*/
|
|
800
|
-
imageUploadFailed?: EmitType<Object>;
|
|
796
|
+
* Event triggers when there is an error in the image upload.
|
|
797
|
+
*
|
|
798
|
+
* @event 'imageUploadFailed'
|
|
799
|
+
*/
|
|
800
|
+
imageUploadFailed?: EmitType<Object>;
|
|
801
801
|
|
|
802
802
|
/**
|
|
803
|
-
* Event triggers when the selected image is cleared from the insert image dialog.
|
|
804
|
-
*
|
|
805
|
-
* @event 'imageRemoving'
|
|
806
|
-
*/
|
|
807
|
-
imageRemoving?: EmitType<RemovingEventArgs>;
|
|
803
|
+
* Event triggers when the selected image is cleared from the insert image dialog.
|
|
804
|
+
*
|
|
805
|
+
* @event 'imageRemoving'
|
|
806
|
+
*/
|
|
807
|
+
imageRemoving?: EmitType<RemovingEventArgs>;
|
|
808
808
|
|
|
809
809
|
/**
|
|
810
|
-
* Event triggers when the selected image is cleared from the Rich Text Editor Content.
|
|
811
|
-
*
|
|
812
|
-
* @event 'afterImageDelete'
|
|
813
|
-
*/
|
|
814
|
-
afterImageDelete?: EmitType<AfterImageDeleteEventArgs>;
|
|
810
|
+
* Event triggers when the selected image is cleared from the Rich Text Editor Content.
|
|
811
|
+
*
|
|
812
|
+
* @event 'afterImageDelete'
|
|
813
|
+
*/
|
|
814
|
+
afterImageDelete?: EmitType<AfterImageDeleteEventArgs>;
|
|
815
815
|
|
|
816
816
|
/**
|
|
817
|
-
* Event triggers when the media is selected or dragged into the insert media audio/video dialog.
|
|
818
|
-
*
|
|
819
|
-
* @event 'fileSelected'
|
|
820
|
-
*/
|
|
821
|
-
fileSelected?: EmitType<SelectedEventArgs>;
|
|
817
|
+
* Event triggers when the media is selected or dragged into the insert media audio/video dialog.
|
|
818
|
+
*
|
|
819
|
+
* @event 'fileSelected'
|
|
820
|
+
*/
|
|
821
|
+
fileSelected?: EmitType<SelectedEventArgs>;
|
|
822
822
|
|
|
823
823
|
/**
|
|
824
|
-
* Event triggers before the media audio/video upload process.
|
|
825
|
-
*
|
|
826
|
-
* @event 'beforeFileUpload'
|
|
827
|
-
*/
|
|
828
|
-
beforeFileUpload?: EmitType<BeforeUploadEventArgs>;
|
|
824
|
+
* Event triggers before the media audio/video upload process.
|
|
825
|
+
*
|
|
826
|
+
* @event 'beforeFileUpload'
|
|
827
|
+
*/
|
|
828
|
+
beforeFileUpload?: EmitType<BeforeUploadEventArgs>;
|
|
829
829
|
|
|
830
830
|
/**
|
|
831
|
-
* Event triggers when the selected media begins to upload in the insert media audio/video dialog.
|
|
832
|
-
*
|
|
833
|
-
* @event 'fileUploading'
|
|
834
|
-
*/
|
|
835
|
-
fileUploading?: EmitType<UploadingEventArgs>;
|
|
831
|
+
* Event triggers when the selected media begins to upload in the insert media audio/video dialog.
|
|
832
|
+
*
|
|
833
|
+
* @event 'fileUploading'
|
|
834
|
+
*/
|
|
835
|
+
fileUploading?: EmitType<UploadingEventArgs>;
|
|
836
836
|
|
|
837
837
|
/**
|
|
838
|
-
* Event triggers when the media is successfully uploaded to the server side.
|
|
839
|
-
*
|
|
840
|
-
* @event 'fileUploadSuccess'
|
|
841
|
-
*/
|
|
842
|
-
fileUploadSuccess?: EmitType<Object>;
|
|
838
|
+
* Event triggers when the media is successfully uploaded to the server side.
|
|
839
|
+
*
|
|
840
|
+
* @event 'fileUploadSuccess'
|
|
841
|
+
*/
|
|
842
|
+
fileUploadSuccess?: EmitType<Object>;
|
|
843
843
|
|
|
844
844
|
/**
|
|
845
|
-
* Event triggers when there is an error in the media upload.
|
|
846
|
-
*
|
|
847
|
-
* @event 'fileUploadFailed'
|
|
848
|
-
*/
|
|
849
|
-
fileUploadFailed?: EmitType<Object>;
|
|
845
|
+
* Event triggers when there is an error in the media upload.
|
|
846
|
+
*
|
|
847
|
+
* @event 'fileUploadFailed'
|
|
848
|
+
*/
|
|
849
|
+
fileUploadFailed?: EmitType<Object>;
|
|
850
850
|
|
|
851
851
|
/**
|
|
852
|
-
* Event triggers when the selected media is cleared from the insert audio/video dialog.
|
|
853
|
-
*
|
|
854
|
-
* @event 'fileRemoving'
|
|
855
|
-
*/
|
|
856
|
-
fileRemoving?: EmitType<RemovingEventArgs>;
|
|
852
|
+
* Event triggers when the selected media is cleared from the insert audio/video dialog.
|
|
853
|
+
*
|
|
854
|
+
* @event 'fileRemoving'
|
|
855
|
+
*/
|
|
856
|
+
fileRemoving?: EmitType<RemovingEventArgs>;
|
|
857
857
|
|
|
858
858
|
/**
|
|
859
|
-
* Event triggers when the selected media is cleared from the Rich Text Editor Content.
|
|
860
|
-
*
|
|
861
|
-
* @event 'afterMediaDelete'
|
|
862
|
-
*/
|
|
863
|
-
afterMediaDelete?: EmitType<AfterMediaDeleteEventArgs>;
|
|
859
|
+
* Event triggers when the selected media is cleared from the Rich Text Editor Content.
|
|
860
|
+
*
|
|
861
|
+
* @event 'afterMediaDelete'
|
|
862
|
+
*/
|
|
863
|
+
afterMediaDelete?: EmitType<AfterMediaDeleteEventArgs>;
|
|
864
864
|
|
|
865
865
|
/**
|
|
866
|
-
* Triggers when the Rich Text Editor is rendered.
|
|
867
|
-
*
|
|
868
|
-
* @event 'created'
|
|
869
|
-
*/
|
|
870
|
-
created?: EmitType<Object>;
|
|
866
|
+
* Triggers when the Rich Text Editor is rendered.
|
|
867
|
+
*
|
|
868
|
+
* @event 'created'
|
|
869
|
+
*/
|
|
870
|
+
created?: EmitType<Object>;
|
|
871
871
|
|
|
872
872
|
/**
|
|
873
|
-
* Triggers when the Rich Text Editor is destroyed.
|
|
874
|
-
*
|
|
875
|
-
* @event 'destroyed'
|
|
876
|
-
*/
|
|
877
|
-
destroyed?: EmitType<Object>;
|
|
873
|
+
* Triggers when the Rich Text Editor is destroyed.
|
|
874
|
+
*
|
|
875
|
+
* @event 'destroyed'
|
|
876
|
+
*/
|
|
877
|
+
destroyed?: EmitType<Object>;
|
|
878
878
|
|
|
879
879
|
/**
|
|
880
|
-
* Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.
|
|
881
|
-
*
|
|
882
|
-
* @event 'beforeSanitizeHtml'
|
|
883
|
-
*/
|
|
884
|
-
beforeSanitizeHtml?: EmitType<BeforeSanitizeHtmlArgs>;
|
|
880
|
+
* Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.
|
|
881
|
+
*
|
|
882
|
+
* @event 'beforeSanitizeHtml'
|
|
883
|
+
*/
|
|
884
|
+
beforeSanitizeHtml?: EmitType<BeforeSanitizeHtmlArgs>;
|
|
885
885
|
|
|
886
886
|
/**
|
|
887
|
-
* Triggers when Rich Text Editor is focused out.
|
|
888
|
-
*
|
|
889
|
-
* @event 'blur'
|
|
890
|
-
*/
|
|
891
|
-
blur?: EmitType<Object>;
|
|
887
|
+
* Triggers when Rich Text Editor is focused out.
|
|
888
|
+
*
|
|
889
|
+
* @event 'blur'
|
|
890
|
+
*/
|
|
891
|
+
blur?: EmitType<Object>;
|
|
892
892
|
|
|
893
893
|
/**
|
|
894
|
-
* Triggers when Rich Text Editor Toolbar items is clicked.
|
|
895
|
-
*
|
|
896
|
-
* @event 'toolbarClick'
|
|
897
|
-
*/
|
|
898
|
-
toolbarClick?: EmitType<Object>;
|
|
894
|
+
* Triggers when Rich Text Editor Toolbar items is clicked.
|
|
895
|
+
*
|
|
896
|
+
* @event 'toolbarClick'
|
|
897
|
+
*/
|
|
898
|
+
toolbarClick?: EmitType<Object>;
|
|
899
899
|
|
|
900
900
|
/**
|
|
901
|
-
* Triggers when Rich Text Editor is focused in
|
|
902
|
-
*
|
|
903
|
-
* @event 'focus'
|
|
904
|
-
*/
|
|
905
|
-
focus?: EmitType<Object>;
|
|
901
|
+
* Triggers when Rich Text Editor is focused in
|
|
902
|
+
*
|
|
903
|
+
* @event 'focus'
|
|
904
|
+
*/
|
|
905
|
+
focus?: EmitType<Object>;
|
|
906
906
|
|
|
907
907
|
/**
|
|
908
|
-
* Triggers only when Rich Text Editor is blurred and changes are done to the content.
|
|
909
|
-
*
|
|
910
|
-
* @event 'change'
|
|
911
|
-
*/
|
|
912
|
-
change?: EmitType<ChangeEventArgs>;
|
|
908
|
+
* Triggers only when Rich Text Editor is blurred and changes are done to the content.
|
|
909
|
+
*
|
|
910
|
+
* @event 'change'
|
|
911
|
+
*/
|
|
912
|
+
change?: EmitType<ChangeEventArgs>;
|
|
913
913
|
|
|
914
914
|
/**
|
|
915
|
-
* Triggers only when resizing the image.
|
|
916
|
-
*
|
|
917
|
-
* @event 'resizing'
|
|
918
|
-
*/
|
|
919
|
-
resizing?: EmitType<ResizeArgs>;
|
|
915
|
+
* Triggers only when resizing the image.
|
|
916
|
+
*
|
|
917
|
+
* @event 'resizing'
|
|
918
|
+
*/
|
|
919
|
+
resizing?: EmitType<ResizeArgs>;
|
|
920
920
|
|
|
921
921
|
/**
|
|
922
|
-
* Triggers only when start resize the image.
|
|
923
|
-
*
|
|
924
|
-
* @event 'resizeStart'
|
|
925
|
-
*/
|
|
926
|
-
resizeStart?: EmitType<ResizeArgs>;
|
|
922
|
+
* Triggers only when start resize the image.
|
|
923
|
+
*
|
|
924
|
+
* @event 'resizeStart'
|
|
925
|
+
*/
|
|
926
|
+
resizeStart?: EmitType<ResizeArgs>;
|
|
927
927
|
|
|
928
928
|
/**
|
|
929
|
-
* Triggers only when stop resize the image.
|
|
930
|
-
*
|
|
931
|
-
* @event 'resizeStop'
|
|
932
|
-
*/
|
|
933
|
-
resizeStop?: EmitType<ResizeArgs>;
|
|
929
|
+
* Triggers only when stop resize the image.
|
|
930
|
+
*
|
|
931
|
+
* @event 'resizeStop'
|
|
932
|
+
*/
|
|
933
|
+
resizeStop?: EmitType<ResizeArgs>;
|
|
934
934
|
|
|
935
935
|
/**
|
|
936
|
-
* Triggers before cleanup the copied content.
|
|
937
|
-
*
|
|
938
|
-
* @event 'beforePasteCleanup'
|
|
939
|
-
*/
|
|
940
|
-
beforePasteCleanup?: EmitType<PasteCleanupArgs>;
|
|
936
|
+
* Triggers before cleanup the copied content.
|
|
937
|
+
*
|
|
938
|
+
* @event 'beforePasteCleanup'
|
|
939
|
+
*/
|
|
940
|
+
beforePasteCleanup?: EmitType<PasteCleanupArgs>;
|
|
941
941
|
|
|
942
942
|
/**
|
|
943
|
-
* Triggers after cleanup the copied content.
|
|
944
|
-
*
|
|
945
|
-
* @event 'afterPasteCleanup'
|
|
946
|
-
*/
|
|
947
|
-
afterPasteCleanup?: EmitType<object>;
|
|
943
|
+
* Triggers after cleanup the copied content.
|
|
944
|
+
*
|
|
945
|
+
* @event 'afterPasteCleanup'
|
|
946
|
+
*/
|
|
947
|
+
afterPasteCleanup?: EmitType<object>;
|
|
948
948
|
|
|
949
949
|
/**
|
|
950
|
-
* Triggers before drop the image.
|
|
951
|
-
*
|
|
952
|
-
* @event 'beforeImageDrop'
|
|
953
|
-
*/
|
|
954
|
-
beforeImageDrop?: EmitType<ImageDropEventArgs>;
|
|
950
|
+
* Triggers before drop the image.
|
|
951
|
+
*
|
|
952
|
+
* @event 'beforeImageDrop'
|
|
953
|
+
*/
|
|
954
|
+
beforeImageDrop?: EmitType<ImageDropEventArgs>;
|
|
955
955
|
|
|
956
956
|
/**
|
|
957
|
-
* Customize keyCode to change the key value.
|
|
958
|
-
*
|
|
959
|
-
* {% codeBlock src='rich-text-editor/formatter/index.md' %}{% endcodeBlock %}
|
|
960
|
-
*
|
|
961
|
-
* @default null
|
|
962
|
-
*/
|
|
963
|
-
formatter?: IFormatter;
|
|
957
|
+
* Customize keyCode to change the key value.
|
|
958
|
+
*
|
|
959
|
+
* {% codeBlock src='rich-text-editor/formatter/index.md' %}{% endcodeBlock %}
|
|
960
|
+
*
|
|
961
|
+
* @default null
|
|
962
|
+
*/
|
|
963
|
+
formatter?: IFormatter;
|
|
964
964
|
|
|
965
965
|
}
|