@smart-webcomponents-angular/toast 19.0.8 → 25.5.5

package/toast/smart.toast.d.ts

@@ -14,106 +14,110 @@ export declare class ToastComponent extends BaseElement implements OnInit, After
      * @param properties An optional object of properties, which will be added to the template binded ones.
      */
     createComponent(properties?: {}): any;
-    /** @description Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
+    /** @description Sets or retrieves the animation mode for the component. When this property is set to 'none', all animations are disabled. Otherwise, specifying a valid animation mode enables corresponding transition effects. */
     get animation(): Animation | string;
     set animation(value: Animation | string);
-    /** @description Specifies the container where new openned toast items will be displayed. The value can be an HTMLElement or element's id. This property is in relation with modal(lower priority than modal) and position(higher priority than position) properties. */
+    /** @description Defines the container element in which new toast notifications will appear. The value can be either an HTMLElement directly, or a string representing the id of a DOM element. This property determines where toast items are rendered in the DOM.Note: When used together with the modal and position properties, container takes precedence over position but has lower priority than modal. This means that if modal is enabled, it overrides container; if not, the specified container is used instead of the position property. */
     get appendTo(): string;
     set appendTo(value: string);
-    /** @description Sets or gets whether the toast will automatically close after duration equal to the autoCloseDelay property. */
+    /** @description Determines whether the toast notification will automatically close after the duration specified by the autoCloseDelay property. If enabled, the toast will dismiss itself once the set time has elapsed; otherwise, it will remain visible until manually closed by the user. */
     get autoClose(): boolean;
     set autoClose(value: boolean);
-    /** @description Sets or gets the duration after which the toast automatically closes (works only if the autoClose property is set to true). */
+    /** @description Specifies or retrieves the time interval (in milliseconds) after which the toast notification will automatically dismiss itself. This property is effective only when the autoClose property is set to true; otherwise, the toast will remain visible until manually closed. */
     get autoCloseDelay(): number;
     set autoCloseDelay(value: number);
-    /** @description Sets whether the toast will open automatically immediately after widget's initialization. */
+    /** @description Determines whether the toast notification should automatically appear as soon as the widget is initialized, without requiring any user interaction or additional trigger. */
     get autoOpen(): boolean;
     set autoOpen(value: boolean);
-    /** @description The user will not be able to interact with toast items when disabled is set to true. */
+    /** @description When the disabled property is set to true, all user interactions with toast items—such as clicking, hovering, or dismissing—will be prevented. The toast items will appear inactive and will not respond to any user actions until disabled is set to false. */
     get disabled(): boolean;
     set disabled(value: boolean);
-    /** @description Sets custom icon className which overrides the default one. Multiple class names can be applied by separating them with a space. Useful when loading from a third-party icon library (such as Bootstrap). */
+    /** @description Specifies a custom CSS class name or multiple class names to override the default icon styling. To apply multiple classes, separate each class name with a space (e.g., "fa fa-user"). This property is particularly useful when integrating icons from third-party icon libraries like Bootstrap Icons, Font Awesome, or Material Icons, allowing you to fully control the icon's appearance by leveraging external style definitions. */
     get iconClass(): string;
     set iconClass(value: string);
-    /** @description Adds a custom class to Toast items. Multiple class names can be applied by separating them with a space. Useful when styling by using predefined class names from a third-party CSS library (such as Bootstrap). */
+    /** @description Allows you to add one or more custom CSS classes to Toast items by specifying class names separated with spaces. This enables you to style individual Toasts using predefined classes from third-party CSS frameworks (such as Bootstrap), or your own custom styles, for greater flexibility and consistency in appearance. */
     get itemClass(): string;
     set itemClass(value: string);
-    /** @description Sets custom item template. */
+    /** @description Defines a custom template for rendering each item, allowing you to control the appearance and structure of items displayed in the list or component. This enables the use of personalized HTML, styling, and dynamic content for each item, rather than relying on the default rendering format. */
     get itemTemplate(): string;
     set itemTemplate(value: string);
-    /** @description Sets or gets the language. Used in conjunction with the property messages.  */
+    /** @description Defines or retrieves the unlockKey, a unique value required to activate or gain access to the product’s features or content. */
+    get unlockKey(): string;
+    set unlockKey(value: string);
+    /** @description Specifies or retrieves the current language setting for localization purposes. This property determines which set of translations from the messages object is used, ensuring that the appropriate language-specific content is displayed or accessed. */
     get locale(): string;
     set locale(value: string);
-    /** @description Callback, related to localization module.  */
+    /** @description Callback function used by the localization module to handle language-specific operations, such as loading translation files, switching languages, or updating localized content dynamically within the application. */
     get localizeFormatFunction(): any;
     set localizeFormatFunction(value: any);
