@syncfusion/ej2-richtexteditor 20.2.50 → 20.3.47

package/src/rich-text-editor/base/rich-text-editor.d.ts

@@ -6,7 +6,7 @@ import { Render } from '../renderer/render';
 import { ViewSource } from '../renderer/view-source';
 import { IRenderer, IFormatter, ActionCompleteEventArgs, ActionBeginEventArgs, ImageDropEventArgs } from './interface';
 import { CommandName, ResizeArgs, ToolbarStatusEventArgs } from './interface';
-import { BeforeQuickToolbarOpenArgs, ChangeEventArgs, AfterImageDeleteEventArgs, PasteCleanupArgs } from './interface';
+import { BeforeQuickToolbarOpenArgs, ChangeEventArgs, AfterImageDeleteEventArgs, AfterMediaDeleteEventArgs, PasteCleanupArgs } from './interface';
 import { ILinkCommandsArgs, IImageCommandsArgs, BeforeSanitizeHtmlArgs, ITableCommandsArgs, ExecuteCommandOption } from './interface';
 import { ServiceLocator } from '../services/service-locator';
 import { DialogType } from './enum';
@@ -14,10 +14,12 @@ import { EditorMode, ShiftEnterKey, EnterKey } from './../../common/types';
 import { Toolbar } from '../actions/toolbar';
 import { KeyboardEvents } from '../actions/keyboard';
 import { FontFamilyModel, FontSizeModel, FontColorModel, FormatModel, BackgroundColorModel, NumberFormatListModel, BulletFormatListModel } from '../models/models';
-import { ToolbarSettingsModel, IFrameSettingsModel, ImageSettingsModel, TableSettingsModel } from '../models/models';
+import { ToolbarSettingsModel, IFrameSettingsModel, ImageSettingsModel, AudioSettingsModel, VideoSettingsModel, TableSettingsModel } from '../models/models';
 import { QuickToolbarSettingsModel, InlineModeModel, PasteCleanupSettingsModel, FileManagerSettingsModel } from '../models/models';
 import { Link } from '../renderer/link-module';
 import { Image } from '../renderer/image-module';
+import { Audio } from '../renderer/audio-module';
+import { Video } from '../renderer/video-module';
 import { Table } from '../renderer/table-module';
 import { Count } from '../actions/count';
 import { HtmlEditor } from '../actions/html-editor';
@@ -108,6 +110,16 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * @hidden
 
+     */
+    audioModule: Audio;
+    /**
+     * @hidden
+
+     */
+    videoModule: Video;
+    /**
+     * @hidden
+
      */
     tableModule: Table;
     /**
@@ -215,6 +227,8 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
      * actionOnScroll: 'hide',
      * link: ['Open', 'Edit', 'UnLink'],
      * image: ['Replace', 'Align', 'Caption', 'Remove', '-', 'InsertLink', 'Display', 'AltText', 'Dimension'],
+     * audio: ['AudioReplace', 'AudioRemove', 'AudioLayoutOption'],
+     * video: ['VideoReplace', 'VideoAlign', 'VideoRemove', 'VideoLayoutOption', 'VideoDimension'],
      * }
      */
     quickToolbarSettings: QuickToolbarSettingsModel;
@@ -293,6 +307,54 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
      * }
      */
     insertImageSettings: ImageSettingsModel;
+    /**
+     * Specifies the audio insert options in Rich Text Editor component and control with the following properties.
+     * * allowedTypes - Specifies the extensions of the audio types allowed to insert on bowering and
+     * passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
+     * * layoutOption - Sets the default display for an audio when it is inserted in to the RichTextEditor.
+     * Possible options are: 'Inline' and 'Break'.
+     * * saveFormat - Specifies the format to store the audio in the Rich Text Editor (Base64 or Blob).
+     * > If you want to insert a lot of tiny audios in the editor and don't want a specific physical location for
+     * saving audios, you can opt to save format as Base64.
+     * * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
+     * * path - Specifies the path of the location to store the audios and refer it to display the audios.
+     *
+     * @default
+     * {
+     * allowedTypes: ['.wav', '.mp3', '.m4a','.wma'],
+     * layoutOption: 'Inline',
+     * saveFormat: 'Blob'
+     * saveUrl: null,
+     * path: null,
+     * }
+     */
+    insertAudioSettings: AudioSettingsModel;
+    /**
+     * Specifies the video insert options in Rich Text Editor component and control with the following properties.
+     * * allowedTypes - Specifies the extensions of the video types allowed to insert on bowering and
+     * passing the extensions with comma separators. For example, pass allowedTypes as .jpg and .png.
+     * * layoutOption - Sets the default display for an video when it is inserted in to the RichTextEditor.
+     * Possible options are: 'Inline' and 'Break'.
+     * * width - Sets the default width of the video when it is inserted in the RichTextEditor.
+     * * saveFormat - Specifies the format to store the video in the Rich Text Editor (Base64 or Blob).
+     * > If you want to insert a lot of tiny videos in the editor and don't want a specific physical location for
+     * saving videos, you can opt to save format as Base64.
+     * * height - Sets the default height of the video when it is inserted in the RichTextEditor.
+     * * saveUrl - Specifies the service URL of save action that will receive the uploaded files and save them in the server.
+     * * path - Specifies the path of the location to store the videos and refer it to display the videos.
+     *
+     * @default
+     * {
+     * allowedTypes: ['.mp4', '.mov', '.wmv','.avi'],
+     * layoutOption: 'Inline',
+     * width: 'auto',
+     * height: 'auto',
+     * saveFormat: 'Blob'
+     * saveUrl: null,
+     * path: null,
+     * }
+     */
+    insertVideoSettings: VideoSettingsModel;
     /**
      * Specifies the table insert options in Rich Text Editor component and control with the following properties.
      * * styles - Class name should be appended by default in table element.
@@ -738,7 +800,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
      * If you cancel this event, the dialog remains closed.
      * Set the cancel argument to true to cancel the open of a dialog.
      *
-     * @event 'object'
+     * @event 'beforeDialogOpen'
      * @blazorProperty 'OnDialogOpen'
      * @blazorType Syncfusion.EJ2.Blazor.Popups.BeforeOpenEventArgs
      */
