ng-primitives 0.120.4 → 0.121.0

package/tooltip/index.d.ts

@@ -1,384 +0,0 @@
-import * as ng_primitives_portal from 'ng-primitives/portal';
-import { NgpOffset, NgpFlip, NgpShift, NgpOverlayArrowState, NgpOverlayArrowProps, NgpOverlayContent, NgpOffsetInput, NgpFlipInput, NgpShiftInput, NgpPosition, NgpOverlay } from 'ng-primitives/portal';
-export { NgpOverlayArrowProps as NgpTooltipArrowProps, NgpOverlayArrowState as NgpTooltipArrowState, injectOverlayContext as injectTooltipContext } from 'ng-primitives/portal';
-import * as _angular_core from '@angular/core';
-import { Provider, OnDestroy, Signal } from '@angular/core';
-import { Placement } from '@floating-ui/dom';
-import { NumberInput, BooleanInput } from '@angular/cdk/coercion';
-import * as ng_primitives_state from 'ng-primitives/state';
-
-interface NgpTooltipConfig {
-    /**
-     * Define the offset of the tooltip relative to the trigger.
-     * Can be a number (applies to mainAxis) or an object with mainAxis, crossAxis, and alignmentAxis.
-     * @default 4
-     */
-    offset: NgpOffset;
-    /**
-     * Define the placement of the tooltip relative to the trigger.
-     * @default 'top'
-     */
-    placement: Placement;
-    /**
-     * Define the delay before the tooltip is shown.
-     * @default 0
-     */
-    showDelay: number;
-    /**
-     * Define the delay before the tooltip is hidden.
-     * @default 500
-     */
-    hideDelay: number;
-    /**
-     * Define whether the tooltip should flip when there is not enough space for the tooltip.
-     * Can be a boolean to enable/disable, or an object with padding and fallbackPlacements options.
-     * @default true
-     */
-    flip: NgpFlip;
-    /**
-     * Define the container element or selector into which the tooltip should be attached.
-     * @default 'body'
-     */
-    container: HTMLElement | string | null;
-    /**
-     * Whether the tooltip should only show when the trigger element overflows.
-     * @default false
-     */
-    showOnOverflow: boolean;
-    /**
-     * Whether to use the text content of the trigger element as the tooltip content.
-     * @default true
-     */
-    useTextContent: boolean;
-    /**
-     * Configure shift behavior to keep the tooltip in view.
-     * Can be a boolean to enable/disable, or an object with padding and limiter options.
-     * @default undefined (enabled by default in overlay)
-     */
-    shift: NgpShift;
-    /**
-     * Whether to track the trigger element position on every animation frame.
-     * Useful for moving elements like slider thumbs.
-     * @default false
-     */
-    trackPosition: boolean;
-    /**
-     * Defines how the tooltip behaves when the window is scrolled.
-     * @default 'reposition'
-     */
-    scrollBehavior: 'reposition' | 'close';
-    /**
-     * Cooldown duration in milliseconds.
-     * When moving from one tooltip to another within this duration,
-     * the showDelay is skipped for the new tooltip.
-     * @default 300
-     */
-    cooldown: number;
-    /**
-     * Whether hovering the tooltip content keeps it open while moving from the trigger.
-     * @default false
-     */
-    hoverableContent: boolean;
-}
-/**
- * Provide the default Tooltip configuration
- * @param config The Tooltip configuration
- * @returns The provider
- */
-declare function provideTooltipConfig(config: Partial<NgpTooltipConfig>): Provider[];
-
-declare class NgpTooltipArrow {
-    /**
-     * Padding between the arrow and the edges of the tooltip.
-     * This prevents the arrow from overflowing the rounded corners.
-     */
-    readonly padding: _angular_core.InputSignalWithTransform<number | undefined, NumberInput>;
-    private readonly state;
-    /**
-     * Set the padding between the arrow and the edges of the tooltip.
-     * @param value The padding value in pixels
-     */
-    setPadding(value: number | undefined): void;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpTooltipArrow, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpTooltipArrow, "[ngpTooltipArrow]", ["ngpTooltipArrow"], { "padding": { "alias": "ngpTooltipArrowPadding"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-declare const NgpTooltipArrowStateToken: _angular_core.InjectionToken<_angular_core.WritableSignal<NgpOverlayArrowState>>;
-declare const ngpTooltipArrow: ({ padding }: NgpOverlayArrowProps) => NgpOverlayArrowState;
-declare const injectTooltipArrowState: {
-    (): _angular_core.Signal<NgpOverlayArrowState>;
-    (options: {
-        hoisted: true;
-        optional?: boolean;
-        skipSelf?: boolean;
-    }): _angular_core.Signal<NgpOverlayArrowState | null>;
-    (options?: {
-        hoisted?: boolean;
-        optional?: boolean;
-        skipSelf?: boolean;
-    }): _angular_core.Signal<NgpOverlayArrowState> | _angular_core.Signal<NgpOverlayArrowState | null>;
-};
-declare const provideTooltipArrowState: (opts?: {
-    inherit?: boolean;
-}) => _angular_core.FactoryProvider;
-
-type TooltipInput<T> = NgpOverlayContent<T> | string | null | undefined;
-/**
- * Apply the `ngpTooltipTrigger` directive to an element that triggers the tooltip to show.
- */
-declare class NgpTooltipTrigger<T = null> implements OnDestroy {
-    /**
-     * Maximum time allowed to cross from trigger to tooltip without pointer movement.
-     */
-    private static readonly HOVER_BRIDGE_TIMEOUT_MS;
-    /**
-     * Access the trigger element
-     */
-    private readonly trigger;
-    /**
-     * Access the injector.
-     */
-    private readonly injector;
-    /**
-     * Access the view container reference.
-     */
-    private readonly viewContainerRef;
-    /**
-     * Access the global tooltip configuration.
-     */
-    private readonly config;
-    /**
-     * Disposables for managing event listeners and timers with automatic teardown.
-     */
-    private readonly disposables;
-    /**
-     * Access the tooltip template ref.
-     */
-    readonly tooltip: _angular_core.InputSignalWithTransform<string | NgpOverlayContent<T> | null, TooltipInput<T>>;
-    /**
-     * Define if the trigger should be disabled. This will prevent the tooltip from being shown or hidden from interactions.
-     * @default false
-     */
-    readonly disabled: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Define the placement of the tooltip relative to the trigger.
-     * @default 'top'
-     */
-    readonly placement: _angular_core.InputSignal<NgpTooltipPlacement>;
-    /**
-     * Define the offset of the tooltip relative to the trigger.
-     * Can be a number (applies to mainAxis) or an object with mainAxis, crossAxis, and alignmentAxis.
-     * @default 0
-     */
-    readonly offset: _angular_core.InputSignalWithTransform<NgpOffset, NgpOffsetInput>;
-    /**
-     * Define the delay before the tooltip is displayed.
-     * @default 500
-     */
-    readonly showDelay: _angular_core.InputSignalWithTransform<number, NumberInput>;
-    /**
-     * Define the delay before the tooltip is hidden.
-     * @default 0
-     */
-    readonly hideDelay: _angular_core.InputSignalWithTransform<number, NumberInput>;
-    /**
-     * Define whether the tooltip should flip when there is not enough space for the tooltip.
-     * Can be a boolean to enable/disable, or an object with padding and fallbackPlacements options.
-     * @default true
-     */
-    readonly flip: _angular_core.InputSignalWithTransform<NgpFlip, NgpFlipInput>;
-    /**
-     * Configure shift behavior to keep the tooltip in view.
-     * Can be a boolean to enable/disable, or an object with padding and limiter options.
-     * @default undefined (enabled by default in overlay)
-     */
-    readonly shift: _angular_core.InputSignalWithTransform<NgpShift, NgpShiftInput>;
-    /**
-     * Define the container in which the tooltip should be attached.
-     * @default document.body
-     */
-    readonly container: _angular_core.InputSignal<string | HTMLElement | null>;
-    /**
-     * Define whether the tooltip should only show when the trigger element overflows.
-     * @default false
-     */
-    readonly showOnOverflow: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Define an anchor element for positioning the tooltip.
-     * If provided, the tooltip will be positioned relative to this element instead of the trigger.
-     */
-    readonly anchor: _angular_core.InputSignal<HTMLElement | null>;
-    /**
-     * Provide context to the tooltip. This can be used to pass data to the tooltip content.
-     */
-    readonly context: _angular_core.InputSignal<T | undefined>;
-    /**
-     * Define whether to use the text content of the trigger element as the tooltip content.
-     * When enabled, the tooltip will display the text content of the trigger element.
-     * @default true
-     */
-    readonly useTextContent: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Define whether to track the trigger element position on every animation frame.
-     * Useful for moving elements like slider thumbs.
-     * @default false
-     */
-    readonly trackPosition: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Programmatic position for the tooltip. When provided, the tooltip
-     * will be positioned at these coordinates instead of the trigger element.
-     * Use with trackPosition="true" for smooth cursor following.
-     */
-    readonly position: _angular_core.InputSignal<NgpPosition | null>;
-    /**
-     * Defines how the tooltip behaves when the window is scrolled.
-     * @default 'reposition'
-     */
-    readonly scrollBehavior: _angular_core.InputSignal<"reposition" | "close">;
-    /**
-     * Define the cooldown duration in milliseconds.
-     * When moving from one tooltip to another within this duration,
-     * the showDelay is skipped for the new tooltip.
-     * @default 300
-     */
-    readonly cooldown: _angular_core.InputSignalWithTransform<number, NumberInput>;
-    /**
-     * Whether hovering tooltip content keeps the tooltip open.
-     * @default false
-     */
-    readonly hoverableContent: _angular_core.InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * The overlay that manages the tooltip
-     * @internal
-     */
-    readonly overlay: _angular_core.WritableSignal<NgpOverlay<string | T> | null>;
-    /**
-     * The unique id of the tooltip.
-     */
-    readonly tooltipId: _angular_core.WritableSignal<string | undefined>;
-    /**
-     * The open state of the tooltip.
-     * @internal
-     */
-    readonly open: Signal<boolean>;
-    /**
-     * Determine if the trigger element has overflow.
-     */
-    private readonly hasOverflow;
-    /**
-     * Tracks whether pointer is currently over trigger.
-     */
-    private triggerHovered;
-    /**
-     * Tracks whether pointer is currently over tooltip content.
-     */
-    private contentHovered;
-    /**
-     * Current pointer grace polygon used while crossing trigger -> tooltip.
-     */
-    private hoverBridgePolygon;
-    /**
-     * Cleanup callback for the document pointermove listener.
-     */
-    private removePointerMoveListener?;
-    /**
-     * Cleanup callback for the hover bridge timeout.
-     */
-    private clearHoverBridgeTimeout?;
-    /**
-     * Store the state of the tooltip.
-     * @internal
-     */
-    readonly state: ng_primitives_state.CreatedState<NgpTooltipTrigger<T>>;
-    constructor();
-    ngOnDestroy(): void;
-    /**
-     * Show the tooltip programmatically (skips cooldown so multiple tooltips can coexist).
-     */
-    show(): void;
-    /**
-     * Hide the tooltip.
-     */
-    hide(): void;
-    /**
-     * Show the tooltip from an interaction (respects disabled state, uses cooldown).
-     * @internal
-     */
-    protected showFromInteraction(): void;
-    /**
-     * Shared show logic.
-     * @param skipCooldown When true, skip cooldown registration so multiple tooltips can coexist.
-     */
-    private performShow;
-    /**
-     * Hide the tooltip from an interaction (respects disabled state).
-     * @internal
-     */
-    protected hideFromInteraction(event?: MouseEvent): void;
-    /**
-     * Called by tooltip content when pointer enters the tooltip.
-     * @internal
-     */
-    onTooltipHoverStart(): void;
-    /**
-     * Called by tooltip content when pointer leaves the tooltip.
-     * @internal
-     */
-    onTooltipHoverEnd(): void;
-    /**
-     * Create the overlay that will contain the tooltip
-     */
-    private createOverlay;
-    /**
-     * Set the tooltip id.
-     */
-    setTooltipId(id: string): void;
-    /**
-     * Register document-level pointer tracking while crossing trigger -> tooltip.
-     */
-    private registerPointerMoveListener;
-    /**
-     * Clear hover bridge state and global listeners.
-     */
-    private clearHoverBridge;
-    /**
-     * Close if pointer leaves trigger and does not move into tooltip soon enough.
-     */
-    private scheduleHoverBridgeCloseFallback;
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpTooltipTrigger<any>, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpTooltipTrigger<any>, "[ngpTooltipTrigger]", ["ngpTooltipTrigger"], { "tooltip": { "alias": "ngpTooltipTrigger"; "required": false; "isSignal": true; }; "disabled": { "alias": "ngpTooltipTriggerDisabled"; "required": false; "isSignal": true; }; "placement": { "alias": "ngpTooltipTriggerPlacement"; "required": false; "isSignal": true; }; "offset": { "alias": "ngpTooltipTriggerOffset"; "required": false; "isSignal": true; }; "showDelay": { "alias": "ngpTooltipTriggerShowDelay"; "required": false; "isSignal": true; }; "hideDelay": { "alias": "ngpTooltipTriggerHideDelay"; "required": false; "isSignal": true; }; "flip": { "alias": "ngpTooltipTriggerFlip"; "required": false; "isSignal": true; }; "shift": { "alias": "ngpTooltipTriggerShift"; "required": false; "isSignal": true; }; "container": { "alias": "ngpTooltipTriggerContainer"; "required": false; "isSignal": true; }; "showOnOverflow": { "alias": "ngpTooltipTriggerShowOnOverflow"; "required": false; "isSignal": true; }; "anchor": { "alias": "ngpTooltipTriggerAnchor"; "required": false; "isSignal": true; }; "context": { "alias": "ngpTooltipTriggerContext"; "required": false; "isSignal": true; }; "useTextContent": { "alias": "ngpTooltipTriggerUseTextContent"; "required": false; "isSignal": true; }; "trackPosition": { "alias": "ngpTooltipTriggerTrackPosition"; "required": false; "isSignal": true; }; "position": { "alias": "ngpTooltipTriggerPosition"; "required": false; "isSignal": true; }; "scrollBehavior": { "alias": "ngpTooltipTriggerScrollBehavior"; "required": false; "isSignal": true; }; "cooldown": { "alias": "ngpTooltipTriggerCooldown"; "required": false; "isSignal": true; }; "hoverableContent": { "alias": "ngpTooltipTriggerHoverableContent"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-type NgpTooltipPlacement = 'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end';
-
-/**
- * Provides the TooltipTrigger state.
- */
-declare const provideTooltipTriggerState: (options?: ng_primitives_state.CreateStateProviderOptions) => _angular_core.FactoryProvider;
-/**
- * Injects the TooltipTrigger state.
- */
-declare const injectTooltipTriggerState: <U = NgpTooltipTrigger<unknown>>(injectOptions?: _angular_core.InjectOptions) => _angular_core.Signal<ng_primitives_state.State<U>>;
-
-/**
- * Apply the `ngpTooltip` directive to an element that represents the tooltip. This typically would be a `div` inside an `ng-template`.
- */
-declare class NgpTooltip {
-    /**
-     * Access the overlay.
-     */
-    protected readonly overlay: ng_primitives_portal.NgpOverlay<unknown>;
-    /**
-     * Access the tooltip trigger state.
-     */
-    private readonly tooltipTrigger;
-    /**
-     * The unique id of the tooltip.
-     */
-    readonly id: _angular_core.InputSignal<string>;
-    constructor();
-    static ɵfac: _angular_core.ɵɵFactoryDeclaration<NgpTooltip, never>;
-    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<NgpTooltip, "[ngpTooltip]", ["ngpTooltip"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
-}
-
-export { NgpTooltip, NgpTooltipArrow, NgpTooltipArrowStateToken, NgpTooltipTrigger, injectTooltipArrowState, injectTooltipTriggerState, ngpTooltipArrow, provideTooltipArrowState, provideTooltipConfig, provideTooltipTriggerState };
-export type { NgpTooltipConfig, NgpTooltipPlacement };