@smart-webcomponents-angular/tooltip 19.0.8 → 25.5.5

package/tooltip/smart.tooltip.d.ts

@@ -14,82 +14,85 @@ export declare class TooltipComponent extends BaseElement implements OnInit, Aft
      * @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 Allows you to specify or retrieve the current animation mode. Set this property to 'none' to disable all animations. When assigned other valid values, it enables the corresponding animation effects for the element or component. */
     get animation(): Animation | string;
     set animation(value: Animation | string);
-    /** @description Determines how to align the tooltip. */
+    /** @description Specifies the alignment of the tooltip relative to its target element, such as positioning it above, below, to the left, or to the right of the target. This setting controls where the tooltip appears in relation to the element it is associated with. */
     get align(): string;
     set align(value: string);
-    /** @description Gets or sets whether a tooltip's arrow will be shown. */
+    /** @description Determines whether the tooltip's arrow is displayed. Setting this property to true will show the arrow pointing to the anchor element, while setting it to false will hide the arrow. This enhances tooltip visibility and contextual association with the target element. */
     get arrow(): boolean;
     set arrow(value: boolean);
-    /** @description Sets the position of the arrow. */
+    /** @description Specifies the location or alignment of the arrow relative to its parent element, determining where the arrow will appear (such as top, bottom, left, right, or center) within the component or tooltip. */
     get arrowDirection(): TooltipArrowDirection | string;
     set arrowDirection(value: TooltipArrowDirection | string);
-    /** @description Gets or sets whether a tooltip's arrow will be shown. */
+    /** @description Determines whether the tooltip's arrow is displayed. When set to true, an arrow will appear pointing from the tooltip to its target element; when set to false, the tooltip will be shown without an arrow. This property can be used to customize the visual connection between the tooltip and its anchor element. */
     get delay(): number;
     set delay(value: number);
-    /** @description Enables or disables the tooltip. */
+    /** @description Controls whether the tooltip is displayed. When enabled, the tooltip appears when users hover over or interact with the associated element. When disabled, the tooltip is hidden and does not appear under any circumstances. */
     get disabled(): boolean;
     set disabled(value: boolean);
-    /** @description Sets an offset by X and Y. */
+    /** @description Specifies the horizontal (X) and vertical (Y) offset values, allowing you to adjust the position of an element relative to its original location. The X value shifts the element left or right, while the Y value moves it up or down. */
     get offset(): number[];
     set offset(value: number[]);
-    /** @description Sets or gets the language. Used in conjunction with the property messages.  */
+    /** @description Sets or retrieves the unlockKey used to grant access to the product. The unlockKey acts as an authorization token or code required to unlock and enable the product’s features. */
+    get unlockKey(): string;
+    set unlockKey(value: string);
+    /** @description Specifies or retrieves the current language setting. This property determines which set of localized messages from the messages property will be used. Changing this value updates the displayed content to match the selected language. */
     get locale(): string;
     set locale(value: string);
-    /** @description Callback, related to localization module.  */
+    /** @description Callback function associated with the localization module, typically invoked to handle language changes, region-specific formatting, or to update interface text based on the selected locale. */
     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 language.  */
+    /** @description Defines or retrieves an object containing the localized text strings used within the widget interface. This property allows you to customize the displayed text for different languages or regions, and works together with the language property to support localization and internationalization of the widget's UI elements. */
     get messages(): any;
     set messages(value: any);
-    /** @description Sets or gets the way of triggering the tooltip. */
+    /** @description Specifies or retrieves the method by which the tooltip is activated, such as on hover, focus, or click events. */
     get openMode(): TooltipOpenMode | string;
     set openMode(value: TooltipOpenMode | string);
-    /** @description Gets or sets the position of the tooltip. */
+    /** @description Specifies or retrieves the placement of the tooltip relative to its associated element. This determines where the tooltip appears, such as above, below, to the left, or to the right of the target element. */
     get position(): TooltipPosition | string;
     set position(value: TooltipPosition | string);
-    /** @description Sets the element which triggers the tooltip. */
+    /** @description Specifies the HTML element that will act as the trigger for displaying the tooltip. When the user interacts with this element (such as by hovering, focusing, or clicking—depending on configuration), the tooltip will appear. */
     get selector(): string | HTMLElement;
     set selector(value: string | HTMLElement);
-    /** @description Determines the theme. Theme defines the look of the element */
+    /** @description Specifies the theme applied to the element. The theme controls the element’s overall appearance, including colors, fonts, and stylistic details, ensuring a consistent visual presentation throughout the interface. */
     get theme(): string;
     set theme(value: string);
-    /** @description Sets custom tooltip template. */
+    /** @description Specifies a custom template for rendering the tooltip content, allowing you to define the layout, styling, and dynamic data displayed within the tooltip. */
     get tooltipTemplate(): any;
     set tooltipTemplate(value: any);