@@ -746,7 +808,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers when a dialog is opened.
      *
-     * @event 'object'
+     * @event 'dialogOpen'
      * @blazorProperty 'DialogOpened'
      * @blazorType DialogOpenEventArgs
      */
@@ -756,7 +818,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
      * If you cancel this event, the dialog remains opened.
      * Set the cancel argument to true to prevent closing a dialog.
      *
-     * @event 'object'
+     * @event 'beforeDialogClose'
      * @blazorProperty 'OnDialogClose'
      * @blazorType Syncfusion.EJ2.Blazor.Popups.BeforeOpenEventArgs
      */
@@ -764,7 +826,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers after the dialog has been closed.
      *
-     * @event 'object'
+     * @event 'dialogClose'
      * @blazorProperty 'DialogClosed'
      * @blazorType DialogCloseEventArgs
      */
@@ -772,14 +834,14 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers when the quick toolbar is being opened.
      *
-     * @event 'object'
+     * @event 'beforeQuickToolbarOpen'
      * @blazorProperty 'OnQuickToolbarOpen'
      */
     beforeQuickToolbarOpen: EmitType<BeforeQuickToolbarOpenArgs>;
     /**
      * Event triggers when a quick toolbar is opened.
      *
-     * @event 'object'
+     * @event 'quickToolbarOpen'
      * @blazorProperty 'QuickToolbarOpened'
      * @blazorType QuickToolbarEventArgs
      */
@@ -787,7 +849,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers after the quick toolbar has been closed.
      *
-     * @event 'object'
+     * @event 'quickToolbarClose'
      * @blazorProperty 'QuickToolbarClosed'
      * @blazorType QuickToolbarEventArgs
      */
@@ -796,20 +858,20 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
      * This event is deprecated and no longer works. Use `updatedToolbarStatus` event to get the undo and redo status.
      *
 
-     * @event 'object'
+     * @event 'toolbarStatusUpdate'
      */
     toolbarStatusUpdate: EmitType<Object>;
     /**
      * Triggers when the toolbar items status is updated.
      *
-     * @event 'object'
+     * @event 'updatedToolbarStatus'
      * @blazorType ToolbarUpdateEventArgs
      */
     updatedToolbarStatus: EmitType<ToolbarStatusEventArgs>;
     /**
      * Event triggers when the image is selected or dragged into the insert image dialog.
      *
-     * @event 'object'
+     * @event 'imageSelected'
      * @blazorProperty 'OnImageSelected'
      */
     imageSelected: EmitType<SelectedEventArgs>;
@@ -822,14 +884,14 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers when the selected image begins to upload in the insert image dialog.
      *
-     * @event 'object'
+     * @event 'imageUploading'
      * @blazorProperty 'OnImageUploading'
      */
     imageUploading: EmitType<UploadingEventArgs>;
     /**
      * Event triggers when the image is successfully uploaded to the server side.
      *
-     * @event 'object'
+     * @event 'imageUploadSuccess'
      * @blazorProperty 'OnImageUploadSuccess'
      * @blazorType ImageSuccessEventArgs
      */
@@ -837,7 +899,7 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers when there is an error in the image upload.
      *
-     * @event 'object'
+     * @event 'imageUploadFailed'
      * @blazorProperty 'OnImageUploadFailed'
      * @blazorType ImageFailedEventArgs
      */
@@ -845,28 +907,70 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers when the selected image is cleared from the insert image dialog.
      *
-     * @event 'object'
+     * @event 'imageRemoving'
      * @blazorProperty 'OnImageRemoving'
      */
     imageRemoving: EmitType<RemovingEventArgs>;
     /**
      * Event triggers when the selected image is cleared from the Rich Text Editor Content.
      *
-     * @event 'object'
+     * @event 'afterImageDelete'
      * @blazorProperty 'OnImageDelete'
      */
     afterImageDelete: EmitType<AfterImageDeleteEventArgs>;
