@tylertech/forge 3.0.0-next.14 → 3.0.0-next.16

package/esm/tooltip/tooltip-constants.d.ts

@@ -3,33 +3,56 @@
  * Copyright 2023 Tyler Technologies, Inc. 
  * License: Apache-2.0
  */
+import { PositionPlacement } from '../core/utils/position-utils';
+import { OverlayFlipState } from '../overlay/overlay-constants';
 export declare const TOOLTIP_CONSTANTS: {
     elementName: "forge-tooltip";
-    attributes: {
-        TEXT: string;
-        TARGET: string;
-        DELAY: string;
-        POSITION: string;
-        HOST: string;
-    };
-    classes: {
-        TOOLTIP: string;
-        TOOLTIP_OPEN: string;
-        TOOLTIP_TOP: string;
-        TOOLTIP_RIGHT: string;
-        TOOLTIP_BOTTOM: string;
-        TOOLTIP_LEFT: string;
+    observedAttributes: {
+        readonly ID: "id";
+        readonly OPEN: "open";
+        readonly TYPE: "type";
+        readonly ANCHOR: "anchor";
+        readonly TARGET: "target";
+        readonly PLACEMENT: "placement";
+        readonly POSITION: "position";
+        readonly DELAY: "delay";
+        readonly OFFSET: "offset";
+        readonly FLIP: "flip";
+        readonly BOUNDARY: "boundary";
+        readonly FALLBACK_PLACEMENTS: "fallback-placements";
+        readonly TRIGGER_TYPE: "trigger-type";
     };
-    selectors: {
-        HOST: string;
+    attributes: {
+        readonly ID: "id";
+        readonly OPEN: "open";
+        readonly TYPE: "type";
+        readonly ANCHOR: "anchor";
+        readonly TARGET: "target";
+        readonly PLACEMENT: "placement";
+        readonly POSITION: "position";
+        readonly DELAY: "delay";
+        readonly OFFSET: "offset";
+        readonly FLIP: "flip";
+        readonly BOUNDARY: "boundary";
+        readonly FALLBACK_PLACEMENTS: "fallback-placements";
+        readonly TRIGGER_TYPE: "trigger-type";
     };
     numbers: {
-        DEFAULT_DELAY: number;
-        LONGPRESS_THRESHOLD: number;
         LONGPRESS_VISIBILITY_DURATION: number;
     };
-    strings: {
-        DEFAULT_POSITION: string;
+    defaults: {
+        DELAY: number;
+        OFFSET: number;
+        FLIP: OverlayFlipState;
+        TYPE: TooltipType;
+        PLACEMENT: import("@floating-ui/utils").Placement;
+        TRIGGER_TYPES: TooltipTriggerType[];
+    };
+    selectors: {
+        readonly CONTENT: ".forge-tooltip";
+        readonly ARROW: ".arrow";
     };
 };
-export type TooltipBuilder = () => HTMLElement;
+export type TooltipType = 'presentation' | 'label' | 'description';
+export type TooltipPlacement = PositionPlacement;
+export type TooltipTriggerType = 'hover' | 'longpress' | 'focus';

package/esm/tooltip/tooltip-constants.js

@@ -5,37 +5,42 @@
  */
 import { COMPONENT_NAME_PREFIX } from '../constants';
 const elementName = `${COMPONENT_NAME_PREFIX}tooltip`;
-const attributes = {
-    TEXT: 'text',
+const observedAttributes = {
+    ID: 'id',
+    OPEN: 'open',
+    TYPE: 'type',
+    ANCHOR: 'anchor',
     TARGET: 'target',
-    DELAY: 'delay',
+    PLACEMENT: 'placement',
     POSITION: 'position',
-    HOST: 'forge-tooltip-host'
-};
-const classes = {
-    TOOLTIP: 'forge-tooltip',
-    TOOLTIP_OPEN: 'forge-tooltip--open',
-    TOOLTIP_TOP: 'forge-tooltip--top',
-    TOOLTIP_RIGHT: 'forge-tooltip--right',
-    TOOLTIP_BOTTOM: 'forge-tooltip--bottom',
-    TOOLTIP_LEFT: 'forge-tooltip--left'
-};
-const selectors = {
-    HOST: `[${attributes.HOST}]`
+    DELAY: 'delay',
+    OFFSET: 'offset',
+    FLIP: 'flip',
+    BOUNDARY: 'boundary',
+    FALLBACK_PLACEMENTS: 'fallback-placements',
+    TRIGGER_TYPE: 'trigger-type'
 };
+const attributes = Object.assign({}, observedAttributes);
 const numbers = {
-    DEFAULT_DELAY: 500,
-    LONGPRESS_THRESHOLD: 750,
     LONGPRESS_VISIBILITY_DURATION: 3000
 };
-const strings = {
-    DEFAULT_POSITION: 'right'
+const defaults = {
+    DELAY: 500,
+    OFFSET: 4,
+    FLIP: 'auto',
+    TYPE: 'presentation',
+    PLACEMENT: 'right',
+    TRIGGER_TYPES: ['hover']
+};
+const selectors = {
+    CONTENT: '.forge-tooltip',
+    ARROW: '.arrow'
 };
 export const TOOLTIP_CONSTANTS = {
     elementName,
+    observedAttributes,
     attributes,
-    classes,
-    selectors,
     numbers,
-    strings
+    defaults,
+    selectors
 };

package/esm/tooltip/tooltip-foundation.d.ts

@@ -5,101 +5,89 @@
  */
 import { ICustomElementFoundation } from '@tylertech/forge-core';
 import { ITooltipAdapter } from './tooltip-adapter';
-import { TooltipBuilder } from './tooltip-constants';
-import { PopupPlacement } from '../popup';
+import { TooltipPlacement, TooltipTriggerType, TooltipType } from './tooltip-constants';
+import { OverlayFlipState } from '../overlay/overlay-constants';
+import { PositionPlacement } from '../core/utils/position-utils';
 export interface ITooltipFoundation extends ICustomElementFoundation {
-    text: string;
-    builder: TooltipBuilder | undefined;
-    target: string;
-    delay: number;
-    position: PopupPlacement;
     open: boolean;
-    hide(): void;
-    tooltipElement: HTMLElement | null;
+    type: TooltipType;
+    placement: `${TooltipPlacement}`;
+    delay: number;
+    anchor: string;
+    anchorElement: HTMLElement | null;
+    offset: number;
+    flip: OverlayFlipState;
+    boundary: string | null;
+    boundaryElement: HTMLElement | null;
+    fallbackPlacements: PositionPlacement[] | null;
+    triggerType: TooltipTriggerType | TooltipTriggerType[];
+    syncTooltipAria(): void;
 }
-/**
- * The foundation class behind the tooltip component.
- */
-export declare class TooltipFoundation implements ITooltipFoundation {
+declare const BaseClass: import("../constants").AbstractConstructor<import("../core/mixins/interactions/longpress/with-longpress-listener").WithLongpressListenerContract> & import("../constants").MixinBase<object>;
+export declare class TooltipFoundation extends BaseClass implements ITooltipFoundation {
     private _adapter;
-    private static _tooltipIdentifier;
-    private _identifier;
-    private _text;
-    private _builder;
-    private _target;
+    private _open;
+    private _type;
+    private _anchor;
     private _delay;
-    private _position;
-    private _mouseOverTimeout;
-    private _isOpen;
-    private _touchTimeout;
-    private _mouseOverListener;
-    private _mouseOutListener;
-    private _touchStartListener;
-    private _touchEndListener;
+    private _placement;
+    private _offset;
+    private _flip;
+    private _boundary;
+    private _boundaryElement;
+    private _fallbackPlacements;
+    private _triggerTypes;
+    private _hoverStartListener;
+    private _hoverEndListener;
+    private _hoverTimeout;
+    private _focusListener;
+    private _blurListener;
+    private _longpressVisibilityTimeout;
     private _scrollListener;
-    private _clickListener;
     private _mouseDownListener;
     private _dragListener;
+    private _lightDismissListener;
     constructor(_adapter: ITooltipAdapter);
     initialize(): void;
-    disconnect(): void;
-    /**
-     * Generates the next available tooltip identifier.
-     */
-    private _getNextIdentifier;
-    /** Adds event listeners to the target element. */
-    private _addTargetListeners;
-    /**
-     * Removes the event listeners from the target element.
-     * @param targetElement The target element instance.
-     */
-    private _removeTargetListeners;
-    /**
-     * Handles the touchstart event on the target element to detect long press.
-     */
-    private _onTouchStart;
-    /**
-     * Handles the touchend event on the target element to cancel a long press action.
-     */
-    private _onTouchEnd;
-    private _clearTouchTimer;
-    /**
-     * Handles the mouseover event on the target element.
-     */
-    private _onMouseOver;
-    /**
-     * Handles the mouseout event on the target element.
-     */
-    private _onMouseOut;
-    /**
-     * Displays the tooltip.
-     */
+    destroy(): void;
+    syncTooltipAria(): void;
+    private _attachAnchorListeners;
+    private _detachAnchorListeners;
     private _show;
-    /**
-     * Hides the tooltip.
-     */
-    hide(): void;
-    /**
-     * Handles scrolling events when the tooltip is open.
-     */
-    private _onScroll;
-    private _targetInteracted;
-    /** Gets/sets the tooltip text. */
-    get text(): string;
-    set text(value: string);
-    /** Sets the tooltip builder function. */
-    get builder(): TooltipBuilder | undefined;
-    set builder(value: TooltipBuilder | undefined);
-    /** Gets/sets the target element CSS selector. */
-    get target(): string;
-    set target(value: string);
-    /** Gets/sets the interaction delay. */
+    private _hide;
+    private _attachDismissListeners;
+    private _detachDismissListeners;
+    private _onHoverStart;
+    private _onHoverEnd;
+    private _onFocus;
+    private _onBlur;
+    protected _onLongpress(): void;
+    protected _onLongpressEnd(evt: PointerEvent | TouchEvent): void;
+    private _onTryShow;
+    private _onTryHide;
+    get open(): boolean;
+    set open(value: boolean);
+    get type(): TooltipType;
+    set type(value: TooltipType);
+    get anchor(): string;
+    set anchor(value: string);
+    get anchorElement(): HTMLElement | null;
+    set anchorElement(element: HTMLElement | null);
     get delay(): number;
     set delay(value: number);
-    /** Gets/sets the tooltip position. */
-    get position(): PopupPlacement;
-    set position(value: PopupPlacement);
-    set open(value: boolean);
-    get open(): boolean;
-    get tooltipElement(): HTMLElement | null;
+    get placement(): TooltipPlacement;
+    set placement(value: TooltipPlacement);
+    get offset(): number;
+    set offset(value: number);
+    get flip(): OverlayFlipState;
+    set flip(value: OverlayFlipState);
+    get boundary(): string | null;
+    set boundary(value: string | null);
+    get boundaryElement(): HTMLElement | null;
+    set boundaryElement(element: HTMLElement | null);
+    get fallbackPlacements(): PositionPlacement[] | null;
+    set fallbackPlacements(value: PositionPlacement[] | null);
+    get triggerType(): TooltipTriggerType | TooltipTriggerType[];
+    set triggerType(value: TooltipTriggerType | TooltipTriggerType[]);
 }
+export {};