@anguless/angulux 22.0.0-rc.0

package/types/anguless-angulux-tooltip.d.ts

@@ -0,0 +1,284 @@
+import * as i0 from '@angular/core';
+import { NgZone, TemplateRef, ViewContainerRef, SimpleChanges } from '@angular/core';
+import { TooltipOptions } from '@anguless/angulux/api';
+import { BaseComponent } from '@anguless/angulux/basecomponent';
+import { Nullable } from '@anguless/angulux/ts-helpers';
+import { TooltipPassThroughOptions, TooltipPassThrough } from '@anguless/angulux/types/tooltip';
+import * as _anguless_angulux_styled from '@anguless/angulux-styled';
+import { BaseStyle } from '@anguless/angulux/base';
+import * as i1 from '@anguless/angulux/bind';
+
+/**
+ *
+ * Tooltip directive provides advisory information for a component.
+ *
+ * @module tooltipstyle
+ *
+ */
+declare enum TooltipClasses {
+    /**
+     * Class name of the root element
+     */
+    root = "p-tooltip",
+    /**
+     * Class name of the arrow element
+     */
+    arrow = "p-tooltip-arrow",
+    /**
+     * Class name of the text element
+     */
+    text = "p-tooltip-text"
+}
+declare class TooltipStyle extends BaseStyle {
+    name: string;
+    style: _anguless_angulux_styled.StyleType;
+    classes: {
+        root: string;
+        arrow: string;
+        text: string;
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipStyle, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TooltipStyle>;
+}
+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
+     */
+    tooltipPosition: 'right' | 'left' | 'top' | 'bottom' | string | undefined;
+    /**
+     * Event to show the tooltip.
+     * @group Props
+     */
+    tooltipEvent: 'hover' | 'focus' | 'both';
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Whether to show the tooltip only when the target text overflows (e.g., ellipsis is active).
+     * @group Props
+     */
+    showOnEllipsis: boolean;
+    /**
+     * Content of the tooltip.
+     * @group Props
+     */
+    content: string | TemplateRef<HTMLElement> | undefined;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @defaultValue false
+     * @group Props
+     */
+    get disabled(): boolean;
+    set disabled(val: boolean);
+    /**
+     * Specifies the tooltip configuration options for the component.
+     * @group Props
+     */
+    tooltipOptions: 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: i0.InputSignal<any>;
+    $appendTo: i0.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;
+    };
+    _disabled: boolean | undefined;
+    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: i0.InputSignal<TooltipPassThrough>;
+    /**
+     * Used to pass attributes to DOM elements inside the Tooltip component.
+     * @defaultValue undefined
+     * @group Props
+     */
+    pTooltipPT: i0.InputSignal<TooltipPassThrough>;
+    /**
+     * Indicates whether the component should be rendered without styles.
+     * @defaultValue undefined
+     * @group Props
+     */
+    pTooltipUnstyled: i0.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): never;
+    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, "[aglTooltip]", never, { "tooltipPosition": { "alias": "tooltipPosition"; "required": false; }; "tooltipEvent": { "alias": "tooltipEvent"; "required": false; }; "positionStyle": { "alias": "positionStyle"; "required": false; }; "tooltipStyleClass": { "alias": "tooltipStyleClass"; "required": false; }; "tooltipZIndex": { "alias": "tooltipZIndex"; "required": false; }; "escape": { "alias": "escape"; "required": false; }; "showDelay": { "alias": "showDelay"; "required": false; }; "hideDelay": { "alias": "hideDelay"; "required": false; }; "life": { "alias": "life"; "required": false; }; "positionTop": { "alias": "positionTop"; "required": false; }; "positionLeft": { "alias": "positionLeft"; "required": false; }; "autoHide": { "alias": "autoHide"; "required": false; }; "fitContent": { "alias": "fitContent"; "required": false; }; "hideOnEscape": { "alias": "hideOnEscape"; "required": false; }; "showOnEllipsis": { "alias": "showOnEllipsis"; "required": false; }; "content": { "alias": "aglTooltip"; "required": false; }; "disabled": { "alias": "tooltipDisabled"; "required": false; }; "tooltipOptions": { "alias": "tooltipOptions"; "required": false; }; "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>;
+    static ngAcceptInputType_escape: unknown;
+    static ngAcceptInputType_showDelay: unknown;
+    static ngAcceptInputType_hideDelay: unknown;
+    static ngAcceptInputType_life: unknown;
+    static ngAcceptInputType_positionTop: unknown;
+    static ngAcceptInputType_positionLeft: unknown;
+    static ngAcceptInputType_autoHide: unknown;
+    static ngAcceptInputType_fitContent: unknown;
+    static ngAcceptInputType_hideOnEscape: unknown;
+    static ngAcceptInputType_showOnEllipsis: unknown;
+}
+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>;
+}
+
+export { Tooltip, TooltipClasses, TooltipModule, TooltipStyle };