+    /**
+     * Event triggers when the media is selected or dragged into the insert media audio/video dialog.
+     *
+     * @event 'fileSelected'
+     */
+    fileSelected: EmitType<SelectedEventArgs>;
+    /**
+     * Event triggers before the media audio/video upload process.
+     *
+     * @event 'beforeFileUpload'
+     */
+    beforeFileUpload: EmitType<BeforeUploadEventArgs>;
+    /**
+     * Event triggers when the selected media begins to upload in the insert media audio/video dialog.
+     *
+     * @event 'fileUploading'
+     */
+    fileUploading: EmitType<UploadingEventArgs>;
+    /**
+     * Event triggers when the media is successfully uploaded to the server side.
+     *
+     * @event 'fileUploadSuccess'
+     */
+    fileUploadSuccess: EmitType<Object>;
+    /**
+     * Event triggers when there is an error in the media upload.
+     *
+     * @event 'fileUploadFailed'
+     */
+    fileUploadFailed: EmitType<Object>;
+    /**
+     * Event triggers when the selected media is cleared from the insert audio/video dialog.
+     *
+     * @event 'fileRemoving'
+     */
+    fileRemoving: EmitType<RemovingEventArgs>;
+    /**
+     * Event triggers when the selected media is cleared from the Rich Text Editor Content.
+     *
+     * @event 'afterMediaDelete'
+     */
+    afterMediaDelete: EmitType<AfterMediaDeleteEventArgs>;
     /**
      * Triggers when the Rich Text Editor is rendered.
      *
-     * @event 'object'
+     * @event 'created'
      * @blazorProperty 'Created'
      */
     created: EmitType<Object>;
     /**
      * Triggers when the Rich Text Editor is destroyed.
      *
-     * @event 'object'
+     * @event 'destroyed'
      * @blazorProperty 'Destroyed'
      * @blazorType DestroyedEventArgs
      */
@@ -874,21 +978,21 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Event triggers before sanitize the value. It's only applicable to editorMode as `HTML`.
      *
-     * @event 'object'
+     * @event 'beforeSanitizeHtml'
      * @blazorProperty 'OnSanitizeHtml'
      */
     beforeSanitizeHtml: EmitType<BeforeSanitizeHtmlArgs>;
     /**
      * Triggers when Rich Text Editor is focused out.
      *
-     * @event 'object'
+     * @event 'blur'
      * @blazorType BlurEventArgs
      */
     blur: EmitType<Object>;
     /**
      * Triggers when Rich Text Editor Toolbar items is clicked.
      *
-     * @event 'object'
+     * @event 'toolbarClick'
      * @blazorProperty 'OnToolbarClick'
      * @blazorType ToolbarClickEventArgs
      */
@@ -896,54 +1000,54 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
     /**
      * Triggers when Rich Text Editor is focused in
      *
-     * @event 'object'
+     * @event 'focus'
      * @blazorType FocusEventArgs
      */
     focus: EmitType<Object>;
     /**
      * Triggers only when Rich Text Editor is blurred and changes are done to the content.
      *
-     * @event 'object'
+     * @event 'change'
      * @blazorProperty 'ValueChange'
      */
     change: EmitType<ChangeEventArgs>;
     /**
      * Triggers only when resizing the image.
      *
-     * @event 'object'
+     * @event 'resizing'
      * @blazorProperty 'Resizing'
      */
     resizing: EmitType<ResizeArgs>;
     /**
      * Triggers only when start resize the image.
      *
-     * @event 'object'
+     * @event 'resizeStart'
      * @blazorProperty 'OnResizeStart'
      */
     resizeStart: EmitType<ResizeArgs>;
     /**
      * Triggers only when stop resize the image.
      *
-     * @event 'object'
+     * @event 'resizeStop'
      * @blazorProperty 'OnResizeStop'
      */
     resizeStop: EmitType<ResizeArgs>;
     /**
      * Triggers before cleanup the copied content.
      *
-     * @event 'object'
+     * @event 'beforePasteCleanup'
      */
     beforePasteCleanup: EmitType<PasteCleanupArgs>;
     /**
      * Triggers after cleanup the copied content.
      *
-     * @event 'object'
+     * @event 'afterPasteCleanup'
      */
     afterPasteCleanup: EmitType<object>;
     /**
      * Triggers before drop the image.
      *
-     * @event 'object'
+     * @event 'beforeImageDrop'
      * @blazorProperty 'OnImageDrop'
      */
     beforeImageDrop: EmitType<ImageDropEventArgs>;
@@ -1057,6 +1161,14 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
 
      */
     protected render(): void;
+    /**
+     * addAudioVideoWrapper method
+     *
+     * @returns {void}
+     * @hidden
+
+     */
+    addAudioVideoWrapper(): void;
     /**
      * For internal use only - Initialize the event handler
      *
@@ -1301,6 +1413,14 @@ export declare class RichTextEditor extends Component<HTMLElement> implements IN
 
      */
     getInsertImgMaxWidth(): string | number;
+    /**
+     * Video max width calculation method
+     *
+     * @returns {void}
+     * @hidden
+
+     */
+    getInsertVidMaxWidth(): string | number;
     /**
      * setContentHeight method
      *