-    /** @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 such as the Tab key. */
     get unfocusable(): boolean;
     set unfocusable(value: boolean);
-    /** @description Sets or gets the widget's value. */
+    /** @description Gets the current value of the widget or sets a new value for the widget. This property allows you to retrieve the widget's existing value or update it programmatically. */
     get value(): string;
     set value(value: string);
-    /** @description Sets or gets the visibility of the tooltip. */
+    /** @description Controls whether the tooltip is visible or hidden. When set, this property determines if the tooltip is displayed to the user; when accessed, it returns the current visibility status of the tooltip. */
     get visible(): boolean;
     set visible(value: boolean);
-    /** @description This event is triggered when the tooltip is opened.
+    /** @description This event is triggered immediately when the tooltip becomes visible to the user, indicating that the tooltip has been successfully opened and is now displayed on the screen. This can be used to perform additional actions, such as loading content or tracking analytics, when a tooltip appears.
     *  @param event. The custom event. 	*/
     onOpen: EventEmitter<CustomEvent>;
-    /** @description This event is triggered before the tooltip is opened. The event can be prevented via event.preventDefault().
+    /** @description This event is dispatched immediately before the tooltip becomes visible to the user. By calling event.preventDefault() within the event handler, you can cancel the tooltip from opening, allowing you to implement custom logic or conditions before the tooltip is displayed.
     *  @param event. The custom event. 	*/
     onOpening: EventEmitter<CustomEvent>;
-    /** @description This event is triggered when the tooltip is closed.
+    /** @description This event is triggered immediately after the tooltip has been closed, either by user interaction or programmatically. It signals that the tooltip is no longer visible in the user interface and can be used to perform cleanup operations or update other components in response to the tooltip's dismissal.
     *  @param event. The custom event. 	*/
     onClose: EventEmitter<CustomEvent>;
-    /** @description This event is triggered before the tooltip is closed. The event can be prevented via event.preventDefault().
+    /** @description This event is fired immediately before the tooltip is about to close. It provides an opportunity to perform actions or validations before the tooltip is hidden. By calling event.preventDefault(), you can cancel the closing of the tooltip, keeping it visible until the action is allowed to proceed.
     *  @param event. The custom event. 	*/
     onClosing: EventEmitter<CustomEvent>;
-    /** @description Closes smart-tooltip.
+    /** @description Closes the smart-tooltip component, removing the tooltip from view and disabling any tooltip functionality associated with the target element.
     */
     close(): void;
-    /** @description Opens smart-tooltip.
+    /** @description Displays the smart-tooltip component, providing contextual information or guidance to the user when triggered.
     */
     open(): void;
-    /** @description Toggles smart-tooltip.
+    /** @description Enables or disables the smart-tooltip component, controlling whether tooltips are displayed or hidden for the specified elements. This toggle function allows developers to dynamically show or hide helpful tooltip information in the user interface based on user interaction or application state.
     */
     toggle(): void;
-    /** @description Clears the content of the Tooltip.
+    /** @description Removes all content currently displayed within the Tooltip, restoring it to an empty state and ensuring no text, HTML, or interactive elements remain visible.
     */
     clear(): void;
     get isRendered(): boolean;
@@ -102,5 +105,5 @@ export declare class TooltipComponent extends BaseElement implements OnInit, Aft
     /** @description Remove event listeners. */
     private unlisten;
     static ɵfac: i0.ɵɵFactoryDeclaration<TooltipComponent, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<TooltipComponent, "smart-tooltip, [smart-tooltip]", ["smart-tooltip"], { "animation": "animation"; "align": "align"; "arrow": "arrow"; "arrowDirection": "arrowDirection"; "delay": "delay"; "disabled": "disabled"; "offset": "offset"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "openMode": "openMode"; "position": "position"; "selector": "selector"; "theme": "theme"; "tooltipTemplate": "tooltipTemplate"; "unfocusable": "unfocusable"; "value": "value"; "visible": "visible"; }, { "onOpen": "onOpen"; "onOpening": "onOpening"; "onClose": "onClose"; "onClosing": "onClosing"; }, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<TooltipComponent, "smart-tooltip, [smart-tooltip]", ["smart-tooltip"], { "animation": "animation"; "align": "align"; "arrow": "arrow"; "arrowDirection": "arrowDirection"; "delay": "delay"; "disabled": "disabled"; "offset": "offset"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "openMode": "openMode"; "position": "position"; "selector": "selector"; "theme": "theme"; "tooltipTemplate": "tooltipTemplate"; "unfocusable": "unfocusable"; "value": "value"; "visible": "visible"; }, { "onOpen": "onOpen"; "onOpening": "onOpening"; "onClose": "onClose"; "onClosing": "onClosing"; }, never>;
 }