@syncfusion/ej2-richtexteditor 18.1.52 → 18.2.44-4568

package/src/rich-text-editor/models/toolbar-settings-model.d.ts

@@ -1,4 +1,4 @@
-import { Property, ChildProperty } from '@syncfusion/ej2-base';import { ToolbarType, ActionOnScroll, ToolbarItems } from '../base/enum';import { IToolbarItems, IDropDownItemModel, ColorModeType, IToolsItemConfigs } from '../base/interface';import { TableStyleItems } from '../models/items';import { SaveFormat } from '../../common';
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
 
 /**
  * Interface for a class ToolbarSettings
@@ -6,39 +6,39 @@ import { Property, ChildProperty } from '@syncfusion/ej2-base';import { ToolbarT
 export interface ToolbarSettingsModel {
 
     /**
-     * Specifies whether to render toolbar in RichTextEditor.
-     * @default true
-     */
-    enable?: boolean;
+     * Specifies whether to render toolbar in RichTextEditor.
+     * @default true
+     */
+    enable?: boolean;
 
     /**
-     * Specifies whether to enable/disable floating toolbar.
-     * @default true
-     */
-    enableFloating?: boolean;
+     * Specifies whether to enable/disable floating toolbar.
+     * @default true
+     */
+    enableFloating?: boolean;
 
     /**
-     * Specifies the Toolbar display types.
-     * The possible types are:
-     * - Expand: Toolbar items placed within the available space and rest of the items are placed to the extended menu section.
-     * - MultiRow: Toolbar which placed at top of Rich Text Editor editing area.
-     * - Scrollable: All the toolbar items are displayed in a single line with horizontal scrolling enabled.
-     * @default Expand
-     */
-    type?: ToolbarType;
+     * Specifies the Toolbar display types.
+     * The possible types are:
+     * - Expand: Toolbar items placed within the available space and rest of the items are placed to the extended menu section.
+     * - MultiRow: Toolbar which placed at top of Rich Text Editor editing area.
+     * - Scrollable: All the toolbar items are displayed in a single line with horizontal scrolling enabled.
+     * @default Expand
+     */
+    type?: ToolbarType;
 
     /**
-     * An array of string or object that is used to configure items.
-     * @default ['Bold', 'Italic', 'Underline', '|', 'Formats', 'Alignments', 'OrderedList',
-     * 'UnorderedList', '|', 'CreateLink', 'Image', '|', 'SourceCode', 'Undo', 'Redo']
-     */
-    items?: (string | IToolbarItems)[];
+     * An array of string or object that is used to configure items.
+     * @default ['Bold', 'Italic', 'Underline', '|', 'Formats', 'Alignments', 'OrderedList',
+     * 'UnorderedList', '|', 'CreateLink', 'Image', '|', 'SourceCode', 'Undo', 'Redo']
+     */
+    items?: (string | IToolbarItems)[];
 
     /**
-     * Using this property, Modify the default toolbar item configuration like icon class.
-     * @default {}
-     */
-    itemConfigs?: { [key in ToolbarItems]?: IToolsItemConfigs };
+     * Using this property, Modify the default toolbar item configuration like icon class.
+     * @default {}
+     */
+    itemConfigs?: { [key in ToolbarItems]?: IToolsItemConfigs };
 
 }
 
