@internetarchive/collection-browser 2.3.0 → 2.4.0

package/dist/src/tiles/hover/hover-pane-controller.d.ts

@@ -1,219 +1,219 @@
-import type { SortParam } from '@internetarchive/search-service';
-import { HTMLTemplateResult, nothing, ReactiveController, ReactiveControllerHost } from 'lit';
-import type { TileModel } from '../../models';
-import type { CollectionTitles } from '../../data-source/models';
-export interface HoverPaneProperties {
-    model?: TileModel;
-    baseNavigationUrl?: string;
-    baseImageUrl?: string;
-    loggedIn: boolean;
-    sortParam: SortParam | null;
-    collectionTitles?: CollectionTitles;
-}
-export interface HoverPaneControllerOptions {
-    offsetX?: number;
-    offsetY?: number;
-    enableLongPress?: boolean;
-    showDelay?: number;
-    hideDelay?: number;
-    longPressDelay?: number;
-    mobileBreakpoint?: number;
-}
-/** A common interface for providing a hover pane element. */
-export interface HoverPaneProviderInterface {
-    /** Returns the provider's currently rendered hover pane element. */
-    getHoverPane(): HTMLElement | undefined;
-    /** Returns properties that should be passed to the hover pane. */
-    getHoverPaneProps(): HoverPaneProperties;
-}
-export interface ToggleHoverPaneOptions {
-    coords: {
-        x: number;
-        y: number;
-    };
-    enableTouchBackdrop?: boolean;
-}
-/**
- * An interface for interacting with hover pane controllers (e.g.,
- * to retrieve their current hover pane template).
- */
-export interface HoverPaneControllerInterface extends ReactiveController {
-    /**
-     * Returns the hover pane template to render based on this controller's
-     * current state. The returned template may be `nothing` if the hover
-     * pane should not currently be rendered.
-     */
-    getTemplate(): HTMLTemplateResult | typeof nothing;
-    /**
-     * Requests to manually toggle the state of the hover pane.
-     * If the hover pane is already shown, it will begin fading out and then
-     * subsequently be hidden and removed. If the hover pane is already fading
-     * out or hidden, it will fade back in and be shown.
-     */
-    toggleHoverPane(options: ToggleHoverPaneOptions): void;
-}
-export declare class HoverPaneController implements HoverPaneControllerInterface {
-    /** The host element to which this controller should attach listeners */
-    private readonly host;
-    /**
-     * The hover pane element attached to this controller's host.
-     */
-    private hoverPane?;
-    /**
-     * The properties to be passed to the hover pane element
-     */
-    private hoverPaneProps?;
-    /**
-     * The breakpoint (in pixels) below which the mobile interface should be used.
-     */
-    private mobileBreakpoint?;
-    /**
-     * The number of horizontal pixels the hover pane should be offset from the
-     * pointer position.
-     */
-    private offsetX;
-    /**
-     * The number of vertical pixels the hover pane should be offset from the
-     * pointer position.
-     */
-    private offsetY;
-    /**
-     * The delay between the mouse idling within the host element and when the hover
-     * pane should begin fading in (in milliseconds).
-     */
-    private showDelay;
-    /**
-     * The delay between when the mouse leaves the host element and when the hover
-     * pane should begin fading out (in milliseconds).
-     */
-    private hideDelay;
-    /**
-     * The delay between when a touch event begins on the host element and when the
-     * hover pane should begin fading in (in milliseconds).
-     */
-    private longPressDelay;
-    /**
-     * Whether long press interactions should cause the hover pane to appear (when
-     * below the mobile breakpoint).
-     */
-    private enableLongPress;
-    /**
-     * Used to control the current state of this provider's hover pane.
-     *  - `'hidden'` => The hover pane is not present at all.
-     *  - `'shown'` => The hover pane is either fading in or fully visible.
-     *  - `'fading-out'` => The hover pane is fading out and about to be removed.
-     */
-    private hoverPaneState;
-    /** The timer ID for showing the hover pane */
-    private showTimer?;
-    /** The timer ID for hiding the hover pane */
-    private hideTimer?;
-    /** The timer ID for recognizing a long press event */
-    private longPressTimer?;
-    /**
-     * Whether the touch backdrop should currently be rendered irrespective of other touch
-     * interactions being enabled.
-     */
-    private forceTouchBackdrop;
-    /** A record of the last mouse position on the host element, for positioning the hover pane */
-    private lastPointerClientPos;
-    constructor(
-    /** The host element to which this controller should attach listeners */
-    host: ReactiveControllerHost & HoverPaneProviderInterface & HTMLElement, 
-    /** Options for adjusting the hover pane behavior (offsets, delays, etc.) */
-    options?: HoverPaneControllerOptions);
-    hostConnected(): void;
-    hostDisconnected(): void;
-    hostUpdated(): void;
-    /** @inheritdoc */
-    getTemplate(): HTMLTemplateResult | typeof nothing;
-    /** @inheritdoc */
-    toggleHoverPane(options: ToggleHoverPaneOptions): void;
-    /**
-     * Produces a template for the invisible touch capture backdrop that
-     * is used to cancel the hover pane on touch devices. We want any
-     * touch interaction on the backdrop to remove the hover pane, and
-     * we don't want to bubble up mouse events that would otherwise
-     * affect the state of the hover pane (e.g., fading it back in).
-     */
-    private get touchBackdropTemplate();
-    private get showTouchBackdrop();
-    /** Whether to use the mobile layout */
-    private get isMobileView();
-    private get isHoverEnabled();
-    private get isTouchEnabled();
-    /** Whether this controller should currently render its hover pane. */
-    private get shouldRenderHoverPane();
-    /**
-     * Returns the desired top/left offsets (in pixels) for this tile's hover pane.
-     * The desired offsets balance positioning the hover pane under the primary pointer
-     * while preventing it from flowing outside the viewport. The returned offsets are
-     * given relative to this tile's content box.
-     *
-     * These offsets are only valid if the hover pane is already rendered with its
-     * correct width and height. If the hover pane is not present, the returned offsets
-     * will simply represent the current pointer position.
-     */
-    private get hoverPaneDesiredOffsets();
-    /**
-     * Adds to the host element all the listeners necessary to make the
-     * hover pane functional.
-     */
-    private attachListeners;
-    /**
-     * Removes all the hover pane listeners from the host element.
-     */
-    private detachListeners;
-    /**
-     * Handler for the mouseenter event on the host element.
-     */
-    private handleMouseEnter;
-    /**
-     * Handler for the mousemove event on the host element.
-     * Aborts any pending hide/fade-out for the hover pane, and restarts the
-     * timer to show it.
-     */
-    private handleMouseMove;
-    /**
-     * Handler for the mouseleave event on the host element.
-     * Hides the hover pane if present, and aborts the timer for showing it.
-     */
-    private handleMouseLeave;
-    /**
-     * Handler for the touchstart event on the host element.
-     * Begins the timer for recognizing a long press event.
-     */
-    private handleTouchStart;
-    /**
-     * Handler for events that should cancel a pending long press event
-     * (touchmove, touchend, touchcancel). Aborts the timer for recognizing
-     * a long press.
-     */
-    private handleLongPressCancel;
-    /**
-     * Handler for the contextmenu event, which should be suppressed during
-     * mobile long-press events on the host element.
-     */
-    private handleContextMenu;
-    /**
-     * Immediately causes the hover pane to begin fading out, if it is present.
-     */
-    private handleBackdropInteraction;
-    /**
-     * Aborts and restarts the timer for showing the hover pane.
-     */
-    private restartShowHoverPaneTimer;
-    /**
-     * Causes this tile's hover pane to be rendered, positioned, and made visible.
-     */
-    private showHoverPane;
-    /**
-     * Causes this tile's hover pane to begin fading out and starts
-     * the timer for it to be removed.
-     */
-    private fadeOutHoverPane;
-    /**
-     * Positions the hover pane with the correct offsets.
-     */
-    private repositionHoverPane;
-}
+import type { SortParam } from '@internetarchive/search-service';
+import { HTMLTemplateResult, nothing, ReactiveController, ReactiveControllerHost } from 'lit';
+import type { TileModel } from '../../models';
+import type { CollectionTitles } from '../../data-source/models';
+export interface HoverPaneProperties {
+    model?: TileModel;
+    baseNavigationUrl?: string;
+    baseImageUrl?: string;
+    loggedIn: boolean;
+    sortParam: SortParam | null;
+    collectionTitles?: CollectionTitles;
+}
+export interface HoverPaneControllerOptions {
+    offsetX?: number;
+    offsetY?: number;
+    enableLongPress?: boolean;
+    showDelay?: number;
+    hideDelay?: number;
+    longPressDelay?: number;
+    mobileBreakpoint?: number;
+}
+/** A common interface for providing a hover pane element. */
+export interface HoverPaneProviderInterface {
+    /** Returns the provider's currently rendered hover pane element. */
+    getHoverPane(): HTMLElement | undefined;
+    /** Returns properties that should be passed to the hover pane. */
+    getHoverPaneProps(): HoverPaneProperties;
+}
+export interface ToggleHoverPaneOptions {
+    coords: {
+        x: number;
+        y: number;
+    };
+    enableTouchBackdrop?: boolean;
+}
+/**
+ * An interface for interacting with hover pane controllers (e.g.,
+ * to retrieve their current hover pane template).
+ */
+export interface HoverPaneControllerInterface extends ReactiveController {
+    /**
+     * Returns the hover pane template to render based on this controller's
+     * current state. The returned template may be `nothing` if the hover
+     * pane should not currently be rendered.
+     */
+    getTemplate(): HTMLTemplateResult | typeof nothing;
+    /**
+     * Requests to manually toggle the state of the hover pane.
+     * If the hover pane is already shown, it will begin fading out and then
+     * subsequently be hidden and removed. If the hover pane is already fading
+     * out or hidden, it will fade back in and be shown.
+     */
+    toggleHoverPane(options: ToggleHoverPaneOptions): void;
+}
+export declare class HoverPaneController implements HoverPaneControllerInterface {
+    /** The host element to which this controller should attach listeners */
+    private readonly host;
+    /**
+     * The hover pane element attached to this controller's host.
+     */
+    private hoverPane?;
+    /**
+     * The properties to be passed to the hover pane element
+     */
+    private hoverPaneProps?;
+    /**
+     * The breakpoint (in pixels) below which the mobile interface should be used.
+     */
+    private mobileBreakpoint?;
+    /**
+     * The number of horizontal pixels the hover pane should be offset from the
+     * pointer position.
+     */
+    private offsetX;
+    /**
+     * The number of vertical pixels the hover pane should be offset from the
+     * pointer position.
+     */
+    private offsetY;
+    /**
+     * The delay between the mouse idling within the host element and when the hover
+     * pane should begin fading in (in milliseconds).
+     */
+    private showDelay;
+    /**
+     * The delay between when the mouse leaves the host element and when the hover
+     * pane should begin fading out (in milliseconds).
+     */
+    private hideDelay;
+    /**
+     * The delay between when a touch event begins on the host element and when the
+     * hover pane should begin fading in (in milliseconds).
+     */
+    private longPressDelay;
+    /**
+     * Whether long press interactions should cause the hover pane to appear (when
+     * below the mobile breakpoint).
+     */
+    private enableLongPress;
+    /**
+     * Used to control the current state of this provider's hover pane.
+     *  - `'hidden'` => The hover pane is not present at all.
+     *  - `'shown'` => The hover pane is either fading in or fully visible.
+     *  - `'fading-out'` => The hover pane is fading out and about to be removed.
+     */
+    private hoverPaneState;
+    /** The timer ID for showing the hover pane */
+    private showTimer?;
+    /** The timer ID for hiding the hover pane */
+    private hideTimer?;
+    /** The timer ID for recognizing a long press event */
+    private longPressTimer?;
+    /**
+     * Whether the touch backdrop should currently be rendered irrespective of other touch
+     * interactions being enabled.
+     */
+    private forceTouchBackdrop;
+    /** A record of the last mouse position on the host element, for positioning the hover pane */
+    private lastPointerClientPos;
+    constructor(
+    /** The host element to which this controller should attach listeners */
+    host: ReactiveControllerHost & HoverPaneProviderInterface & HTMLElement, 
+    /** Options for adjusting the hover pane behavior (offsets, delays, etc.) */
+    options?: HoverPaneControllerOptions);
+    hostConnected(): void;
+    hostDisconnected(): void;
+    hostUpdated(): void;
+    /** @inheritdoc */
+    getTemplate(): HTMLTemplateResult | typeof nothing;
+    /** @inheritdoc */
+    toggleHoverPane(options: ToggleHoverPaneOptions): void;
+    /**
+     * Produces a template for the invisible touch capture backdrop that
+     * is used to cancel the hover pane on touch devices. We want any
+     * touch interaction on the backdrop to remove the hover pane, and
+     * we don't want to bubble up mouse events that would otherwise
+     * affect the state of the hover pane (e.g., fading it back in).
+     */
+    private get touchBackdropTemplate();
+    private get showTouchBackdrop();
+    /** Whether to use the mobile layout */
+    private get isMobileView();
+    private get isHoverEnabled();
+    private get isTouchEnabled();
+    /** Whether this controller should currently render its hover pane. */
+    private get shouldRenderHoverPane();
+    /**
+     * Returns the desired top/left offsets (in pixels) for this tile's hover pane.
+     * The desired offsets balance positioning the hover pane under the primary pointer
+     * while preventing it from flowing outside the viewport. The returned offsets are
+     * given relative to this tile's content box.
+     *
+     * These offsets are only valid if the hover pane is already rendered with its
+     * correct width and height. If the hover pane is not present, the returned offsets
+     * will simply represent the current pointer position.
+     */
+    private get hoverPaneDesiredOffsets();
+    /**
+     * Adds to the host element all the listeners necessary to make the
+     * hover pane functional.
+     */
+    private attachListeners;
+    /**
+     * Removes all the hover pane listeners from the host element.
+     */
+    private detachListeners;
+    /**
+     * Handler for the mouseenter event on the host element.
+     */
+    private handleMouseEnter;
+    /**
+     * Handler for the mousemove event on the host element.
+     * Aborts any pending hide/fade-out for the hover pane, and restarts the
+     * timer to show it.
+     */
+    private handleMouseMove;
+    /**
+     * Handler for the mouseleave event on the host element.
+     * Hides the hover pane if present, and aborts the timer for showing it.
+     */
+    private handleMouseLeave;
+    /**
+     * Handler for the touchstart event on the host element.
+     * Begins the timer for recognizing a long press event.
+     */
+    private handleTouchStart;
+    /**
+     * Handler for events that should cancel a pending long press event
+     * (touchmove, touchend, touchcancel). Aborts the timer for recognizing
+     * a long press.
+     */
+    private handleLongPressCancel;
+    /**
+     * Handler for the contextmenu event, which should be suppressed during
+     * mobile long-press events on the host element.
+     */
+    private handleContextMenu;
+    /**
+     * Immediately causes the hover pane to begin fading out, if it is present.
+     */
+    private handleBackdropInteraction;
+    /**
+     * Aborts and restarts the timer for showing the hover pane.
+     */
+    private restartShowHoverPaneTimer;
+    /**
+     * Causes this tile's hover pane to be rendered, positioned, and made visible.
+     */
+    private showHoverPane;
+    /**
+     * Causes this tile's hover pane to begin fading out and starts
+     * the timer for it to be removed.
+     */
+    private fadeOutHoverPane;
+    /**
+     * Positions the hover pane with the correct offsets.
+     */
+    private repositionHoverPane;
+}