primeng 16.0.0-rc.1 → 16.0.0

package/tooltip/tooltip.d.ts

@@ -1,25 +1,12 @@
-import { AfterViewInit, ChangeDetectorRef, ElementRef, NgZone, OnDestroy, Renderer2, SimpleChanges } from '@angular/core';
-import { PrimeNGConfig } from 'primeng/api';
+import { AfterViewInit, ChangeDetectorRef, ElementRef, NgZone, OnDestroy, Renderer2, SimpleChanges, TemplateRef } from '@angular/core';
+import { PrimeNGConfig, TooltipOptions } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
-export interface TooltipOptions {
-    tooltipLabel?: string;
-    tooltipPosition?: string;
-    tooltipEvent?: string;
-    appendTo?: any;
-    positionStyle?: string;
-    tooltipStyleClass?: string;
-    tooltipZIndex?: string;
-    escape?: boolean;
-    disabled?: boolean;
-    showDelay?: number;
-    hideDelay?: number;
-    positionTop?: number;
-    positionLeft?: number;
-    life?: number;
-    autoHide?: boolean;
-    hideOnEscape?: boolean;
-}
+/**
+ * Tooltip directive provides advisory information for a component.
+ * @group Components
+ */
 export declare class Tooltip implements AfterViewInit, OnDestroy {
     private platformId;
     el: ElementRef;
@@ -27,39 +14,129 @@ export declare class Tooltip implements AfterViewInit, OnDestroy {
     config: PrimeNGConfig;
     private renderer;
     private changeDetector;
-    tooltipPosition: string;
-    tooltipEvent: string;
-    appendTo: any;
-    positionStyle: string;
-    tooltipStyleClass: string;
-    tooltipZIndex: string;
+    /**
+     * Position of the tooltip.
+     * @group Props
+     */
+    tooltipPosition: 'right' | 'left' | 'top' | 'bottom' | undefined;
+    /**
+     * Event to show the tooltip.
+     * @group Props
+     */
+    tooltipEvent: 'hover' | 'focus' | string | any;
+    /**
+     *  Target element to attach the overlay, valid values are "body", "target" or a local ng-F 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).
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Type of CSS position.
+     * @group Props
+     */
+    positionStyle: string | undefined;
+    /**
+     * Style class of the tooltip.
+     * @group Props
+     */
+    tooltipStyleClass: string | undefined;
+    /**
+     * Whether the z-index should be managed automatically to always go on top or have a fixed value.
+     * @group Props
+     */
+    tooltipZIndex: string | undefined;
+    /**
+     * By default the tooltip contents are rendered as text. Set to false to support html tags in the content.
+     * @group Props
+     */
     escape: boolean;
-    showDelay: number;
-    hideDelay: number;
-    life: number;
-    positionTop: number;
-    positionLeft: number;
+    /**
+     * Delay to show the tooltip in milliseconds.
+     * @group Props
+     */
+    showDelay: number | undefined;
+    /**
+     * Delay to hide the tooltip in milliseconds.
+     * @group Props
+     */
+    hideDelay: number | undefined;
+    /**
+     * Time to wait in milliseconds to hide the tooltip even it is active.
+     * @group Props
+     */
+    life: number | undefined;
+    /**
+     * Specifies the additional vertical offset of the tooltip from its default position.
+     * @group Props
+     */
+    positionTop: number | undefined;
+    /**
+     * Specifies the additional horizontal offset of the tooltip from its default position.
+     * @group Props
+     */
+    positionLeft: number | undefined;
+    /**
+     * Whether to hide tooltip when hovering over tooltip content.
+     * @group Props
+     */
     autoHide: boolean;
+    /**
+     * Automatically adjusts the element position when there is not enough space on the selected position.
+     * @group Props
+     */
     fitContent: boolean;
+    /**
+     * Whether to hide tooltip on escape key press.
+     * @group Props
+     */
     hideOnEscape: boolean;
-    text: string;
+    /**
+     * Text of the tooltip.
+     * @group Props
+     */
+    text: string | undefined;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @defaultValue false
+     * @group Props
+     */
     get disabled(): boolean;
     set disabled(val: boolean);
-    tooltipOptions: TooltipOptions;
-    _tooltipOptions: TooltipOptions;
-    _disabled: boolean;
+    /**
+     * Specifies the tooltip configuration options for the component.
+     * @group Props
+     */
+    tooltipOptions: TooltipOptions | undefined;
+    _tooltipOptions: {
+        tooltipLabel: any;
+        tooltipPosition: string;
+        tooltipEvent: string;
+        appendTo: any;
+        positionStyle: any;
+        tooltipStyleClass: any;
+        tooltipZIndex: any;
+        escape: boolean;
+        disabled: any;
+        showDelay: any;
+        hideDelay: any;
+        positionTop: any;
+        positionLeft: any;
+        life: any;
+        autoHide: boolean;
+        hideOnEscape: boolean;
+    };
+    _disabled: boolean | undefined;
     container: any;
-    styleClass: string;
+    styleClass: string | undefined;
     tooltipText: any;
     showTimeout: any;
     hideTimeout: any;
-    active: boolean;
-    mouseEnterListener: Function;
-    mouseLeaveListener: Function;
-    containerMouseleaveListener: Function;
-    clickListener: Function;
-    focusListener: Function;
-    blurListener: Function;
+    active: boolean | undefined;
+    mouseEnterListener: Nullable<Function>;
+    mouseLeaveListener: Nullable<Function>;
+    containerMouseleaveListener: Nullable<Function>;
+    clickListener: Nullable<Function>;
+    focusListener: Nullable<Function>;
+    blurListener: Nullable<Function>;
     scrollHandler: any;
     resizeListener: any;
     constructor(platformId: any, el: ElementRef, zone: NgZone, config: PrimeNGConfig, renderer: Renderer2, changeDetector: ChangeDetectorRef);
@@ -67,7 +144,7 @@ export declare class Tooltip implements AfterViewInit, OnDestroy {
     ngOnChanges(simpleChange: SimpleChanges): void;
     isAutoHide(): boolean;
     onMouseEnter(e: Event): void;
-    onMouseLeave(e: any): void;
+    onMouseLeave(e: MouseEvent): void;
     onFocus(e: Event): void;
     onBlur(e: Event): void;
     onInputClick(e: Event): void;
@@ -89,9 +166,9 @@ export declare class Tooltip implements AfterViewInit, OnDestroy {
     alignLeft(): void;
     alignTop(): void;
     alignBottom(): void;
-    setOption(option: TooltipOptions): void;
+    setOption(option: any): void;
     getOption(option: string): any;
-    getTarget(el: any): any;
+    getTarget(el: Element): any;
     preAlign(position: string): void;
     isOutOfBounds(): boolean;
     onWindowResize(e: Event): void;

package/tree/public_api.d.ts

@@ -1 +1,2 @@
 export * from './tree';
+export * from './tree.interface';