smart-webcomponents-angular

import { Editor } from './../index'; import { Animation, EditorContextMenu, EditMode, EditorImageFormat, PasteFormat, ToolbarMode, ToolbarViewMode, EditorAi, EditorContentFiltering, EditorDataExport, EditorIframeSettings, ToolbarItem } from './../index'; import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core'; import { BaseElement } from './smart.element'; import * as i0 from "@angular/core"; export { Animation, EditorContentFilteringAttributeFilterMode, EditorContentFilteringTagFilterMode, EditorContentFilteringStyleAttributeFilterMode, EditorContextMenu, EditMode, EditorImageFormat, PasteFormat, ToolbarMode, ToolbarViewMode, EditorAi, EditorContentFiltering, EditorDataExport, EditorIframeSettings, ToolbarItem, ToolbarItemEditor, ElementRenderMode } from './../index'; export { Smart } from './smart.element'; export { Editor } from './../index'; export declare class EditorComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges { constructor(ref: ElementRef<Editor>); private eventHandlers; nativeElement: Editor; /** @description Creates the component on demand. * @param properties An optional object of properties, which will be added to the template binded ones. */ createComponent(properties?: {}): any; /** @description An object that defines configuration settings for integrating AI capabilities within the grid, including options for enabling AI features, specifying AI service endpoints, adjusting model parameters, and customizing AI-driven functionality in the grid interface. */ get ai(): EditorAi; set ai(value: EditorAi); /** @description Specifies or retrieves the current animation mode. When set to 'none', all animations are disabled. For other values, animations are enabled according to the selected mode. */ get animation(): Animation | string; set animation(value: Animation | string); /** @description Automatically formats your text in real-time as you type, converting your input into structured elements such as bullet points, checkboxes, headings, and code blocks. This feature streamlines note-taking and writing by instantly applying consistent formatting without requiring manual markup or additional steps. */ get autoFormatting(): boolean; set autoFormatting(value: boolean); /** @description Automatically restores the editor's most recently saved state from the browser's local storage when the element is initialized. To retrieve the correct saved state, you must specify a unique id that matches the one used during the saving process. Without this id, the editor cannot identify or load the previously stored state. */ get autoLoad(): boolean; set autoLoad(value: boolean); /** @description Automatically saves the editor's current content at regular intervals specified by the autoSaveInterval property, but only while the editor element is focused. To enable automatic saving, you must assign a unique id to the editor element; this id is used to store and retrieve the editor's saved state. */ get autoSave(): boolean; set autoSave(value: boolean); /** @description Specifies the time interval, in milliseconds, at which the Editor automatically saves its state when the autoSave property is enabled. This property controls how frequently the Editor performs auto-save operations. */ get autoSaveInterval(): number; set autoSaveInterval(value: number); /** @description A customizable formatting function for the character counter display in the Editor. This function receives two parameters:- chars: The current number of characters entered by the user in the Editor.- maxCharCount: The maximum allowed number of characters for the Editor input.The function should return a formatted string that represents the character count status, which will be shown in the Editor’s UI (for example, "25 / 100 characters"). This allows developers to define custom formats for how the character count is displayed to users. */ get charCountFormatFunction(): any; set charCountFormatFunction(value: any); /** @description Controls whether files are automatically uploaded immediately after the user selects them. When enabled, the upload process begins as soon as files are chosen. When disabled, file upload must be triggered manually. This property can be used to either retrieve the current auto-upload setting or update it. */ get autoUpload(): boolean; set autoUpload(value: boolean); /** @description Specifies the configuration for content filtering, allowing you to define which types of content are allowed or blocked according to the selected criteria or rules. */ get contentFiltering(): EditorContentFiltering; set contentFiltering(value: EditorContentFiltering); /** @description Defines the CSS file(s) or styles to be applied to the content area within the Editor, allowing you to customize the appearance and formatting of the editor’s content. */ get content_css(): string; set content_css(value: string); /** @description Specifies the items and structure of the context menu that appears when a user right-clicks within the Editor's content area. This setting allows you to customize which menu options are available based on the user's actions, providing tailored functionality and quick access to relevant commands. */ get contextMenu(): EditorContextMenu | string; set contextMenu(value: EditorContextMenu | string); /** @description Enhances the Editor’s context menu by allowing you to customize its default items. This property accepts several formats:- 'Array of Items:' You can provide an array where each item is either: - A 'string' representing the value/action for the menu item. - An 'object' in the format '{ label: string, value: string }', where: - 'label' is the text displayed in the menu. - 'value' is the action or identifier associated with that menu item.- 'Function:' You can also pass a function that dynamically generates the array of menu items. The function receives the following parameters: - 'target' ('HTMLElement'): The DOM element where the context menu is triggered. - 'type' ('string'): The type or context of the menu (e.g., "table", "image", "link", or other relevant context types). - 'defaultItems' ('string[]'): The default set of menu item identifiers for that context. The function should return an array of menu items (as described above), which will be rendered in place of the default menu.'Example function signature:''''javascriptfunction (target: HTMLElement, type: string, defaultItems: string[]) { return defaultItems;}'''This flexible property enables you to tailor the context menu based on the user's selection, the specific element targeted, or the context of the interaction, helping create a more intuitive and relevant editing experience. */ get contextMenuDataSource(): string[] | { label: string; value: 'string'; }[] | Function | null; set contextMenuDataSource(value: string[] | { label: string; value: 'string'; }[] | Function | null); /** @description Configures the available options for exporting data from the Editor, such as file formats (CSV, JSON, XML), export settings, and customization preferences. These settings determine how users can save or export content from the Editor. */ get dataExport(): EditorDataExport; set dataExport(value: EditorDataExport); /** @description Controls whether the Editor component is active or inactive. When enabled, users can interact with and make changes within the Editor; when disabled, all editing functionalities are restricted or unavailable. */ get disabled(): boolean; set disabled(value: boolean); /** @description Prevents users from modifying or editing content within the Editor, making all content read-only. */ get disableEditing(): boolean; set disableEditing(value: boolean); /** @description Prevents the Quick Search Bar from appearing or being accessible to users, effectively disabling its functionality across the application. */ get disableSearchBar(): boolean; set disableSearchBar(value: boolean); /** @description Specifies the editing mode for the Editor component. By default, the Editor operates in standard HTML mode, allowing users to input and edit HTML content directly. In this mode, pressing Enter inserts line breaks or new paragraphs according to standard HTML behavior. When set to 'blockHtml', the Editor creates new DIV elements each time the user presses Enter, promoting a block-based editing experience. This mode also provides built-in commands tailored for structured data entry and manipulation.If set to 'markdown', the Editor functions as a dedicated Markdown editor. User input is interpreted as Markdown syntax, and the Editor automatically parses and converts the Markdown content into HTML for real-time preview. This enables a seamless writing and formatting workflow for users who prefer Markdown.Possible values:- 'html' (default): Accepts and parses HTML input.- 'blockHtml': Uses DIV tags for new blocks and offers additional commands for data input.- 'markdown': Enables Markdown syntax input with live HTML preview. */ get editMode(): EditMode | string; set editMode(value: EditMode | string); /** @description Specifies whether the output from the getHTML method and the Source Code view should be HTML-encoded. When enabled, special characters in the code (such as , and &) are converted to their HTML entity equivalents, ensuring correct display and preventing unintended HTML rendering. When disabled, the values are returned as raw HTML without encoding. */ get enableHtmlEncode(): boolean; set enableHtmlEncode(value: boolean); /** @description Specifies whether pressing the Tab key inside the Editor will insert a tab character at the cursor position, or instead move focus to the next focusable element (default behavior). When enabled, Tab inserts a tab character; when disabled, Tab shifts focus as usual. */ get enableTabKey(): boolean; set enableTabKey(value: boolean); /** @description Specifies the duration (in milliseconds) between consecutive result updates when using the "Find and Replace" and "Search Bar" features. Adjusting this interval can affect how quickly search results are refreshed and displayed to the user during searches. */ get findAndReplaceTimeout(): number; set findAndReplaceTimeout(value: number); /** @description Specifies whether the Toolbar is visible or hidden. When set to true, the Toolbar will be hidden; when set to false, the Toolbar will be displayed. */ get hideToolbar(): boolean; set hideToolbar(value: boolean); /** @description Specifies whether the Inline Toolbar is visible. If set to true, the toolbar will be hidden; if false, the toolbar will be displayed. */ get hideInlineToolbar(): boolean; set hideInlineToolbar(value: boolean); /** @description Specifies the file format for images or videos uploaded from local storage. By default, uploaded files are encoded and stored as base64 strings. This setting allows you to define or change the storage format as needed. */ get imageFormat(): EditorImageFormat | string; set imageFormat(value: EditorImageFormat | string); /** @description Automatically detects and sets the appropriate width for images pasted from the clipboard, ensuring consistent image display and optimal fit within the layout. */ get imagePasteWidth(): number; set imagePasteWidth(value: number); /** @description Automatically detects and sets the appropriate height for an image when it is pasted from the clipboard, ensuring correct aspect ratio and consistent display within the application. */ get imagePasteHeight(): number; set imagePasteHeight(value: number); /** @description Sets the content of the Editor using an HTML string. This method enables you to programmatically insert both plain text and HTML elements, including tags, formatting, and embedded media, directly into the Editor. Existing content will be replaced by the provided HTML. Use this to dynamically update the Editor's contents with custom HTML markup. */ get innerHTML(): string; set innerHTML(value: string); /** @description Specifies the horizontal (x) and vertical (y) offset values used to adjust the position of the Inline Toolbar relative to its default placement on the page. This allows for precise positioning by shifting the toolbar along the x and y axes. */ get inlineToolbarOffset(): number[]; set inlineToolbarOffset(value: number[]); /** @description Specifies the iframe configuration for the Editor. When enabled, the Editor's content is rendered within an isolated iframe, ensuring separation from the main DOM and preventing style or script conflicts. This option enhances content security and encapsulation. Additionally, it provides a mechanism to inject external resources (such as stylesheets or scripts) directly into the iframe environment if required. */ get iframeSettings(): EditorIframeSettings; set iframeSettings(value: EditorIframeSettings); /** @description Gets or sets the unlockKey, a unique value required to activate or unlock the product’s features. Use this property to provide the unlock key when authorizing access, or retrieve the current unlock key associated with the product. */ get unlockKey(): string; set unlockKey(value: string); /** @description Specifies the current language code used for localization, such as "en" for English or "fr" for French. This property works together with the messages property to display the appropriate localized messages based on the selected language. Use it to get or set the active language for your application's interface. */ get locale(): string; set locale(value: string); /** @description Specifies the maximum number of characters that can be entered within the Editor. Once this limit is reached, users will be unable to input additional characters. */ get maxCharCount(): number; set maxCharCount(value: number); /** @description Defines or retrieves an object containing all user-visible strings (such as labels, tooltips, and messages) used by the widget for display purposes and localization. This property works together with the language setting to enable customization and translation of the widget’s interface into different languages. The object allows developers to provide localized string values, ensuring the widget content is appropriately translated for end users. */ get messages(): any; set messages(value: any); /** @description Assigns the specified element to the property †a†, designating it as the form control responsible for submitting the Editor's value. This allows the Editor’s content to be included in form submissions, ensuring its data is sent when the form is submitted. */ get name(): string | null; set name(value: string | null); /** @description Specifies the format (such as plain text, HTML, or Markdown) in which content will be inserted into the Editor when a user pastes data, ensuring consistent formatting and correct rendering within the editing environment. */ get pasteFormat(): PasteFormat | string; set pasteFormat(value: PasteFormat | string); /** @description Specifies the placeholder text or element displayed within the Editor when it is empty, guiding users on what to enter or indicating the expected content. */ get placeholder(): string; set placeholder(value: string); /** @description Specifies whether activating the clearFormat toolbar action should also remove any inline CSS styles (such as style attributes) applied to the currently selected node. When enabled, this option ensures that in addition to removing formatting tags (like <b>, <i>, etc.), all custom inline styles will be cleared from the selected content. */ get removeStylesOnClearFormat(): boolean; set removeStylesOnClearFormat(value: boolean); /** @description Specifies whether the Editor's content is required. If this option is enabled and the Editor is left empty, a notification will be displayed indicating that the content cannot be empty and must be provided before proceeding. */ get required(): boolean; set required(value: boolean); /** @description Sets or retrieves a value that specifies whether the element's text direction and alignment are configured for right-to-left (RTL) languages, such as Arabic or Hebrew. This property ensures that the element displays its content in a manner appropriate for RTL locale support. */ get rightToLeft(): boolean; set rightToLeft(value: boolean); /** @description Indicates whether the value is sanitized to protect against Cross-Site Scripting (XSS) attacks. When enabled, any potentially malicious scripts, inline event handlers, or other XSS vulnerabilities are automatically removed from the HTML content entered in the Editor, ensuring only safe and clean HTML is allowed. */ get sanitized(): boolean; set sanitized(value: boolean); /** @description Controls the visibility of the character counter. When enabled, the counter appears in the bottom right corner of the input field. If a maxCharCount value is set, the counter changes color to visually warn the user as they approach the character limit:- When the content length reaches 70% or more of the maximum, the counter displays a warning color.- At 90% or more of the maximum, the counter switches to a more prominent warning color, indicating that the limit is nearly reached.- Once the character count reaches the maximum limit, further text input is prevented. */ get showCharCount(): boolean; set showCharCount(value: boolean); /** @description Specifies if the editor enables spell checking, allowing the identification and highlighting of spelling errors within the text. If set to true, the editor will actively check and mark misspelled words as the user types. If set to false, spell checking functionality will be disabled. */ get spellCheck(): boolean; set spellCheck(value: boolean); /** @description Specifies the time interval, in milliseconds, at which the Source Code and Preview panels are automatically refreshed when Split Mode is active. Adjusting this value controls how frequently the panels update to reflect changes in real-time while Split Mode is enabled. */ get splitModeRefreshTimeout(): number; set splitModeRefreshTimeout(value: number); /** @description Defines the list of editor users for the application. Expects an array of user objects, each requiring the following properties: - ''id'': A unique identifier for the user (string or number). - ''name'': The display name of the user (string). Each user object may also include the following optional properties: - ''color'': A string specifying the user's color (e.g., HEX or CSS color value) for UI highlighting. - ''image'': A string containing the URL of the user's avatar or profile image. */ get users(): any[]; set users(value: any[]); /** @description Activates the editor pages functionality, allowing users to create, edit, and manage custom pages directly within the editor interface. */ get enablePages(): boolean; set enablePages(value: boolean); /** @description Defines the editor pages by accepting an array of objects, where each object must include a 'label' property (a string representing the title or name of the page) and an 'innerHTML' property (a string containing the HTML content to be displayed on that page). */ get pages(): any[]; set pages(value: any[]); /** @description Specifies the URL endpoint used for file uploads. This property directly maps to the 'action' attribute of the upload form, determining where the uploaded data is sent on the server. For example, you can set the 'uploadUrl' property to the path of a server-side script such as a PHP file (e.g., "upload.php") that processes and handles incoming file uploads. Setting this property ensures that files selected by the user are transmitted to the specified server location when the upload form is submitted. */ get uploadUrl(): string; set uploadUrl(value: string); /** @description Defines or retrieves the URL used for the remove operation. This property corresponds to the form's action attribute and specifies the server endpoint that will handle item removal requests. For example, setting the removeUrl property to the path of a PHP file enables the server-side script to process and execute the removal action when triggered. */ get removeUrl(): string; set removeUrl(value: string); /** @description Specifies the theme to be applied to the element. The selected theme controls the overall visual appearance, including colors, fonts, and styles, ensuring a consistent look and feel throughout the element. */ get theme(): string; set theme(value: string); /** @description 'Provides the configuration for the Toolbar items in the editor.' The value can be either an array of strings—where each string specifies the name of a default toolbar item—or an array of objects for more advanced configuration and customization. - 'String Values:' Each string refers to a toolbar item by its name. Names are case-insensitive.- 'Object Values:' An object can define a custom toolbar item, or modify/add settings to an existing one. - The object must include a 'name' property (case-insensitive) to refer to a default toolbar item’s functionality. - If 'name' is set to "custom", you can define a fully custom toolbar item. - If the 'name' attribute is missing or invalid, the entry is treated as a separator rather than a toolbar item.'Supported Default Toolbar Items' Below is a list of default toolbar items supported by the editor, along with their descriptions and types: - 'SourceCode': Toggles between the HTML source/preview panel and the input panel. *Type: Toggle button*- 'SplitMode': Splits the editor view to show both input and preview panels. *Type: Toggle button*- 'FullScreen': Expands the editor to fill the viewport, overlaying the page content. *Type: Toggle button*- 'Alignment': Controls the alignment (left, center, right, justify) of the selected content. *Type: Dropdown*- 'FontName': Sets the font family of the selected content. *Type: Dropdown*- 'FontSize': Sets the font size of the selected content. *Type: Dropdown*- 'Formats': Changes the format/style of the current selection (e.g., paragraph, heading). *Type: Dropdown*- 'TableRows': Insert or remove table rows in the selected table. *Type: Dropdown*- 'TableColumns': Insert or remove table columns in the selected table. *Type: Dropdown*- 'TableVAlign': Sets vertical alignment of a selected table cell. *Type: Dropdown*- 'TableStyle': Applies additional styling to the selected table. *Type: Dropdown*- 'BackgroundColor': Changes the background color of the current selection. *Type: Color input*- 'FontColor': Changes the font color of the current selection. *Type: Color input*- 'Bold': Toggles bold for the selected text. *Type: Button*- 'Italic': Toggles italic for the selected text. *Type: Button*- 'Underline': Toggles underline for the selected text. *Type: Button*- 'Strikethrough': Toggles strikethrough for the selected text. *Type: Button*- 'Delete': Deletes the current selection. *Type: Button*- 'Undo': Reverts the last operation. *Type: Button*- 'Redo': Redoes the previously undone operation. *Type: Button*- 'Indent': Increases the indentation of the current selection. *Type: Button*- 'Outdent': Decreases the indentation of the current selection. *Type: Button*- 'OpenLink': Opens the hyperlink of the current selection. *Type: Button*- 'EditLink', 'CreateLink', 'Hyperlink': Creates, edits, or triggers a dialog for hyperlink management. *Type: Button*- 'RemoveLink': Removes a hyperlink from the selected text. *Type: Button*- 'Cut': Cuts the selected content. *Type: Button*- 'Copy': Copies the selected content. *Type: Button*- 'Paste': Pastes from the clipboard. - *Type: Button* - *Type: Dropdown* (when the "advanced" property is set to true)- 'Image': Opens a dialog to insert or edit an image. *Type: Button*- 'Video': Opens a dialog to insert or edit a video. *Type: Button*- 'LowerCase': Converts current selection to lowercase letters. *Type: Button*- 'UpperCase': Converts current selection to uppercase letters. *Type: Button*- 'Print': Opens the browser's print preview window. *Type: Button*- 'Caption': Inserts or removes a caption in the selected table. *Type: Button*- 'ClearFormat': Removes all formatting from the current selection. *Type: Button*- 'Table': Opens a dialog to insert a new table. *Type: Button*- 'TableHeader': Adds or removes a header row in the selected table. *Type: Button*- 'OrderedList': Inserts or removes an ordered (numbered) list. *Type: Button*- 'UnorderedList': Inserts or removes a bulleted list. *Type: Button*- 'Subscript': Formats the selected text as subscript. *Type: Button*- 'Superscript': Formats the selected text as superscript. *Type: Button*- 'FindAndReplace': Opens a dialog to find and replace text in the editor. *Type: Button*'Note:' Separators between toolbar items can be added by using an object without a valid 'name' property.---'inlineToolbarItems' - This property is applicable only for the following toolbar items: 'table', 'image', and 'hyperlink'.- Accepts the same value types and structure as 'toolbarItems'.- The specified items will be displayed in an inline floating toolbar when any of these elements is selected in the editor.---'Summary of Usage Examples:''''json[ "Bold", "Italic", { "name": "FontSize", "options": ["Small", "Medium", "Large"] }, {}, { "name": "custom", "label": "Custom Action", "icon": "..." }]'''- The above would provide bold and italic buttons, a dropdown with custom font size options, a separator, and a custom toolbar item.---This configuration enables full customization of the editor’s toolbar to suit different user requirements, offering both default and extendable options. */ get toolbarItems(): ToolbarItem[]; set toolbarItems(value: ToolbarItem[]); /** @description Specifies the display style of the Editor’s main toolbar. You can choose between "Ribbon" mode, which presents the toolbar as a horizontal panel with grouped command icons similar to modern office applications, or "Menu" mode, which organizes commands in drop-down menus for a more compact, traditional interface. This setting controls how users interact with the Editor’s primary tools and functions. */ get toolbarMode(): ToolbarMode | string; set toolbarMode(value: ToolbarMode | string); /** @description Enables customization of the SingleLineRibbon's appearance by allowing you to modify the arrangement and selection of group items, as well as reorder the groups themselves. This provides flexibility in tailoring the ribbon layout to better suit your application's specific needs. */ get toolbarRibbonConfig(): { name: string; groups: { name: string; items: string[]; }[]; }[]; set toolbarRibbonConfig(value: { name: string; groups: { name: string; items: string[]; }[]; }[]); /** @description Specifies the format (such as plain text, HTML, or Markdown) that will be applied to content when it is pasted into the Editor. This setting controls how the pasted data is interpreted and ensures that it is correctly displayed within the Editor environment. */ get toolbarViewMode(): ToolbarViewMode | string; set toolbarViewMode(value: ToolbarViewMode | string); /** @description Fixes the Toolbar to the top of the browser window, ensuring it remains visible at all times, even as the user scrolls through the page content. */ get toolbarSticky(): boolean; set toolbarSticky(value: boolean); /** @description If set to true, this property prevents the element from receiving keyboard or programmatic focus, making it impossible for users to interact with it using the keyboard or assistive technologies. */ get unfocusable(): boolean; set unfocusable(value: boolean); /** @description Provides methods to retrieve or update the current content within the Editor. Use this property to access the existing value or assign a new value to the Editor programmatically. */ get value(): string; set value(value: string); /** @description A customizable function that allows you to fully modify the appearance and behavior of the Editor dialog used for inserting or editing tables, images, videos, and hyperlinks. The function receives two arguments:- 'target': The dialog element instance that is about to be displayed, representing the specific editor dialog (e.g., Table, Image, Video, or Hyperlink dialog) being opened.- 'item': The toolbar item object that triggered the opening of the dialog, allowing you to access information about the source of the dialog request or customize its settings based on the initiating toolbar action.Use this function to tailor the dialog's UI elements, default values, event handlers, or any other properties, providing a flexible way to match the dialog experience to your application's needs. */ get windowCustomizationFunction(): any; set windowCustomizationFunction(value: any); /** @description This event is triggered when an element loses focus (blur event) and its content has been modified since it last received focus. * @param event. The custom event. Custom event was created with: event.detail( oldValue, value) * oldValue - The old value before the change. * value - The new value after the change. */ onChange: EventEmitter<CustomEvent>; /** @description This event is triggered immediately after the user modifies the content through direct input, such as typing, pasting, or deleting text. It serves as a notification that the content has changed specifically due to user interaction, allowing you to respond to updates made by the user in real time. * @param event. The custom event. Custom event was created with: event.detail( oldValue, value) * oldValue - The old value before the input change. * value - The new value after the input change. */ onChanging: EventEmitter<CustomEvent>; /** @description This event is fired immediately before a Toolbar action begins execution, allowing developers to intervene or modify behavior as needed. By invoking event.preventDefault() within the event handler, you can cancel the pending Toolbar action, preventing it from proceeding. This provides an opportunity to implement custom validation, confirmation prompts, or other pre-action logic before the Toolbar action is carried out. * @param event. The custom event. Custom event was created with: event.detail( name) * name - The name of the action. */ onActionStart: EventEmitter<CustomEvent>; /** @description This event is triggered after a Toolbar action has been completed. It signifies that all processes related to the action, such as updating the UI or executing related logic, have finished. Use this event to perform any follow-up tasks when a Toolbar action concludes. * @param event. The custom event. Custom event was created with: event.detail( name) * name - The name of the action. */ onActionEnd: EventEmitter<CustomEvent>; /** @description This event is triggered when a user selects and clicks on an item within the context menu. It allows you to execute custom logic in response to specific context menu actions, providing access to details about which menu item was clicked and the relevant context of the interaction. * @param event. The custom event. Custom event was created with: event.detail( originalEvent, value) * originalEvent - The original click event. * value - The value of the item. */ onContextMenuItemClick: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the user opens the context menu, typically by right-clicking or using a designated keyboard shortcut on an element. It allows developers to execute custom logic or modify the context menu's content before it is displayed to the user. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onContextMenuOpen: EventEmitter<CustomEvent>; /** @description This event is triggered immediately before the context menu appears, typically as a result of a user right-clicking or performing a similar gesture. At this point, you have the opportunity to customize or modify the context menu, or to prevent the menu from opening entirely by calling event.preventDefault() within the event handler. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. */ onContextMenuOpening: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the Context Menu is closed, either by user action (such as clicking outside the menu, selecting a menu item, or pressing the Escape key) or programmatically through the relevant API. Handlers for this event can be used to perform clean-up tasks or update the user interface in response to the Context Menu being dismissed. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onContextMenuClose: EventEmitter<CustomEvent>; /** @description This event is fired just before the Context Menu begins to close. By calling event.preventDefault() within the event handler, you can cancel the closing action, allowing you to override or delay the default behavior based on custom logic. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. */ onContextMenuClosing: EventEmitter<CustomEvent>; /** @description This event is triggered when a user initiates the resizing of an image, table, or video element. It indicates that the resizing operation has begun, allowing you to implement custom behaviors or UI updates in response to the start of a resize action. * @param event. The custom event. */ onResizeStart: EventEmitter<CustomEvent>; /** @description This event is triggered when the user has completed resizing an image, table, or video element. It fires after the resizing action ends, allowing you to perform actions such as saving the new dimensions or updating the layout in response to the change. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The element that is resized (image/table or video). */ onResizeEnd: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the inline Toolbar becomes visible to the user, such as when a user selects text or performs an action that causes the Toolbar to appear within the interface. Use this event to run custom logic or adjust UI elements in response to the Toolbar opening. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onInlineToolbarOpen: EventEmitter<CustomEvent>; /** @description This event is fired just before the inline Toolbar begins to open. Developers can intercept this event and prevent the Toolbar from opening by invoking event.preventDefault() within the event handler. This allows for conditional control over the Toolbar's visibility based on custom application logic. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. */ onInlineToolbarOpening: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the inline toolbar is closed, either by user interaction (such as clicking outside the toolbar, pressing Esc, or selecting a toolbar option) or programmatically via code. It provides an opportunity to perform cleanup, update UI elements, or execute additional logic in response to the toolbar being dismissed. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onInlineToolbarClose: EventEmitter<CustomEvent>; /** @description This event is triggered immediately before the inline toolbar begins to close, allowing you to perform actions or cleanup tasks in response to the toolbar's closure. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. The closing operation can be canceled by calling event.preventDefault() in the event handler function. */ onInlineToolbarClosing: EventEmitter<CustomEvent>; /** @description This event is triggered each time the Drop Down Toolbar becomes visible to the user, such as when it is expanded or opened. You can use this event to execute custom logic whenever the toolbar is displayed, for example, to load dynamic content or adjust UI elements within the toolbar. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onDropDownToolbarOpen: EventEmitter<CustomEvent>; /** @description This event is triggered just before the Drop Down Toolbar begins to open. Within the event handler, you can call event.preventDefault() to cancel the opening operation, allowing you to customize or prevent the display of the toolbar based on specific conditions. This provides an opportunity to implement custom logic before the toolbar becomes visible to the user. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. */ onDropDownToolbarOpening: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the Drop Down Toolbar is closed, either by user interaction (such as clicking outside the toolbar or selecting an option) or programmatically via the application's code. Use this event to perform actions or update the user interface in response to the toolbar being dismissed. * @param event. The custom event. Custom event was created with: event.detail( target, owner) * target - The toolbar that is the target of the operation. * owner - The tooltip target (the owner of the tooltip). */ onDropDownToolbarClose: EventEmitter<CustomEvent>; /** @description This event is fired when the Drop Down Toolbar begins its closing process. Within the event handler, you can prevent the toolbar from closing by invoking event.preventDefault(). This provides an opportunity to execute custom logic, such as confirming the action with the user or validating conditions before allowing the toolbar to close. * @param event. The custom event. Custom event was created with: event.detail( target) * target - The toolbar that is the target of the operation. */ onDropDownToolbarClosing: EventEmitter<CustomEvent>; /** @description This event is triggered when the Dialog Window is successfully opened and becomes visible to the user. * @param event. The custom event. Custom event was created with: event.detail( target, item) * target - The window that is the target of the operation. * item - The toolbar item is the target of the operation. */ onDialogOpen: EventEmitter<CustomEvent>; /** @description This event is fired immediately before the Dialog Window begins to open, giving developers an opportunity to perform actions or modify options prior to rendering. You can cancel the default behavior and prevent the Dialog Window from opening by calling event.preventDefault() within the event handler. * @param event. The custom event. Custom event was created with: event.detail( target, item) * target - The window that is the target of the operation. * item - The toolbar item that is the target of the operation. */ onDialogOpening: EventEmitter<CustomEvent>; /** @description This event is triggered whenever the Dialog Window is closed by the user, either through clicking the close button, pressing the escape key, or programmatically via code. It allows developers to execute custom actions or clean up resources after the dialog has been dismissed. * @param event. The custom event. Custom event was created with: event.detail( target, item) * target - The window that is the target of the operation. * item - The toolbar item that is the target of the operation. */ onDialogClose: EventEmitter<CustomEvent>; /** @description This event is fired immediately before the Dialog Window begins to close. It provides an opportunity to execute custom logic or perform validation before the dialog is dismissed. The closure of the dialog can be canceled by calling event.preventDefault() within the event handler. * @param event. The custom event. Custom event was created with: event.detail( target, item) * target - The window that is the target of the operation. * item - The toolbar item that is the target of the operation. */ onDialogClosing: EventEmitter<CustomEvent>; /** @description This event is triggered when an image or video file has been uploaded successfully to the server. It indicates the completion of the upload process without errors, allowing you to perform additional actions such as displaying a success message or updating the user interface. * @param event. The custom event. Custom event was created with: event.detail( target, item, filename, type, size, index, status, serverResponse) * target - The file upload element that is the target of the operation. * item - The toolbar item that is the target of the operation. * filename - The name of the uploaded file. * type - The type of the uploaded file. * size - The size of the uploaded file. * index - The index of the uploaded file. * status - The status of the uploaded file. Whether there was an error or success. * serverResponse - The response of the remote server. */ onImageUploadSuccess: EventEmitter<CustomEvent>; /** @description This event is triggered when an attempt to upload an image or video fails, indicating that the file was not successfully transferred to the server due to an error or interruption during the upload process. * @param event. The custom event. Custom event was created with: event.detail( target, item, filename, type, size, index, status, serverResponse) * target - The file upload element that is the target of the operation. * item - The toolbar item that is the target of the operation. * filename - The name of the canceled file. * type - The type of the canceled file. * size - The size of the canceled file. * index - The index of the canceled file. * status - The status of the uploaded file. Whether there was an error or success. * serverResponse - The response of the remote server. */ onImageUploadFailed: EventEmitter<CustomEvent>; /** @description This event is triggered whenever a user clicks on an item within the Toolbar. It provides relevant information about the clicked item, allowing you to execute custom logic or actions in response to the user's interaction with the Toolbar. * @param event. The custom event. Custom event was created with: event.detail( originalEvent, value) * originalEvent - The original click event. * value - The name of the toolbar item that was clicked. */ onToobarItemClick: EventEmitter<CustomEvent>; /** @description This event is triggered whenever a user closes a message, such as dismissing a notification or alert. It allows you to execute custom logic in response to the message being removed from the user interface. * @param event. The custom event. Custom event was created with: event.detail( instance) * instance - The toast item that is the target of the operation. */ onMessageClose: EventEmitter<CustomEvent>; /** @description This event is triggered whenever a user opens or views a message, indicating that the message content has become visible or active in the user interface. It can be used to track message engagement, update message status, or initiate follow-up actions when a message is accessed. * @param event. The custom event. Custom event was created with: event.detail( instance) * instance - The toast item that is the target of the operation. */ onMessageOpen: EventEmitter<CustomEvent>; /** @description Integrates a custom item into the editor’s toolbar. **Example Usage:**```jseditor.addToolbarItem({ name: 'customButton2', // Unique identifier for the toolbar item width: 100, // Width of the toolbar item in pixels template: 'Button2' // Custom HTML template defining the toolbar item's appearance and content});```**Description:** This method allows you to add a new, customizable button or element to the editor’s toolbar. You specify a unique name, the width, and provide an HTML template for the item’s content. This enables the creation of tailored toolbar controls to enhance your editor’s functionality according to your application’s needs. * @param {any} itemName. The toolbar item to be added */ addToolbarItem(itemName: any): void; /** @description Applies a blur effect to the content area of the Editor, visually obscuring text and elements to reduce readability while maintaining overall layout and structure. This feature is useful for masking sensitive information or creating a focus effect within the Editor interface. */ blur(): void; /** @description Removes all text and formatting from the Editor, resetting its content to an empty state. */ clearContent(): void; /** @description Collapse the toolbar when the toolbarViewMode property is set to 'toggle'. This ensures that the toolbar is hidden or shown based on the toggle state, allowing for a dynamic and responsive user interface. */ collapseToolbar(): void; /** @description Prevents user interaction with the specified Toolbar item, making it inactive and visually indicating that it is disabled. The item remains visible but cannot be clicked or selected until re-enabled. * @param {string} itemName. The name of the toolbar item to disable. */ disableToolbarItem(itemName: string): void; /** @description Expands the Toolbar only when the toolbarViewMode property is set to 'toggle'. When this mode is active, the Toolbar will automatically display its full set of options and controls as specified. If toolbarViewMode is set to another value, this expansion behavior will not occur. */ expandToolbar(): void; /** @description Restores the functionality of a Toolbar item that was previously disabled, allowing users to click or interact with it again. This action visually updates the item to indicate it is active and accessible within the Toolbar interface. * @param {string} itemName. The name of the toolbar item to enable. */ enableToolbarItem(itemName: string): void; /** @description Enhances the clarity, consistency, and completeness of the description:---Executes a command using the native execCommand method to modify the contents or formatting of the editor. This method returns true if the command executes successfully or false otherwise. You can use this function to apply a wide range of editing and formatting commands to the currently selected content, or at the current cursor position.Supported commands include: bold: Toggles bold formatting on the selected text. Example: editor.executeCommand('bold'); italic: Toggles italic formatting on the selected text. Example: editor.executeCommand('italic'); underline: Toggles underline formatting on the selected text. Example: editor.executeCommand('underline'); strikeThrough: Toggles strikethrough formatting on the selected text. Example: editor.executeCommand('strikeThrough'); superscript: Sets the selected text as superscript. Example: editor.executeCommand('superscript'); subscript: Sets the selected text as subscript. Example: editor.executeCommand('subscript'); uppercase: Converts the selected text to uppercase. Example: editor.executeCommand('uppercas