@spectrum-web-components/overlay
Version:
An `<sp-overlay>` element is used to decorate content that you would like to present to your visitors as "overlaid" on the rest of the application. This includes dialogs (modal and not), pickers, tooltips, context menus, et al.
1,778 lines (1,777 loc) • 112 kB
JSON
{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "sp-overlay.js",
"declarations": [],
"exports": [
{
"kind": "custom-element-definition",
"name": "sp-overlay",
"declaration": {
"name": "Overlay",
"module": "/src/Overlay.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "overlay-trigger.js",
"declarations": [],
"exports": [
{
"kind": "custom-element-definition",
"name": "overlay-trigger",
"declaration": {
"name": "OverlayTrigger",
"module": "/src/OverlayTrigger.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "sync/overlay-trigger.js",
"declarations": [],
"exports": [
{
"kind": "js",
"name": "OverlayTrigger",
"declaration": {
"name": "OverlayTrigger",
"module": "sync/overlay-trigger.js"
}
},
{
"kind": "js",
"name": "OverlayOptionsV1",
"declaration": {
"name": "OverlayOptionsV1",
"module": "sync/overlay-trigger.js"
}
},
{
"kind": "js",
"name": "TriggerInteractions",
"declaration": {
"name": "TriggerInteractions",
"module": "sync/overlay-trigger.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/AbstractOverlay.js",
"declarations": [
{
"kind": "variable",
"name": "overlayTimer",
"default": "new OverlayTimer()"
},
{
"kind": "function",
"name": "noop",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "function",
"name": "guaranteedAllTransitionend",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "el",
"type": {
"text": "HTMLElement"
},
"description": "Target of the \"transition\" listeners."
},
{
"name": "action",
"type": {
"text": "Function"
},
"description": "Method to trigger the \"transition\"."
},
{
"name": "cb",
"type": {
"text": "Function"
},
"description": "Callback to trigger when the \"transition\" has ended."
}
],
"description": "Apply a \"transitionend\" listener to an element that may not transition but\nguarantee the callback will be fired either way."
},
{
"kind": "function",
"name": "nextFrame",
"return": {
"type": {
"text": "Promise<void>"
}
}
},
{
"kind": "class",
"description": "Abstract Overlay base class so that property tyings and imperative API\ninterfaces can be held separate from the actual class definition.",
"name": "AbstractOverlay",
"members": [
{
"kind": "method",
"name": "applyFocus",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "_targetOpenState",
"type": {
"text": "boolean"
}
},
{
"name": "_focusEl",
"type": {
"text": "HTMLElement | null"
}
}
]
},
{
"kind": "field",
"name": "delayed",
"type": {
"text": "boolean"
}
},
{
"kind": "field",
"name": "dialogEl",
"type": {
"text": "HTMLDialogElement & {\n showPopover(): void;\n hidePopover(): void;\n }"
}
},
{
"kind": "field",
"name": "disabled",
"type": {
"text": "boolean"
}
},
{
"kind": "field",
"name": "dispose",
"default": "noop"
},
{
"kind": "field",
"name": "elementResolver",
"type": {
"text": "ElementResolutionController"
},
"privacy": "protected"
},
{
"kind": "field",
"name": "_elementResolver",
"type": {
"text": "ElementResolutionController"
},
"privacy": "protected"
},
{
"kind": "method",
"name": "ensureOnDOM",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "_targetOpenState",
"type": {
"text": "boolean"
}
}
]
},
{
"kind": "field",
"name": "elements",
"type": {
"text": "OpenableElement[]"
}
},
{
"kind": "method",
"name": "makeTransition",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<HTMLElement | null>"
}
},
"parameters": [
{
"name": "_targetOpenState",
"type": {
"text": "boolean"
}
}
]
},
{
"kind": "method",
"name": "manageDelay",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<void>"
}
},
"parameters": [
{
"name": "_targetOpenState",
"type": {
"text": "boolean"
}
}
]
},
{
"kind": "method",
"name": "manageDialogOpen",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<void>"
}
}
},
{
"kind": "method",
"name": "managePopoverOpen",
"privacy": "protected",
"return": {
"type": {
"text": "Promise<void>"
}
}
},
{
"kind": "method",
"name": "managePosition",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "offset",
"type": {
"text": "number | [number, number]"
},
"privacy": "protected",
"default": "0"
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
}
},
{
"kind": "field",
"name": "placement",
"type": {
"text": "Placement | undefined"
}
},
{
"kind": "field",
"name": "placementController",
"type": {
"text": "PlacementController"
},
"privacy": "protected"
},
{
"kind": "field",
"name": "_placementController",
"type": {
"text": "PlacementController"
},
"privacy": "protected"
},
{
"kind": "field",
"name": "receivesFocus",
"type": {
"text": "'true' | 'false' | 'auto'"
}
},
{
"kind": "method",
"name": "requestSlottable",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "returnFocus",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "state",
"type": {
"text": "OverlayState"
}
},
{
"kind": "field",
"name": "_state",
"type": {
"text": "OverlayState"
},
"privacy": "protected"
},
{
"kind": "field",
"name": "triggerElement",
"type": {
"text": "HTMLElement | VirtualTrigger | null"
}
},
{
"kind": "field",
"name": "type",
"type": {
"text": "OverlayTypes"
}
},
{
"kind": "field",
"name": "willPreventClose",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "method",
"name": "manuallyKeepOpen",
"privacy": "public",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "open",
"privacy": "public",
"static": true,
"return": {
"type": {
"text": "Promise<() => void>"
}
},
"parameters": [
{
"name": "trigger",
"type": {
"text": "HTMLElement"
}
},
{
"name": "interaction",
"type": {
"text": "TriggerInteractionsV1"
}
},
{
"name": "content",
"type": {
"text": "HTMLElement"
}
},
{
"name": "optionsV1",
"type": {
"text": "OverlayOptionsV1"
}
}
],
"description": "Overloaded imperative API entry point that allows for both the pre-0.37.0\nargument signature as well as the post-0.37.0 signature. This allows for\nconsumers to continue to leverage it as they had been in previous releases\nwhile also surfacing the more feature-rich API that has been made available."
},
{
"kind": "method",
"name": "open",
"privacy": "public",
"static": true,
"return": {
"type": {
"text": "Promise<Overlay>"
}
},
"parameters": [
{
"name": "content",
"type": {
"text": "HTMLElement"
}
},
{
"name": "options",
"optional": true,
"type": {
"text": "OverlayOptions"
}
}
]
},
{
"kind": "method",
"name": "open",
"privacy": "public",
"static": true,
"return": {
"type": {
"text": "Promise<Overlay | (() => void)>"
}
},
"parameters": [
{
"name": "triggerOrContent",
"type": {
"text": "HTMLElement"
}
},
{
"name": "interactionOrOptions",
"type": {
"text": "| TriggerInteractionsV1\n | OverlayOptions\n | undefined"
}
},
{
"name": "content",
"optional": true,
"type": {
"text": "HTMLElement"
}
},
{
"name": "optionsV1",
"optional": true,
"type": {
"text": "OverlayOptionsV1"
}
}
]
},
{
"kind": "method",
"name": "applyOptions",
"static": true,
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "overlay",
"type": {
"text": "AbstractOverlay"
}
},
{
"name": "options",
"type": {
"text": "OverlayOptions"
}
}
]
}
],
"superclass": {
"name": "SpectrumElement",
"package": "@spectrum-web-components/base"
}
}
],
"exports": [
{
"kind": "js",
"name": "overlayTimer",
"declaration": {
"name": "overlayTimer",
"module": "src/AbstractOverlay.js"
}
},
{
"kind": "js",
"name": "noop",
"declaration": {
"name": "noop",
"module": "src/AbstractOverlay.js"
}
},
{
"kind": "js",
"name": "guaranteedAllTransitionend",
"declaration": {
"name": "guaranteedAllTransitionend",
"module": "src/AbstractOverlay.js"
}
},
{
"kind": "js",
"name": "nextFrame",
"declaration": {
"name": "nextFrame",
"module": "src/AbstractOverlay.js"
}
},
{
"kind": "js",
"name": "AbstractOverlay",
"declaration": {
"name": "AbstractOverlay",
"module": "src/AbstractOverlay.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/ClickController.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "ClickController",
"members": [
{
"kind": "field",
"name": "type",
"type": {
"text": "InteractionTypes"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "preventNextToggle",
"type": {
"text": "boolean"
},
"privacy": "private",
"default": "false",
"description": "An overlay with a `click` interaction should not close on click `triggerElement`.\nWhen a click is initiated (`pointerdown`), apply `preventNextToggle` when the\noverlay is `open` to prevent from toggling the overlay when the click event\npropagates later in the interaction."
},
{
"kind": "method",
"name": "handleClick",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handlePointerdown",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "init",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "abortController",
"type": {
"text": "AbortController"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "activelyOpening",
"type": {
"text": "boolean"
},
"readonly": true,
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "handleOverlayReady",
"type": {
"text": "(overlay: AbstractOverlay) => void | undefined"
},
"privacy": "private",
"default": "handleOverlayReady",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isLazilyOpen",
"type": {
"text": "boolean"
},
"privacy": "private",
"default": "false",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Set `open` against the associated Overlay lazily.",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "public",
"default": "overlay",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "_overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "private",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isPersistent",
"type": {
"text": "boolean"
},
"privacy": "protected",
"default": "!!isPersistent",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "prepareDescription",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "_",
"type": {
"text": "HTMLElement"
}
}
],
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "releaseDescription",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "shouldCompleteOpen",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "initOverlay",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "abort",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostConnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostDisconnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
}
],
"superclass": {
"name": "InteractionController",
"module": "/src/InteractionController.js"
}
}
],
"exports": [
{
"kind": "js",
"name": "ClickController",
"declaration": {
"name": "ClickController",
"module": "src/ClickController.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/HoverController.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "HoverController",
"members": [
{
"kind": "field",
"name": "type",
"type": {
"text": "InteractionTypes"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "elementIds",
"type": {
"text": "string[]"
},
"privacy": "private",
"default": "[]"
},
{
"kind": "field",
"name": "focusedin",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "field",
"name": "hoverTimeout",
"type": {
"text": "ReturnType<typeof setTimeout> | undefined"
},
"privacy": "private"
},
{
"kind": "field",
"name": "pointerentered",
"type": {
"text": "boolean"
},
"default": "false"
},
{
"kind": "method",
"name": "handleKeyup",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "event",
"type": {
"text": "KeyboardEvent"
}
}
]
},
{
"kind": "method",
"name": "handleTargetFocusin",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handleTargetFocusout",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handleTargetPointerenter",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handleTargetPointerleave",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handleHostPointerenter",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handleHostPointerleave",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "prepareDescription",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "_",
"type": {
"text": "HTMLElement"
}
}
],
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "prepareOverlayRelativeDescription",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "prepareContentRelativeDescription",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "doPointerleave",
"privacy": "protected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "init",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "initOverlay",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "removeSafariFocusRingClass",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "abortController",
"type": {
"text": "AbortController"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "activelyOpening",
"type": {
"text": "boolean"
},
"readonly": true,
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "handleOverlayReady",
"type": {
"text": "(overlay: AbstractOverlay) => void | undefined"
},
"privacy": "private",
"default": "handleOverlayReady",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isLazilyOpen",
"type": {
"text": "boolean"
},
"privacy": "private",
"default": "false",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Set `open` against the associated Overlay lazily.",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "public",
"default": "overlay",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "_overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "private",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isPersistent",
"type": {
"text": "boolean"
},
"privacy": "protected",
"default": "!!isPersistent",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "releaseDescription",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "shouldCompleteOpen",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "abort",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostConnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostDisconnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
}
],
"superclass": {
"name": "InteractionController",
"module": "/src/InteractionController.js"
}
}
],
"exports": [
{
"kind": "js",
"name": "HoverController",
"declaration": {
"name": "HoverController",
"module": "src/HoverController.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/InteractionController.js",
"declarations": [
{
"kind": "variable",
"name": "lastInteractionType"
},
{
"kind": "variable",
"name": "SAFARI_FOCUS_RING_CLASS",
"type": {
"text": "string"
},
"default": "'remove-focus-ring-safari-hack'"
},
{
"kind": "class",
"description": "",
"name": "InteractionController",
"members": [
{
"kind": "field",
"name": "abortController",
"type": {
"text": "AbortController"
}
},
{
"kind": "field",
"name": "activelyOpening",
"type": {
"text": "boolean"
},
"readonly": true
},
{
"kind": "field",
"name": "handleOverlayReady",
"type": {
"text": "(overlay: AbstractOverlay) => void | undefined"
},
"privacy": "private",
"default": "handleOverlayReady"
},
{
"kind": "field",
"name": "isLazilyOpen",
"type": {
"text": "boolean"
},
"privacy": "private",
"default": "false"
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Set `open` against the associated Overlay lazily."
},
{
"kind": "field",
"name": "overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "public",
"default": "overlay"
},
{
"kind": "field",
"name": "_overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "private"
},
{
"kind": "field",
"name": "isPersistent",
"type": {
"text": "boolean"
},
"privacy": "protected",
"default": "!!isPersistent"
},
{
"kind": "field",
"name": "type",
"type": {
"text": "InteractionTypes"
}
},
{
"kind": "method",
"name": "prepareDescription",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "_",
"type": {
"text": "HTMLElement"
}
}
]
},
{
"kind": "method",
"name": "releaseDescription",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "shouldCompleteOpen",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "init",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "initOverlay",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "abort",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "hostConnected",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "hostDisconnected",
"return": {
"type": {
"text": "void"
}
}
}
]
}
],
"exports": [
{
"kind": "js",
"name": "lastInteractionType",
"declaration": {
"name": "lastInteractionType",
"module": "src/InteractionController.js"
}
},
{
"kind": "js",
"name": "SAFARI_FOCUS_RING_CLASS",
"declaration": {
"name": "SAFARI_FOCUS_RING_CLASS",
"module": "src/InteractionController.js"
}
},
{
"kind": "js",
"name": "InteractionController",
"declaration": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/LongpressController.js",
"declarations": [
{
"kind": "variable",
"name": "LONGPRESS_INSTRUCTIONS",
"type": {
"text": "object"
},
"default": "{\n touch: 'Double tap and long press for additional options',\n keyboard: 'Press Space or Alt+Down Arrow for additional options',\n mouse: 'Click and hold for additional options',\n}"
},
{
"kind": "class",
"description": "",
"name": "LongpressController",
"members": [
{
"kind": "field",
"name": "type",
"type": {
"text": "InteractionTypes"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "activelyOpening",
"type": {
"text": "boolean"
},
"readonly": true,
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "longpressState",
"type": {
"text": "null | 'potential' | 'opening' | 'pressed'"
},
"privacy": "protected",
"default": "null"
},
{
"kind": "field",
"name": "releaseDescription",
"return": {
"type": {
"text": "void"
}
},
"default": "noop",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "timeout",
"type": {
"text": "ReturnType<typeof setTimeout>"
},
"privacy": "private"
},
{
"kind": "method",
"name": "handleLongpress",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "handlePointerdown",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "event",
"type": {
"text": "PointerEvent"
}
}
]
},
{
"kind": "field",
"name": "handlePointerup",
"privacy": "private"
},
{
"kind": "method",
"name": "handleKeydown",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "event",
"type": {
"text": "KeyboardEvent"
}
}
]
},
{
"kind": "method",
"name": "handleKeyup",
"privacy": "private",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "event",
"type": {
"text": "KeyboardEvent"
}
}
]
},
{
"kind": "method",
"name": "prepareDescription",
"return": {
"type": {
"text": "void"
}
},
"parameters": [
{
"name": "trigger",
"type": {
"text": "HTMLElement"
}
}
],
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "shouldCompleteOpen",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "init",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "abortController",
"type": {
"text": "AbortController"
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "handleOverlayReady",
"type": {
"text": "(overlay: AbstractOverlay) => void | undefined"
},
"privacy": "private",
"default": "handleOverlayReady",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isLazilyOpen",
"type": {
"text": "boolean"
},
"privacy": "private",
"default": "false",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "open",
"type": {
"text": "boolean"
},
"privacy": "public",
"description": "Set `open` against the associated Overlay lazily.",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "public",
"default": "overlay",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "_overlay",
"type": {
"text": "AbstractOverlay"
},
"privacy": "private",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "field",
"name": "isPersistent",
"type": {
"text": "boolean"
},
"privacy": "protected",
"default": "!!isPersistent",
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "initOverlay",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "abort",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostConnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",
"module": "src/InteractionController.js"
}
},
{
"kind": "method",
"name": "hostDisconnected",
"return": {
"type": {
"text": "void"
}
},
"inheritedFrom": {
"name": "InteractionController",