-    /** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.  */
+    /** @description Defines or retrieves an object containing customizable text strings used throughout the widget’s user interface, enabling localization and internationalization of displayed messages, labels, and prompts. Typically used alongside the locale property to support multiple languages and regional formats. This property allows developers to override default strings with translations or custom wording suitable for different locales. */
     get messages(): any;
     set messages(value: any);
-    /** @description In modal mode the toast item is positioned in the center of the screen. This property is with higher priority than position and appendTo. If modal is set to true these properties are disregarded. */
+    /** @description When modal mode is enabled, the toast notification is displayed at the center of the screen, overlaying all other page content. The modal property takes precedence over both the position and appendTo properties. If modal is set to true, any values specified for position and appendTo will be ignored, and the toast will always appear centered in a modal overlay. */
     get modal(): boolean;
     set modal(value: boolean);
-    /** @description Sets the part of the browser window where the toast will be positioned. The position property is disregarded if appendTo or modal are set. */
+    /** @description Specifies the area of the browser window where the toast notification will be displayed (for example, "top-right" or "bottom-center"). Note: This position setting is ignored if the appendTo property is defined or if modal mode is enabled, as these options control the toast’s placement instead. */
     get position(): ToastPosition | string;
     set position(value: ToastPosition | string);
-    /** @description If the element is readonly, users cannot interact with it. */
+    /** @description If the element has the "readonly" attribute, users cannot modify its value; the content is visible but cannot be changed or edited through user input. However, users may still be able to interact with the element in limited ways, such as copying its text, but any form of altering the value is disabled. */
     get readonly(): boolean;
     set readonly(value: boolean);
-    /** @description Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. */
+    /** @description Defines or retrieves a value that specifies whether the element's alignment is adjusted to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element's layout and text direction are modified to accommodate locales that use RTL scripts. */
     get rightToLeft(): boolean;
     set rightToLeft(value: boolean);
-    /** @description Sets or gets whether to show the toast item's close button. */
+    /** @description Determines whether the close button is displayed on the toast notification. When set to true, the close button appears, allowing users to manually dismiss the toast. When set to false, the close button is hidden, and the toast can only be dismissed programmatically or by other means. This property can be used to retrieve the current visibility state or update it as needed. */
     get showCloseButton(): boolean;
     set showCloseButton(value: boolean);
-    /** @description Determines the theme. Theme defines the look of the element */
+    /** @description Specifies the theme to be applied to the element. The selected theme controls the visual appearance of the element, including colors, fonts, and overall styling, ensuring a consistent look and feel throughout the user interface. */
     get theme(): string;
     set theme(value: string);
-    /** @description Sets speciffic CSS settings and icon to the toast items. */
+    /** @description Applies custom CSS styles and assigns a designated icon to each toast notification item for improved appearance and user experience. */
     get type(): ToastType | null | string;
     set type(value: ToastType | null | string);
-    /** @description If is set to true, the element cannot be focused. */
+    /** @description When set to true, this property prevents the element from receiving keyboard focus, making it inaccessible through keyboard navigation or programmatic focus methods (such as calling element.focus()). */
     get unfocusable(): boolean;
     set unfocusable(value: boolean);
-    /** @description Sets a text value to an toast item. */
+    /** @description Assigns a specific text value to the toast notification, determining the message displayed to users within the toast item. */
     get value(): any;
     set value(value: any);
-    /** @description This event is triggered when the toast item is clicked.
+    /** @description This event is triggered when a user clicks on a toast notification. It allows you to execute custom logic in response to the user's interaction with the toast item, such as redirecting to a specific page, dismissing the notification, or performing other actions.
     *  @param event. The custom event. 	*/
     onItemClick: EventEmitter<CustomEvent>;
-    /** @description This event is triggered when the toast item is closed.
+    /** @description This event is triggered whenever a toast notification is closed, either by user interaction (such as clicking the close button) or programmatically through code. It allows developers to execute custom logic or cleanup actions after the toast has been dismissed from the user interface.
     *  @param event. The custom event. 	*/
     onClose: EventEmitter<CustomEvent>;
-    /** @description This event is triggered when the toast item is opened.
+    /** @description This event is triggered each time a toast notification becomes visible to the user, indicating that the toast item has been fully opened and is now displayed on the screen.
     *  @param event. The custom event. 	*/
     onOpen: EventEmitter<CustomEvent>;