@@ -48,82 +48,82 @@ export interface ToolbarSettingsModel {
 export interface ImageSettingsModel {
 
     /**
-     * Specifies whether to allowType based file select.
-     * @default ['.jpeg', '.jpg', '.png']
-     */
-    allowedTypes?: string[];
+     * Specifies whether to allowType based file select.
+     * @default ['.jpeg', '.jpg', '.png']
+     */
+    allowedTypes?: string[];
 
     /**
-     * Specifies whether insert image inline or break.
-     * @default 'inline'
-     */
-    display?: string;
+     * Specifies whether insert image inline or break.
+     * @default 'inline'
+     */
+    display?: string;
 
     /**
-     * Specifies whether the inserted image is saved as blob or base64.
-     * @default 'Blob'
-     */
-    saveFormat?: SaveFormat;
+     * Specifies whether the inserted image is saved as blob or base64.
+     * @default 'Blob'
+     */
+    saveFormat?: SaveFormat;
 
     /**
-     * Specifies whether image width.
-     * @default 'auto'
-     */
-    width?: string;
+     * Specifies whether image width.
+     * @default 'auto'
+     */
+    width?: string;
 
     /**
-     * Specifies whether image height.
-     * @default 'auto'
-     */
-    height?: string;
+     * Specifies whether image height.
+     * @default 'auto'
+     */
+    height?: string;
 
     /**
-     * Specifies the URL of save action that will receive the upload files and save in the server.
-     * @default 'null'
-     */
-    saveUrl?: string;
+     * Specifies the URL of save action that will receive the upload files and save in the server.
+     * @default 'null'
+     */
+    saveUrl?: string;
 
     /**
-     * Specifies the URL of save action that will receive the upload files and save in the server.
-     * @default 'null'
-     */
-    path?: string;
+     * Specifies the URL of save action that will receive the upload files and save in the server.
+     * @default 'null'
+     */
+    path?: string;
 
     /**
-     * To enable resizing for image element.
-     * @default 'true'
-     */
-    resize?: boolean;
+     * To enable resizing for image element.
+     * @default 'true'
+     */
+    resize?: boolean;
 
     /**
-     * Defines the minimum Width of the image.
-     * @default '0'
-     */
-    minWidth?: string | number;
+     * Defines the minimum Width of the image.
+     * @default '0'
+     */
+    minWidth?: string | number;
 
     /**
-     * Defines the maximum Width of the image.
-     * @default null
-     */
-    maxWidth?: string | number;
+     * Defines the maximum Width of the image.
+     * @default null
+     */
+    maxWidth?: string | number;
 
     /**
-     * Defines the minimum Height of the image.
-     * @default '0'
-     */
-    minHeight?: string | number;
+     * Defines the minimum Height of the image.
+     * @default '0'
+     */
+    minHeight?: string | number;
 
     /**
-     * Defines the maximum Height of the image.
-     * @default null
-     */
-    maxHeight?: string | number;
+     * Defines the maximum Height of the image.
+     * @default null
+     */
+    maxHeight?: string | number;
 
     /**
-     * image resizing should be done by percentage calculation.
-     * @default false
-     */
-    resizeByPercent?: boolean;
+     * image resizing should be done by percentage calculation.
+     * @default false
+     */
+    resizeByPercent?: boolean;
 
 }
 
@@ -133,35 +133,35 @@ export interface ImageSettingsModel {
 export interface TableSettingsModel {
 
     /**
-     * To specify the width of table
-     * @default '100%'
-     */
-    width?: string | number;
+     * To specify the width of table
+     * @default '100%'
+     */
+    width?: string | number;
 
     /**
-     * Class name should be appended by default in table element.
-     * It helps to design the table in specific CSS styles always when inserting in editor.
-     * @default TableStyleItems;
-     */
-    styles?: IDropDownItemModel[];
+     * Class name should be appended by default in table element.
+     * It helps to design the table in specific CSS styles always when inserting in editor.
+     * @default TableStyleItems;
+     */
+    styles?: IDropDownItemModel[];
 
     /**
-     * To enable resizing for table element.
-     * @default 'true'
-     */
-    resize?: boolean;
+     * To enable resizing for table element.
+     * @default 'true'
+     */
+    resize?: boolean;
 
     /**
-     * Defines the minimum Width of the table.
-     * @default '0'
-     */
-    minWidth?: string | number;
+     * Defines the minimum Width of the table.
+     * @default '0'
+     */
+    minWidth?: string | number;
 
     /**
-     * Defines the maximum Width of the table.
-     * @default null
-     */
-    maxWidth?: string | number;
+     * Defines the maximum Width of the table.
+     * @default null
+     */
+    maxWidth?: string | number;
 
 }
 
@@ -171,47 +171,47 @@ export interface TableSettingsModel {
 export interface QuickToolbarSettingsModel {
 
     /**
-     * Specifies whether to enable quick toolbar in RichTextEditor.
-     * @default true
-     */
-    enable?: boolean;
+     * Specifies whether to enable quick toolbar in RichTextEditor.
+     * @default true
+     */
+    enable?: boolean;
 
     /**
-     * Specifies whether to opens a quick toolbar on the right click.
-     * @default false
-     */
-    showOnRightClick?: boolean;
+     * Specifies whether to opens a quick toolbar on the right click.
+     * @default false
+     */
+    showOnRightClick?: boolean;
 
     /**
-     * Specifies the action that should happen when scroll the target-parent container.
-     * @default 'hide'
-     */
-    actionOnScroll?: ActionOnScroll;
+     * Specifies the action that should happen when scroll the target-parent container.
+     * @default 'hide'
+     */
+    actionOnScroll?: ActionOnScroll;
 
     /**
-     * Specifies the items to render in quick toolbar, when link selected.
-     * @default ['Open', 'Edit', 'UnLink']
-     */
-    link?: (string | IToolbarItems)[];
+     * Specifies the items to render in quick toolbar, when link selected.
+     * @default ['Open', 'Edit', 'UnLink']
+     */
+    link?: (string | IToolbarItems)[];
 
     /**
-     * Specifies the items to render in quick toolbar, when image selected.
-     * @default ['Replace', 'Align', 'Caption', 'Remove', '-', 'InsertLink','OpenImageLink', 'EditImageLink', 'RemoveImageLink', 'Display', 'AltText', 'Dimension']
-     */
-    // tslint:disable
-    image?: (string | IToolbarItems)[];
+     * Specifies the items to render in quick toolbar, when image selected.
+     * @default ['Replace', 'Align', 'Caption', 'Remove', '-', 'InsertLink','OpenImageLink', 'EditImageLink', 'RemoveImageLink', 'Display', 'AltText', 'Dimension']
+     */
+    // tslint:disable
+    image?: (string | IToolbarItems)[];
 
     /**
-     * Specifies the items to render in quick toolbar, when text selected.
-     * @default ['Cut', 'Copy', 'Paste']
-     */
-    text?: (string | IToolbarItems)[];
+     * Specifies the items to render in quick toolbar, when text selected.
+     * @default ['Cut', 'Copy', 'Paste']
+     */
+    text?: (string | IToolbarItems)[];
 
     /**
-     * Specifies the items to render in quick toolbar, when table selected.
-     * @default ['TableHeader', 'TableRows', 'TableColumns', 'BackgroundColor', '-', 'TableRemove', 'Alignments', 'TableCellVerticalAlign', 'Styles']
-     */
-    table?: (string | IToolbarItems)[];
+     * Specifies the items to render in quick toolbar, when table selected.
+     * @default ['TableHeader', 'TableRows', 'TableColumns', 'BackgroundColor', '-', 'TableRemove', 'Alignments', 'TableCellVerticalAlign', 'Styles']
+     */
+    table?: (string | IToolbarItems)[];
 
 }
 
@@ -221,40 +221,40 @@ export interface QuickToolbarSettingsModel {
 export interface PasteCleanupSettingsModel {
 
     /**
-     * Specifies whether to enable the prompt for paste in RichTextEditor.
-     * @default false
-     */
-    prompt?: boolean;
+     * Specifies whether to enable the prompt for paste in RichTextEditor.
+     * @default false
+     */
+    prompt?: boolean;
 
     /**
-     * Specifies the attributes to restrict when pasting in RichTextEditor.
-     * @default null
-     */
-    deniedAttrs?: string[];
+     * Specifies the attributes to restrict when pasting in RichTextEditor.
+     * @default null
+     */
+    deniedAttrs?: string[];
 
     /**
-     * Specifies the allowed style properties when pasting in RichTextEditor.
-     * @default ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius', 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor', 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style', 'height', 'left', 'line-height', 'margin', 'margin-top', 'margin-left', 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width', 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right', 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent', 'top', 'vertical-align', 'visibility', 'white-space', 'width']
-     */
-    allowedStyleProps?: string[];
+     * Specifies the allowed style properties when pasting in RichTextEditor.
+     * @default ['background', 'background-color', 'border', 'border-bottom', 'border-left', 'border-radius', 'border-right', 'border-style', 'border-top', 'border-width', 'clear', 'color', 'cursor', 'direction', 'display', 'float', 'font', 'font-family', 'font-size', 'font-weight', 'font-style', 'height', 'left', 'line-height', 'margin', 'margin-top', 'margin-left', 'margin-right', 'margin-bottom', 'max-height', 'max-width', 'min-height', 'min-width', 'overflow', 'overflow-x', 'overflow-y', 'padding', 'padding-bottom', 'padding-left', 'padding-right', 'padding-top', 'position', 'right', 'table-layout', 'text-align', 'text-decoration', 'text-indent', 'top', 'vertical-align', 'visibility', 'white-space', 'width']
+     */
+    allowedStyleProps?: string[];
 
     /**
-     * Specifies the tags to restrict when pasting in RichTextEditor.
-     * @default null
-     */
-    deniedTags?: string[];
+     * Specifies the tags to restrict when pasting in RichTextEditor.
+     * @default null
+     */
+    deniedTags?: string[];
 
     /**
-     * Specifies whether to keep or remove the format when pasting in RichTextEditor.
-     * @default true
-     */
-    keepFormat?: boolean;
+     * Specifies whether to keep or remove the format when pasting in RichTextEditor.
+     * @default true
+     */
+    keepFormat?: boolean;
 
     /**
-     * Specifies whether to paste as plain text or not in RichTextEditor.
-     * @default false
-     */
-    plainText?: boolean;
+     * Specifies whether to paste as plain text or not in RichTextEditor.
+     * @default false
+     */
+    plainText?: boolean;
 
 }
 
@@ -264,22 +264,22 @@ export interface PasteCleanupSettingsModel {
 export interface FontFamilyModel {
 
     /**
-     * Specifies default font family selection
-     * @default 'null'
-     */
-    default?: string;
+     * Specifies default font family selection
+     * @default 'null'
+     */
+    default?: string;
 
     /**
-     * Specifies content width
-     * @default '65px'
-     */
-    width?: string;
+     * Specifies content width
+     * @default '65px'
+     */
+    width?: string;
 
     /**
-     * Specifies default font family items
-     * @default fontFamily
-     */
-    items?: IDropDownItemModel[];
+     * Specifies default font family items
+     * @default fontFamily
+     */
+    items?: IDropDownItemModel[];
 
 }
 
@@ -289,22 +289,22 @@ export interface FontFamilyModel {
 export interface FontSizeModel {
 
     /**
-     * Specifies default font size selection
-     * @default 'null'
-     */
-    default?: string;
+     * Specifies default font size selection
+     * @default 'null'
+     */
+    default?: string;
 
     /**
-     * Specifies content width
-     * @default '35px'
-     */
-    width?: string;
+     * Specifies content width
+     * @default '35px'
+     */
+    width?: string;
 
     /**
-     * Specifies default font size items
-     * @default fontSize
-     */
-    items?: IDropDownItemModel[];
+     * Specifies default font size items
+     * @default fontSize
+     */
+    items?: IDropDownItemModel[];
 
 }
 
@@ -314,22 +314,22 @@ export interface FontSizeModel {
 export interface FormatModel {
 
     /**
-     * Specifies default format
-     * @default 'null'
-     */
-    default?: string;
+     * Specifies default format
+     * @default 'null'
+     */
+    default?: string;
 
     /**
-     * Specifies content width
-     * @default '65px'
-     */
-    width?: string;
+     * Specifies content width
+     * @default '65px'
+     */
+    width?: string;
 
     /**
-     * Specifies default font size items
-     * @default formatItems
-     */
-    types?: IDropDownItemModel[];
+     * Specifies default font size items
+     * @default formatItems
+     */
+    types?: IDropDownItemModel[];
 
 }
 
@@ -339,34 +339,34 @@ export interface FormatModel {
 export interface FontColorModel {
 
     /**
-     * Specifies default font color
-     * @default '#ff0000'
-     */
-    default?: string;
+     * Specifies default font color
+     * @default '#ff0000'
+     */
+    default?: string;
 
     /**
-     * Specifies mode
-     * @default 'Palette'
-     */
-    mode?: ColorModeType;
+     * Specifies mode
+     * @default 'Palette'
+     */
+    mode?: ColorModeType;
 
     /**
-     * Specifies columns
-     * @default 10
-     */
-    columns?: number;
+     * Specifies columns
+     * @default 10
+     */
+    columns?: number;
 
     /**
-     * Specifies color code customization
-     * @default fontColor
-     */
-    colorCode?: { [key: string]: string[] };
+     * Specifies color code customization
+     * @default fontColor
+     */
+    colorCode?: { [key: string]: string[] };
 
     /**
-     * Specifies modeSwitcher button
-     * @default false
-     */
-    modeSwitcher?: boolean;
+     * Specifies modeSwitcher button
+     * @default false
+     */
+    modeSwitcher?: boolean;
 
 }
 
@@ -376,33 +376,33 @@ export interface FontColorModel {
 export interface BackgroundColorModel {
 
     /**
-     * Specifies default font color
-     * @default '#ffff00'
-     */
-    default?: string;
+     * Specifies default font color
+     * @default '#ffff00'
+     */
+    default?: string;
 
     /**
-     * Specifies mode
-     * @default 'Palette'
-     */
-    mode?: ColorModeType;
+     * Specifies mode
+     * @default 'Palette'
+     */
+    mode?: ColorModeType;
 
     /**
-     * Specifies columns
-     * @default 10
-     */
-    columns?: number;
+     * Specifies columns
+     * @default 10
+     */
+    columns?: number;
 
     /**
-     * Specifies color code customization
-     * @default backgroundColor
-     */
-    colorCode?: { [key: string]: string[] };
+     * Specifies color code customization
+     * @default backgroundColor
+     */
+    colorCode?: { [key: string]: string[] };
 
     /**
-     * Specifies a modeSwitcher button
-     * @default false
-     */
-    modeSwitcher?: boolean;
+     * Specifies a modeSwitcher button
+     * @default false
+     */
+    modeSwitcher?: boolean;
 
 }

package/src/rich-text-editor/renderer/content-renderer.d.ts

@@ -3,7 +3,7 @@ import { ServiceLocator } from '../services/service-locator';
 /**
  * Content module is used to render Rich Text Editor content
  * @hidden
-
+ * @deprecated
  */
 export declare class ContentRender implements IRenderer {
     protected contentPanel: Element;
@@ -17,21 +17,21 @@ export declare class ContentRender implements IRenderer {
     /**
      * The function is used to render Rich Text Editor content div
      * @hidden
-
+     * @deprecated
      */
     renderPanel(): void;
     /**
      * Get the content div element of RichTextEditor
      * @return {Element}
      * @hidden
-
+     * @deprecated
      */
     getPanel(): Element;
     /**
      * Get the editable element of RichTextEditor
      * @return {Element}
      * @hidden
-
+     * @deprecated
      */
     getEditPanel(): Element;
     /**
@@ -43,14 +43,14 @@ export declare class ContentRender implements IRenderer {
      * Set the content div element of RichTextEditor
      * @param {Element} panel
      * @hidden
-
+     * @deprecated
      */
     setPanel(panel: Element): void;
     /**
      * Get the document of RichTextEditor
      * @return {Document}
      * @hidden
-
+     * @deprecated
      */
     getDocument(): Document;
 }