@spectrum-web-components/overlay 0.41.0 → 0.41.2

package/src/Overlay.d.ts

@@ -1,14 +1,19 @@
 import { PropertyValues, TemplateResult } from '@spectrum-web-components/base';
-import type { OpenableElement, OverlayState, OverlayTypes, Placement } from './overlay-types.js';
+import { ElementResolutionController } from '@spectrum-web-components/reactive-controllers/src/ElementResolution.js';
+import type { OpenableElement, OverlayState, OverlayTypes, Placement, TriggerInteraction } from './overlay-types.js';
 import { AbstractOverlay } from './AbstractOverlay.js';
 import { VirtualTrigger } from './VirtualTrigger.js';
 import { PlacementController } from './PlacementController.js';
-export declare const LONGPRESS_INSTRUCTIONS: {
-    touch: string;
-    keyboard: string;
-    mouse: string;
-};
+import { ClickController } from './ClickController.js';
+import { HoverController } from './HoverController.js';
+import { LongpressController } from './LongpressController.js';
+export { LONGPRESS_INSTRUCTIONS } from './LongpressController.js';
 declare let OverlayFeatures: typeof AbstractOverlay & import("./overlay-types.js").Constructor<import("@spectrum-web-components/base").SpectrumElement>;
+export declare const strategies: {
+    click: typeof ClickController;
+    longpress: typeof LongpressController;
+    hover: typeof HoverController;
+};
 /**
  * @element sp-overlay
  *
@@ -17,7 +22,6 @@ declare let OverlayFeatures: typeof AbstractOverlay & import("./overlay-types.js
  */
 export declare class Overlay extends OverlayFeatures {
     static styles: import("@spectrum-web-components/base").CSSResult[];
-    abortController: AbortController;
     /**
      * An Overlay that is `delayed` will wait until a warm-up period of 1000ms
      * has completed before opening. Once the warmup period has completed, all
@@ -42,9 +46,6 @@ export declare class Overlay extends OverlayFeatures {
     elements: OpenableElement[];
     parentOverlayToForceClose?: Overlay;
     private get hasNonVirtualTrigger();
-    protected longpressState: 'null' | 'potential' | 'opening' | 'pressed';
-    private longressTimeout;
-    private hoverTimeout?;
     /**
      * The `offset` property accepts either a single number, to
      * define the offset of the Overlay along the main axis from
@@ -53,7 +54,7 @@ export declare class Overlay extends OverlayFeatures {
      * when there is no trigger element.
      */
     offset: number | [number, number];
-    protected placementController: PlacementController;
+    protected get placementController(): PlacementController;
     /**
      * Whether the Overlay is projected onto the "top layer" or not.
      */
@@ -74,12 +75,11 @@ export declare class Overlay extends OverlayFeatures {
      *
      */
     receivesFocus: 'true' | 'false' | 'auto';
-    private releaseAriaDescribedby;
-    private releaseLongpressDescribedby;
     slotEl: HTMLSlotElement;
     get state(): OverlayState;
     set state(state: OverlayState);
     _state: OverlayState;
+    strategy?: ClickController | HoverController | LongpressController;
     tipPadding?: number;
     /**
      * An optional ID reference for the trigger element combined with the optional
@@ -95,57 +95,24 @@ export declare class Overlay extends OverlayFeatures {
     /**
      * The specific interaction to listen for on the `triggerElement` to open the overlay.
      */
-    triggerInteraction?: 'click' | 'longpress' | 'hover';
+    triggerInteraction?: TriggerInteraction;
     /**
      * Configures the open/close heuristics of the Overlay.
      * @type {"auto" | "hint" | "manual" | "modal" | "page"}
      */
     type: OverlayTypes;
     protected wasOpen: boolean;
-    private elementResolver;
+    protected get elementResolver(): ElementResolutionController;
     private get usesDialog();
     private get popoverValue();
     protected get requiresPosition(): boolean;
     protected managePosition(): void;
     protected managePopoverOpen(): Promise<void>;
     protected applyFocus(targetOpenState: boolean, focusEl: HTMLElement | null): Promise<void>;
+    protected returnFocus(): void;
     private closeOnFocusOut;
     protected manageOpen(oldOpen: boolean): Promise<void>;
-    protected unbindEvents(): void;
     protected bindEvents(): void;
-    protected bindClickEvents(triggerElement: HTMLElement): void;
-    protected bindLongpressEvents(triggerElement: HTMLElement): void;
-    protected bindHoverEvents(triggerElement: HTMLElement): void;
-    protected manageTriggerElement(triggerElement: HTMLElement | undefined): void;
-    private elementIds;
-    private prepareLongpressDescription;
-    private prepareAriaDescribedby;
-    private handlePointerdown;
-    private handlePointerup;
-    /**
-     * @private
-     */
-    protected handleKeydown: (event: KeyboardEvent) => void;
-    protected handleKeyup: (event: KeyboardEvent) => void;
-    /**
-     * An overlay with a `click` interaction should not close on click `triggerElement`.
-     * When a click is initiated (`pointerdown`), apply `preventNextToggle` when the
-     * overlay is `open` to prevent from toggling the overlay when the click event
-     * propagates later in the interaction.
-     */
-    private preventNextToggle;
-    protected handlePointerdownForClick: () => void;
-    protected handleClick: () => void;
-    private focusedin;
-    protected handleFocusin: () => void;
-    protected handleFocusout: () => void;
-    private pointerentered;
-    protected handlePointerenter: () => void;
-    protected handleOverlayPointerenter: () => void;
-    protected handlePointerleave: () => void;
-    protected handleOverlayPointerleave: () => void;
-    protected doPointerleave(): void;
-    protected handleLongpress: () => void;
     protected handleBeforetoggle(event: Event & {
         newState: string;
     }): void;
@@ -153,6 +120,7 @@ export declare class Overlay extends OverlayFeatures {
     manuallyKeepOpen(): void;
     protected handleSlotchange(): void;
     shouldPreventClose(): boolean;
+    protected requestSlottable(): void;
     willUpdate(changes: PropertyValues): void;
     protected updated(changes: PropertyValues): void;
     protected renderContent(): TemplateResult;
@@ -163,4 +131,3 @@ export declare class Overlay extends OverlayFeatures {
     connectedCallback(): void;
     disconnectedCallback(): void;
 }
-export {};