-    /** @description This event is triggered on swipebottom over an toast item.
+    /** @description This event is triggered when a user performs a swipe-down gesture (swipe bottom) on a toast notification item. It can be used to detect and handle user interactions that involve dismissing or interacting with toast messages via a downward swipe.
     *  @param event. The custom event. 	*/
     onSwipebottom: EventEmitter<CustomEvent>;
-    /** @description This event is triggered on swipeleft over an toast item.
+    /** @description This event is triggered when a user performs a swipe left gesture on a toast notification item. It allows you to execute custom actions in response to the swipe left interaction with the toast component.
     *  @param event. The custom event. 	*/
     onSwipeleft: EventEmitter<CustomEvent>;
-    /** @description This event is triggered on swiperight over an toast item.
+    /** @description This event is triggered when a user performs a swipe-right gesture on a toast notification item. It allows you to handle interactions that occur specifically when the user swipes right on a toast component.
     *  @param event. The custom event. 	*/
     onSwiperight: EventEmitter<CustomEvent>;
-    /** @description This event is triggered on swipetop over an toast item.
+    /** @description This event is triggered when a user performs an upward swipe gesture (swipe top) on a toast notification item.
     *  @param event. The custom event. 	*/
     onSwipetop: EventEmitter<CustomEvent>;
-    /** @description Closes all opened toast items.
+    /** @description Closes all currently displayed toast notifications, ensuring that any active toast messages are dismissed from the user interface.
     */
     closeAll(): void;
-    /** @description Closes particular toast item.
+    /** @description Closes a specific toast notification. This action targets and dismisses the designated toast message from the user interface, ensuring that only the selected toast item is removed without affecting others.
     * @param {HTMLElement | string} item. The toast item (or its id) to remove.
     */
     closeItem(item: HTMLElement | string): void;
-    /** @description Closes the last opened toast item.
+    /** @description Closes the most recently displayed toast notification, removing it from the user's view.
     */
     closeLast(): void;
-    /** @description Opens a new toast item and returns the opened smart-toast-item instance.
+    /** @description Displays a new toast notification and returns the corresponding smart-toast-item instance representing the newly created toast. This allows further manipulation or customization of the toast after it appears.
     * @param {HTMLElement | string} value?. The value for the toast item. If not set, the value property will be used.
     * @param {string} iconType?. The icon name for the toast item. If not set, the type property determines the icon type that will be used.
     * @returns {HTMLElement}
   */
     open(value?: any, iconType?: any): Promise<any>;
+    openSync(value?: any, iconType?: any): HTMLElement;
     get isRendered(): boolean;
     ngOnInit(): void;
     ngAfterViewInit(): void;
@@ -124,5 +128,5 @@ export declare class ToastComponent extends BaseElement implements OnInit, After
     /** @description Remove event listeners. */
     private unlisten;
     static ɵfac: i0.ɵɵFactoryDeclaration<ToastComponent, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ToastComponent, "smart-toast, [smart-toast]", ["smart-toast"], { "animation": "animation"; "appendTo": "appendTo"; "autoClose": "autoClose"; "autoCloseDelay": "autoCloseDelay"; "autoOpen": "autoOpen"; "disabled": "disabled"; "iconClass": "iconClass"; "itemClass": "itemClass"; "itemTemplate": "itemTemplate"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "modal": "modal"; "position": "position"; "readonly": "readonly"; "rightToLeft": "rightToLeft"; "showCloseButton": "showCloseButton"; "theme": "theme"; "type": "type"; "unfocusable": "unfocusable"; "value": "value"; }, { "onItemClick": "onItemClick"; "onClose": "onClose"; "onOpen": "onOpen"; "onSwipebottom": "onSwipebottom"; "onSwipeleft": "onSwipeleft"; "onSwiperight": "onSwiperight"; "onSwipetop": "onSwipetop"; }, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ToastComponent, "smart-toast, [smart-toast]", ["smart-toast"], { "animation": "animation"; "appendTo": "appendTo"; "autoClose": "autoClose"; "autoCloseDelay": "autoCloseDelay"; "autoOpen": "autoOpen"; "disabled": "disabled"; "iconClass": "iconClass"; "itemClass": "itemClass"; "itemTemplate": "itemTemplate"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "modal": "modal"; "position": "position"; "readonly": "readonly"; "rightToLeft": "rightToLeft"; "showCloseButton": "showCloseButton"; "theme": "theme"; "type": "type"; "unfocusable": "unfocusable"; "value": "value"; }, { "onItemClick": "onItemClick"; "onClose": "onClose"; "onOpen": "onOpen"; "onSwipebottom": "onSwipebottom"; "onSwipeleft": "onSwipeleft"; "onSwiperight": "onSwiperight"; "onSwipetop": "onSwipetop"; }, never>;
 }