@gravionlabs/helix-core 22.1.1 → 22.1.3

package/types/gravionlabs-helix-core-tooltip.d.ts

@@ -1,12 +1,22 @@
-import * as _angular_core from '@angular/core';
-import { NgZone, TemplateRef, ViewContainerRef, SimpleChanges } from '@angular/core';
-import { TooltipOptions } from '@gravionlabs/helix-core/api';
-import { BaseComponent } from '@gravionlabs/helix-core/basecomponent';
-import { Nullable } from '@gravionlabs/helix-core/ts-helpers';
-import { TooltipPassThroughOptions, TooltipPassThrough } from '@gravionlabs/helix-core/types/tooltip';
-import { BaseStyle } from '@gravionlabs/helix-core/base';
-import * as i1 from '@gravionlabs/helix-core/bind';
-
+import * as i0 from "@angular/core";
+import { NgZone, SimpleChanges, TemplateRef, ViewContainerRef } from "@angular/core";
+import { TooltipOptions } from "@gravionlabs/helix-core/api";
+import { BaseComponent } from "@gravionlabs/helix-core/basecomponent";
+import { Nullable } from "@gravionlabs/helix-core/ts-helpers";
+import { TooltipPassThrough, TooltipPassThroughOptions } from "@gravionlabs/helix-core/types/tooltip";
+import { BaseStyle } from "@gravionlabs/helix-core/base";
+import * as i1 from "@gravionlabs/helix-core/bind";
+export declare class TooltipStyle extends BaseStyle {
+  name: string;
+  style: string;
+  classes: {
+    root: string;
+    arrow: string;
+    text: string;
+  };
+  static ɵfac: i0.ɵɵFactoryDeclaration<TooltipStyle, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
 /**
  *
  * Tooltip directive provides advisory information for a component.
@@ -16,258 +26,354 @@ import * as i1 from '@gravionlabs/helix-core/bind';
  * @module tooltipstyle
  *
  */
-declare enum TooltipClasses {
-    /**
-     * Class name of the root element
-     */
-    root = "h-tooltip",
-    /**
-     * Class name of the arrow element
-     */
-    arrow = "h-tooltip-arrow",
-    /**
-     * Class name of the text element
-     */
-    text = "h-tooltip-text"
-}
-declare class TooltipStyle extends BaseStyle {
-    name: string;
-    style: string;
-    classes: {
-        root: string;
-        arrow: string;
-        text: string;
-    };
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<TooltipStyle, never>;
-    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
-}
-interface TooltipStyle extends BaseStyle {
+export declare enum TooltipClasses {
+  /**
+   * Class name of the root element
+   */
+  root = "h-tooltip",
+  /**
+   * Class name of the arrow element
+   */
+  arrow = "h-tooltip-arrow",
+  /**
+   * Class name of the text element
+   */
+  text = "h-tooltip-text"
 }
-
+export interface TooltipStyle extends BaseStyle {}
 /**
  * Tooltip directive provides advisory information for a component.
  * @group Components
  */
-declare class Tooltip extends BaseComponent<TooltipPassThroughOptions> {
-    zone: NgZone;
-    private viewContainer;
-    componentName: string;
-    $pcTooltip: Tooltip | undefined;
-    /**
-     * Position of the tooltip.
-     * @group Props
-     */
-    readonly tooltipPosition: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Event to show the tooltip.
-     * @group Props
-     */
-    readonly tooltipEvent: _angular_core.InputSignal<"hover" | "focus" | "both">;
-    /**
-     * Type of CSS position.
-     * @group Props
-     */
-    readonly positionStyle: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Style class of the tooltip.
-     * @group Props
-     */
-    readonly tooltipStyleClass: _angular_core.InputSignal<string | undefined>;
-    /**
-     * Whether the z-index should be managed automatically to always go on top or have a fixed value.
-     * @group Props
-     */
-    readonly tooltipZIndex: _angular_core.InputSignal<string | undefined>;
-    /**
-     * By default the tooltip contents are rendered as text. Set to false to support html tags in the content.
-     * @group Props
-     */
-    readonly escape: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Delay to show the tooltip in milliseconds.
-     * @group Props
-     */
-    readonly showDelay: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * Delay to hide the tooltip in milliseconds.
-     * @group Props
-     */
-    readonly hideDelay: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * Time to wait in milliseconds to hide the tooltip even it is active.
-     * @group Props
-     */
-    readonly life: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * Specifies the additional vertical offset of the tooltip from its default position.
-     * @group Props
-     */
-    readonly positionTop: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * Specifies the additional horizontal offset of the tooltip from its default position.
-     * @group Props
-     */
-    readonly positionLeft: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
-    /**
-     * Whether to hide tooltip when hovering over tooltip content.
-     * @group Props
-     */
-    readonly autoHide: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Automatically adjusts the element position when there is not enough space on the selected position.
-     * @group Props
-     */
-    readonly fitContent: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Whether to hide tooltip on escape key press.
-     * @group Props
-     */
-    readonly hideOnEscape: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Whether to show the tooltip only when the target text overflows (e.g., ellipsis is active).
-     * @group Props
-     */
-    readonly showOnEllipsis: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Content of the tooltip.
-     * @group Props
-     */
-    readonly content: _angular_core.InputSignal<string | TemplateRef<HTMLElement> | undefined>;
-    /**
-     * When present, it specifies that the component should be disabled.
-     * @defaultValue false
-     * @group Props
-     */
-    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
-    /**
-     * Specifies the tooltip configuration options for the component.
-     * @group Props
-     */
-    readonly tooltipOptions: _angular_core.InputSignal<TooltipOptions | undefined>;
-    /**
-     * Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
-     * @defaultValue 'self'
-     * @group Props
-     */
-    appendTo: _angular_core.InputSignal<any>;
-    $appendTo: _angular_core.Signal<any>;
-    _tooltipOptions: {
-        tooltipLabel: null;
-        tooltipPosition: string;
-        tooltipEvent: string;
-        appendTo: string;
-        positionStyle: null;
-        tooltipStyleClass: null;
-        tooltipZIndex: string;
-        escape: boolean;
-        disabled: null;
-        showDelay: null;
-        hideDelay: null;
-        positionTop: null;
-        positionLeft: null;
-        life: null;
-        autoHide: boolean;
-        hideOnEscape: boolean;
-        showOnEllipsis: boolean;
-        id: string;
+export declare class Tooltip extends BaseComponent<TooltipPassThroughOptions> {
+  zone: NgZone;
+  private viewContainer;
+  componentName: string;
+  $pcTooltip: Tooltip | undefined;
+  /**
+   * Position of the tooltip.
+   * @group Props
+   */
+  readonly tooltipPosition: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Event to show the tooltip.
+   * @group Props
+   */
+  readonly tooltipEvent: import("@angular/core").InputSignal<"hover" | "focus" | "both">;
+  /**
+   * Type of CSS position.
+   * @group Props
+   */
+  readonly positionStyle: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Style class of the tooltip.
+   * @group Props
+   */
+  readonly tooltipStyleClass: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * Whether the z-index should be managed automatically to always go on top or have a fixed value.
+   * @group Props
+   */
+  readonly tooltipZIndex: import("@angular/core").InputSignal<string | undefined>;
+  /**
+   * By default the tooltip contents are rendered as text. Set to false to support html tags in the content.
+   * @group Props
+   */
+  readonly escape: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Delay to show the tooltip in milliseconds.
+   * @group Props
+   */
+  readonly showDelay: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
+  /**
+   * Delay to hide the tooltip in milliseconds.
+   * @group Props
+   */
+  readonly hideDelay: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
+  /**
+   * Time to wait in milliseconds to hide the tooltip even it is active.
+   * @group Props
+   */
+  readonly life: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
+  /**
+   * Specifies the additional vertical offset of the tooltip from its default position.
+   * @group Props
+   */
+  readonly positionTop: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
+  /**
+   * Specifies the additional horizontal offset of the tooltip from its default position.
+   * @group Props
+   */
+  readonly positionLeft: import("@angular/core").InputSignalWithTransform<number | undefined, unknown>;
+  /**
+   * Whether to hide tooltip when hovering over tooltip content.
+   * @group Props
+   */
+  readonly autoHide: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Automatically adjusts the element position when there is not enough space on the selected position.
+   * @group Props
+   */
+  readonly fitContent: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Whether to hide tooltip on escape key press.
+   * @group Props
+   */
+  readonly hideOnEscape: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Whether to show the tooltip only when the target text overflows (e.g., ellipsis is active).
+   * @group Props
+   */
+  readonly showOnEllipsis: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Content of the tooltip.
+   * @group Props
+   */
+  readonly content: import("@angular/core").InputSignal<string | TemplateRef<HTMLElement> | undefined>;
+  /**
+   * When present, it specifies that the component should be disabled.
+   * @defaultValue false
+   * @group Props
+   */
+  readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
+  /**
+   * Specifies the tooltip configuration options for the component.
+   * @group Props
+   */
+  readonly tooltipOptions: import("@angular/core").InputSignal<TooltipOptions | undefined>;
+  /**
+   * Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
+   * @defaultValue 'self'
+   * @group Props
+   */
+  appendTo: import("@angular/core").InputSignal<any>;
+  $appendTo: import("@angular/core").Signal<any>;
+  _tooltipOptions: {
+    tooltipLabel: null;
+    tooltipPosition: string;
+    tooltipEvent: string;
+    appendTo: string;
+    positionStyle: null;
+    tooltipStyleClass: null;
+    tooltipZIndex: string;
+    escape: boolean;
+    disabled: null;
+    showDelay: null;
+    hideDelay: null;
+    positionTop: null;
+    positionLeft: null;
+    life: null;
+    autoHide: boolean;
+    hideOnEscape: boolean;
+    showOnEllipsis: boolean;
+    id: string;
+  };
+  container: any;
+  styleClass: string | undefined;
+  tooltipText: any;
+  rootPTClasses: string;
+  showTimeout: any;
+  hideTimeout: any;
+  active: boolean | undefined;
+  mouseEnterListener: Nullable<Function>;
+  mouseLeaveListener: Nullable<Function>;
+  containerMouseleaveListener: Nullable<Function>;
+  clickListener: Nullable<Function>;
+  focusListener: Nullable<Function>;
+  blurListener: Nullable<Function>;
+  touchStartListener: Nullable<Function>;
+  touchEndListener: Nullable<Function>;
+  documentTouchListener: Nullable<Function>;
+  documentEscapeListener: Nullable<Function>;
+  scrollHandler: any;
+  resizeListener: any;
+  _componentStyle: TooltipStyle;
+  interactionInProgress: boolean;
+  /**
+   * Used to pass attributes to DOM elements inside the Tooltip component.
+   * @defaultValue undefined
+   * @deprecated use pTooltipPT instead.
+   * @group Props
+   */
+  ptTooltip: import("@angular/core").InputSignal<TooltipPassThrough>;
+  /**
+   * Used to pass attributes to DOM elements inside the Tooltip component.
+   * @defaultValue undefined
+   * @group Props
+   */
+  pTooltipPT: import("@angular/core").InputSignal<TooltipPassThrough>;
+  /**
+   * Indicates whether the component should be rendered without styles.
+   * @defaultValue undefined
+   * @group Props
+   */
+  pTooltipUnstyled: import("@angular/core").InputSignal<boolean | undefined>;
+  constructor(zone: NgZone, viewContainer: ViewContainerRef);
+  onAfterViewInit(): void;
+  onChanges(simpleChange: SimpleChanges): void;
+  isAutoHide(): boolean;
+  onMouseEnter(e: Event): void;
+  onMouseLeave(e: MouseEvent): void;
+  onTouchStart(e: TouchEvent): void;
+  onTouchEnd(e: TouchEvent): void;
+  bindDocumentTouchListener(): void;
+  unbindDocumentTouchListener(): void;
+  onFocus(e: Event): void;
+  onBlur(e: Event): void;
+  onInputClick(e: Event): void;
+  hasEllipsis(): boolean;
+  activate(): void;
+  deactivate(): void;
+  create(): void;
+  bindContainerMouseleaveListener(): void;
+  unbindContainerMouseleaveListener(): void;
+  show(): void;
+  hide(): void;
+  updateText(): void;
+  align(): void;
+  getHostOffset(): {
+    left: any;
+    top: any;
+  };
+  private get activeElement();
+  alignRight(): void;
+  alignLeft(): void;
+  alignTop(): void;
+  getArrowElement(): any;
+  alignBottom(): void;
+  alignTooltip(offsetLeft: any, offsetTop: any): void;
+  setOption(option: any): void;
+  getOption(option: string): any;
+  getTarget(el: Element): Element | null;
+  preAlign(position: string): void;
+  isOutOfBounds(): boolean;
+  onWindowResize(e: Event): void;
+  bindDocumentResizeListener(): void;
+  unbindDocumentResizeListener(): void;
+  bindScrollListener(): void;
+  unbindScrollListener(): void;
+  unbindEvents(): void;
+  remove(): void;
+  clearShowTimeout(): void;
+  clearHideTimeout(): void;
+  clearTimeouts(): void;
+  onDestroy(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<Tooltip, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<Tooltip, "[hTooltip]", never, {
+    "tooltipPosition": {
+      "alias": "tooltipPosition";
+      "required": false;
+      "isSignal": true;
     };
-    container: any;
-    styleClass: string | undefined;
-    tooltipText: any;
-    rootPTClasses: string;
-    showTimeout: any;
-    hideTimeout: any;
-    active: boolean | undefined;
-    mouseEnterListener: Nullable<Function>;
-    mouseLeaveListener: Nullable<Function>;
-    containerMouseleaveListener: Nullable<Function>;
-    clickListener: Nullable<Function>;
-    focusListener: Nullable<Function>;
-    blurListener: Nullable<Function>;
-    touchStartListener: Nullable<Function>;
-    touchEndListener: Nullable<Function>;
-    documentTouchListener: Nullable<Function>;
-    documentEscapeListener: Nullable<Function>;
-    scrollHandler: any;
-    resizeListener: any;
-    _componentStyle: TooltipStyle;
-    interactionInProgress: boolean;
-    /**
-     * Used to pass attributes to DOM elements inside the Tooltip component.
-     * @defaultValue undefined
-     * @deprecated use pTooltipPT instead.
-     * @group Props
-     */
-    ptTooltip: _angular_core.InputSignal<TooltipPassThrough>;
-    /**
-     * Used to pass attributes to DOM elements inside the Tooltip component.
-     * @defaultValue undefined
-     * @group Props
-     */
-    pTooltipPT: _angular_core.InputSignal<TooltipPassThrough>;
-    /**
-     * Indicates whether the component should be rendered without styles.
-     * @defaultValue undefined
-     * @group Props
-     */
-    pTooltipUnstyled: _angular_core.InputSignal<boolean | undefined>;
-    constructor(zone: NgZone, viewContainer: ViewContainerRef);
-    onAfterViewInit(): void;
-    onChanges(simpleChange: SimpleChanges): void;
-    isAutoHide(): boolean;
-    onMouseEnter(e: Event): void;
-    onMouseLeave(e: MouseEvent): void;
-    onTouchStart(e: TouchEvent): void;
-    onTouchEnd(e: TouchEvent): void;
-    bindDocumentTouchListener(): void;
-    unbindDocumentTouchListener(): void;
-    onFocus(e: Event): void;
-    onBlur(e: Event): void;
-    onInputClick(e: Event): void;
-    hasEllipsis(): boolean;
-    activate(): void;
-    deactivate(): void;
-    create(): void;
-    bindContainerMouseleaveListener(): void;
-    unbindContainerMouseleaveListener(): void;
-    show(): void;
-    hide(): void;
-    updateText(): void;
-    align(): void;
-    getHostOffset(): {
-        left: any;
-        top: any;
+    "tooltipEvent": {
+      "alias": "tooltipEvent";
+      "required": false;
+      "isSignal": true;
     };
-    private get activeElement();
-    alignRight(): void;
-    alignLeft(): void;
-    alignTop(): void;
-    getArrowElement(): any;
-    alignBottom(): void;
-    alignTooltip(offsetLeft: any, offsetTop: any): void;
-    setOption(option: any): void;
-    getOption(option: string): any;
-    getTarget(el: Element): Element | null;
-    preAlign(position: string): void;
-    isOutOfBounds(): boolean;
-    onWindowResize(e: Event): void;
-    bindDocumentResizeListener(): void;
-    unbindDocumentResizeListener(): void;
-    bindScrollListener(): void;
-    unbindScrollListener(): void;
-    unbindEvents(): void;
-    remove(): void;
-    clearShowTimeout(): void;
-    clearHideTimeout(): void;
-    clearTimeouts(): void;
-    onDestroy(): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Tooltip, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Tooltip, "[hTooltip]", never, { "tooltipPosition": { "alias": "tooltipPosition"; "required": false; "isSignal": true; }; "tooltipEvent": { "alias": "tooltipEvent"; "required": false; "isSignal": true; }; "positionStyle": { "alias": "positionStyle"; "required": false; "isSignal": true; }; "tooltipStyleClass": { "alias": "tooltipStyleClass"; "required": false; "isSignal": true; }; "tooltipZIndex": { "alias": "tooltipZIndex"; "required": false; "isSignal": true; }; "escape": { "alias": "escape"; "required": false; "isSignal": true; }; "showDelay": { "alias": "showDelay"; "required": false; "isSignal": true; }; "hideDelay": { "alias": "hideDelay"; "required": false; "isSignal": true; }; "life": { "alias": "life"; "required": false; "isSignal": true; }; "positionTop": { "alias": "positionTop"; "required": false; "isSignal": true; }; "positionLeft": { "alias": "positionLeft"; "required": false; "isSignal": true; }; "autoHide": { "alias": "autoHide"; "required": false; "isSignal": true; }; "fitContent": { "alias": "fitContent"; "required": false; "isSignal": true; }; "hideOnEscape": { "alias": "hideOnEscape"; "required": false; "isSignal": true; }; "showOnEllipsis": { "alias": "showOnEllipsis"; "required": false; "isSignal": true; }; "content": { "alias": "hTooltip"; "required": false; "isSignal": true; }; "disabled": { "alias": "tooltipDisabled"; "required": false; "isSignal": true; }; "tooltipOptions": { "alias": "tooltipOptions"; "required": false; "isSignal": true; }; "appendTo": { "alias": "appendTo"; "required": false; "isSignal": true; }; "ptTooltip": { "alias": "ptTooltip"; "required": false; "isSignal": true; }; "pTooltipPT": { "alias": "pTooltipPT"; "required": false; "isSignal": true; }; "pTooltipUnstyled": { "alias": "pTooltipUnstyled"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-declare class TooltipModule {
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<TooltipModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<TooltipModule, never, [typeof Tooltip, typeof i1.BindModule], [typeof Tooltip, typeof i1.BindModule]>;
-    static ɵinj: _angular_core.ɵɵInjectorDeclaration<TooltipModule>;
+    "positionStyle": {
+      "alias": "positionStyle";
+      "required": false;
+      "isSignal": true;
+    };
+    "tooltipStyleClass": {
+      "alias": "tooltipStyleClass";
+      "required": false;
+      "isSignal": true;
+    };
+    "tooltipZIndex": {
+      "alias": "tooltipZIndex";
+      "required": false;
+      "isSignal": true;
+    };
+    "escape": {
+      "alias": "escape";
+      "required": false;
+      "isSignal": true;
+    };
+    "showDelay": {
+      "alias": "showDelay";
+      "required": false;
+      "isSignal": true;
+    };
+    "hideDelay": {
+      "alias": "hideDelay";
+      "required": false;
+      "isSignal": true;
+    };
+    "life": {
+      "alias": "life";
+      "required": false;
+      "isSignal": true;
+    };
+    "positionTop": {
+      "alias": "positionTop";
+      "required": false;
+      "isSignal": true;
+    };
+    "positionLeft": {
+      "alias": "positionLeft";
+      "required": false;
+      "isSignal": true;
+    };
+    "autoHide": {
+      "alias": "autoHide";
+      "required": false;
+      "isSignal": true;
+    };
+    "fitContent": {
+      "alias": "fitContent";
+      "required": false;
+      "isSignal": true;
+    };
+    "hideOnEscape": {
+      "alias": "hideOnEscape";
+      "required": false;
+      "isSignal": true;
+    };
+    "showOnEllipsis": {
+      "alias": "showOnEllipsis";
+      "required": false;
+      "isSignal": true;
+    };
+    "content": {
+      "alias": "hTooltip";
+      "required": false;
+      "isSignal": true;
+    };
+    "disabled": {
+      "alias": "tooltipDisabled";
+      "required": false;
+      "isSignal": true;
+    };
+    "tooltipOptions": {
+      "alias": "tooltipOptions";
+      "required": false;
+      "isSignal": true;
+    };
+    "appendTo": {
+      "alias": "appendTo";
+      "required": false;
+      "isSignal": true;
+    };
+    "ptTooltip": {
+      "alias": "ptTooltip";
+      "required": false;
+      "isSignal": true;
+    };
+    "pTooltipPT": {
+      "alias": "pTooltipPT";
+      "required": false;
+      "isSignal": true;
+    };
+    "pTooltipUnstyled": {
+      "alias": "pTooltipUnstyled";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {}, never, never, true, never>;
 }
-
-export { Tooltip, TooltipClasses, TooltipModule, TooltipStyle };
+export declare class TooltipModule {
+  static ɵfac: i0.ɵɵFactoryDeclaration<TooltipModule, never>;
+  static ɵmod: i0.ɵɵNgModuleDeclaration<TooltipModule, never, [typeof Tooltip, typeof i1.BindModule], [typeof Tooltip, typeof i1.BindModule]>;
+  static ɵinj: i0.ɵɵInjectorDeclaration<TooltipModule>;
+}