Class DeclarativePopupWidget

Base class for squatch-popup web-component

Example

window.createCustomElement('squatch-popup', DeclarativePopupWidget)
const widget = document.querySelector('squatch-popup') as DeclarativePopupWidget
widget.open()
widget.close()
widget.reload()

Hierarchy

default
- DeclarativePopupWidget

Index

Constructors

constructor

new DeclarativePopupWidget(): DeclarativePopupWidget
Returns DeclarativePopupWidget
Overrides DeclarativeWidget.constructor
- Defined in src/widgets/declarative/DeclarativeWidgets.ts:68

Properties

`Readonly` ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly` CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly` COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

`Readonly` DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly` DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly` DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly` DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

`Readonly` DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly` DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly` DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

`Readonly` ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

`Readonly` ENTITY_NODE

ENTITY_NODE: 6

`Readonly` ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

`Readonly` NOTATION_NODE

NOTATION_NODE: 12

`Readonly` PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

`Readonly` TEXT_NODE

TEXT_NODE: 3

node is a Text node.

accessKey

accessKey: string

MDN Reference

`Readonly` accessKeyLabel

accessKeyLabel: string

MDN Reference

analyticsApi

analyticsApi: default

Instance of AnalyticsApi

ariaAtomic

ariaAtomic: null | string

MDN Reference

ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

ariaBusy

ariaBusy: null | string

MDN Reference

ariaChecked

ariaChecked: null | string

MDN Reference

ariaColCount

ariaColCount: null | string

MDN Reference

ariaColIndex

ariaColIndex: null | string

MDN Reference

ariaColSpan

ariaColSpan: null | string

MDN Reference

ariaCurrent

ariaCurrent: null | string

MDN Reference

ariaDisabled

ariaDisabled: null | string

MDN Reference

ariaExpanded

ariaExpanded: null | string

MDN Reference

ariaHasPopup

ariaHasPopup: null | string

MDN Reference

ariaHidden

ariaHidden: null | string

MDN Reference

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

ariaLabel

ariaLabel: null | string

MDN Reference

ariaLevel

ariaLevel: null | string

MDN Reference

ariaLive

ariaLive: null | string

MDN Reference

ariaModal

ariaModal: null | string

MDN Reference

ariaMultiLine

ariaMultiLine: null | string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

ariaOrientation

ariaOrientation: null | string

MDN Reference

ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

ariaPosInSet

ariaPosInSet: null | string

MDN Reference

ariaPressed

ariaPressed: null | string

MDN Reference

ariaReadOnly

ariaReadOnly: null | string

MDN Reference

ariaRequired

ariaRequired: null | string

MDN Reference

ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

ariaRowCount

ariaRowCount: null | string

MDN Reference

ariaRowIndex

ariaRowIndex: null | string

MDN Reference

ariaRowSpan

ariaRowSpan: null | string

MDN Reference

ariaSelected

ariaSelected: null | string

MDN Reference

ariaSetSize

ariaSetSize: null | string

MDN Reference

ariaSort

ariaSort: null | string

MDN Reference

ariaValueMax

ariaValueMax: null | string

MDN Reference

ariaValueMin

ariaValueMin: null | string

MDN Reference

ariaValueNow

ariaValueNow: null | string

MDN Reference

ariaValueText

ariaValueText: null | string

MDN Reference

`Readonly` assignedSlot

assignedSlot: null | HTMLSlotElement

MDN Reference

`Readonly` attributeStyleMap

attributeStyleMap: StylePropertyMap

`Readonly` attributes

attributes: NamedNodeMap

MDN Reference

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

`Readonly` baseURI

baseURI: string

Returns node's node document's document base URL.

MDN Reference

`Readonly` childElementCount

childElementCount: number

MDN Reference

`Readonly` childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

`Readonly` children

children: HTMLCollection

Returns the child elements.

MDN Reference

`Readonly` classList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

`Readonly` clientHeight

clientHeight: number

MDN Reference

`Readonly` clientLeft

clientLeft: number

MDN Reference

`Readonly` clientTop

clientTop: number

MDN Reference

`Readonly` clientWidth

clientWidth: number

MDN Reference

config

config: undefined | DeclarativeConfigOptions

Configuration overrides

Default

window.squatchConfig

container

container: undefined | null | string | HTMLElement

Container element to contain the widget iframe

Default

this

contentEditable

contentEditable: string

MDN Reference

`Readonly` dataset

dataset: DOMStringMap

MDN Reference

dir

dir: string

MDN Reference

draggable

draggable: boolean

MDN Reference

element

element: undefined | HTMLElement

enterKeyHint

enterKeyHint: string

MDN Reference

`Readonly` firstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

`Readonly` firstElementChild

firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

MDN Reference

hidden

hidden: boolean

MDN Reference

hide

hide: (() => void) = ...

Type declaration

- (): void
- Calls close method of widgetInstance
  
  Returns void
  
  Throws
  Throws an Error if called before the widget has loaded

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

inert

inert: boolean

MDN Reference

innerHTML

innerHTML: string

MDN Reference

innerText

innerText: string

MDN Reference

inputMode

inputMode: string

MDN Reference

`Readonly` isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

`Readonly` isContentEditable

isContentEditable: boolean

MDN Reference

lang

lang: string

MDN Reference

`Readonly` lastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

`Readonly` lastElementChild

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

`Readonly` localName

localName: string

Returns the local name.

MDN Reference

locale

locale: undefined | string

Locale to render the widget in

`Readonly` namespaceURI

namespaceURI: null | string

Returns the namespace.

MDN Reference

`Readonly` nextElementSibling

nextElementSibling: null | Element

Returns the first following sibling that is an element, and null otherwise.

MDN Reference

`Readonly` nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

`Readonly` nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

`Readonly` nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

`Optional` nonce

nonce?: string

MDN Reference

`Readonly` offsetHeight

offsetHeight: number

MDN Reference

`Readonly` offsetLeft

offsetLeft: number

MDN Reference

`Readonly` offsetParent

offsetParent: null | Element

MDN Reference

`Readonly` offsetTop

offsetTop: number

MDN Reference

`Readonly` offsetWidth

offsetWidth: number

MDN Reference

onabort

onabort: null | ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: UIEvent
  Returns any

Param

The event.

MDN Reference

onanimationcancel

onanimationcancel: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationend

onanimationend: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationiteration

onanimationiteration: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onanimationstart

onanimationstart: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: AnimationEvent
  Returns any

onauxclick

onauxclick: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onbeforeinput

onbeforeinput: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: InputEvent
  Returns any

onblur

onblur: null | ((this, ev) => any)

Fires when the object loses the input focus.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FocusEvent
  Returns any

Param

The focus event.

MDN Reference

oncancel

oncancel: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncanplay

oncanplay: null | ((this, ev) => any)

Occurs when playback is possible, but would require further buffering.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

oncanplaythrough

oncanplaythrough: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onchange

onchange: null | ((this, ev) => any)

Fires when the contents of the object or selection have changed.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onclick

onclick: null | ((this, ev) => any)

Fires when the user clicks the left mouse button on the object

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onclose

onclose: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncontextmenu

oncontextmenu: null | ((this, ev) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

oncopy

oncopy: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: ClipboardEvent
  Returns any

oncuechange

oncuechange: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oncut

oncut: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: ClipboardEvent
  Returns any

ondblclick

ondblclick: null | ((this, ev) => any)

Fires when the user double-clicks the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

ondrag

ondrag: null | ((this, ev) => any)

Fires on the source object continuously during a drag operation.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The event.

MDN Reference

ondragend

ondragend: null | ((this, ev) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The event.

MDN Reference

ondragenter

ondragenter: null | ((this, ev) => any)

Fires on the target element when the user drags the object to a valid drop target.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The drag event.

MDN Reference

ondragleave

ondragleave: null | ((this, ev) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The drag event.

MDN Reference

ondragover

ondragover: null | ((this, ev) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The event.

MDN Reference

ondragstart

ondragstart: null | ((this, ev) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

Param

The event.

MDN Reference

ondrop

ondrop: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: DragEvent
  Returns any

ondurationchange

ondurationchange: null | ((this, ev) => any)

Occurs when the duration attribute is updated.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onemptied

onemptied: null | ((this, ev) => any)

Occurs when the media element is reset to its initial state.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onended

onended: null | ((this, ev) => any)

Occurs when the end of playback is reached.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event

MDN Reference

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param

The event.

MDN Reference

onfocus

onfocus: null | ((this, ev) => any)

Fires when the object receives focus.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FocusEvent
  Returns any

Param

The event.

MDN Reference

onformdata

onformdata: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: FormDataEvent
  Returns any

onfullscreenchange

onfullscreenchange: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: Element
  - ev: Event
  Returns any

onfullscreenerror

onfullscreenerror: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: Element
  - ev: Event
  Returns any

ongotpointercapture

ongotpointercapture: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

oninput

oninput: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

oninvalid

oninvalid: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onkeydown

onkeydown: null | ((this, ev) => any)

Fires when the user presses a key.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
  Returns any

Param

The keyboard event

MDN Reference

onkeypress

onkeypress: null | ((this, ev) => any)

Fires when the user presses an alphanumeric key.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
  Returns any

Param

The event.

Deprecated

MDN Reference

onkeyup

onkeyup: null | ((this, ev) => any)

Fires when the user releases a key.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: KeyboardEvent
  Returns any

Param

The keyboard event

MDN Reference

onload

onload: null | ((this, ev) => any)

Fires immediately after the browser loads the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onloadeddata

onloadeddata: null | ((this, ev) => any)

Occurs when media data is loaded at the current playback position.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onloadedmetadata

onloadedmetadata: null | ((this, ev) => any)

Occurs when the duration and dimensions of the media have been determined.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onloadstart

onloadstart: null | ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onlostpointercapture

onlostpointercapture: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onmousedown

onmousedown: null | ((this, ev) => any)

Fires when the user clicks the object with either mouse button.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onmouseenter

onmouseenter: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onmouseleave

onmouseleave: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

onmousemove

onmousemove: null | ((this, ev) => any)

Fires when the user moves the mouse over the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onmouseout

onmouseout: null | ((this, ev) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onmouseover

onmouseover: null | ((this, ev) => any)

Fires when the user moves the mouse pointer into the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onmouseup

onmouseup: null | ((this, ev) => any)

Fires when the user releases a mouse button while the mouse is over the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: MouseEvent
  Returns any

Param

The mouse event.

MDN Reference

onpaste

onpaste: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: ClipboardEvent
  Returns any

onpause

onpause: null | ((this, ev) => any)

Occurs when playback is paused.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onplay

onplay: null | ((this, ev) => any)

Occurs when the play method is requested.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onplaying

onplaying: null | ((this, ev) => any)

Occurs when the audio or video has started playing.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onpointercancel

onpointercancel: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerdown

onpointerdown: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerenter

onpointerenter: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerleave

onpointerleave: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointermove

onpointermove: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerout

onpointerout: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerover

onpointerover: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onpointerup

onpointerup: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: PointerEvent
  Returns any

onprogress

onprogress: null | ((this, ev) => any)

Occurs to indicate progress while downloading media data.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: ProgressEvent<EventTarget>
  Returns any

Param

The event.

MDN Reference

onratechange

onratechange: null | ((this, ev) => any)

Occurs when the playback rate is increased or decreased.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onreset

onreset: null | ((this, ev) => any)

Fires when the user resets a form.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onresize

onresize: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: UIEvent
  Returns any

onscroll

onscroll: null | ((this, ev) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onsecuritypolicyviolation

onsecuritypolicyviolation: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: SecurityPolicyViolationEvent
  Returns any

onseeked

onseeked: null | ((this, ev) => any)

Occurs when the seek operation ends.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onseeking

onseeking: null | ((this, ev) => any)

Occurs when the current playback position is moved.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onselect

onselect: null | ((this, ev) => any)

Fires when the current selection changes.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onselectionchange

onselectionchange: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onselectstart

onselectstart: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onslotchange

onslotchange: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

onstalled

onstalled: null | ((this, ev) => any)

Occurs when the download has stopped.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onsubmit

onsubmit: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: SubmitEvent
  Returns any

onsuspend

onsuspend: null | ((this, ev) => any)

Occurs if the load operation has been intentionally halted.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

ontimeupdate

ontimeupdate: null | ((this, ev) => any)

Occurs to indicate the current playback position.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

ontoggle

ontoggle: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

`Optional` ontouchcancel

ontouchcancel?: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchend

ontouchend?: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchmove

ontouchmove?: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

`Optional` ontouchstart

ontouchstart?: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TouchEvent
  Returns any

ontransitioncancel

ontransitioncancel: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionend

ontransitionend: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionrun

ontransitionrun: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

ontransitionstart

ontransitionstart: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: TransitionEvent
  Returns any

onvolumechange

onvolumechange: null | ((this, ev) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onwaiting

onwaiting: null | ((this, ev) => any)

Occurs when playback stops because the next frame of a video resource is not available.

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Param

The event.

MDN Reference

onwebkitanimationend

onwebkitanimationend: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

onwebkitanimationiteration: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

onwebkitanimationstart: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

onwebkittransitionend: null | ((this, ev) => any)

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: Event
  Returns any

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

onwheel: null | ((this, ev) => any)

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: GlobalEventHandlers
  - ev: WheelEvent
  Returns any

outerHTML

outerHTML: string

MDN Reference

outerText

outerText: string

MDN Reference

`Readonly` ownerDocument

ownerDocument: Document

`Readonly` parentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

`Readonly` parentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

`Readonly` part

part: DOMTokenList

MDN Reference

`Readonly` prefix

prefix: null | string

Returns the namespace prefix.

MDN Reference

`Readonly` previousElementSibling

previousElementSibling: null | Element

Returns the first preceding sibling that is an element, and null otherwise.

MDN Reference

`Readonly` previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

reload

reload: (() => Promise<void>) = ...

Type declaration

- (): Promise<void>
- Calls getWidgetInstance to build the Widget instance and loads the widget iframe into the DOM
  
  Returns Promise<void>

role

role: null | string

`Readonly` scrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

`Readonly` scrollWidth

scrollWidth: number

MDN Reference

`Readonly` shadowRoot

shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

show

show: (() => void) = ...

Type declaration

- (): void
- Calls open method of widgetInstance
  
  Returns void
  
  Throws
  Throws an Error if called before the widget has loaded

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

spellcheck

spellcheck: boolean

MDN Reference

`Readonly` style

style: CSSStyleDeclaration

MDN Reference

tabIndex

tabIndex: number

MDN Reference

`Readonly` tagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

tenant

tenant: undefined | string

Tenant alias of SaaSquatch tenant

Default

window.squatchTenant

textContent

textContent: null | string

MDN Reference

title

title: string

MDN Reference

token

token: undefined | string

Signed JWT containing user information

Default

window.squatchToken

translate

translate: boolean

type

type: "POPUP" | "EMBED"

Determines whether to render the widget as an embedding widget or popup widget

widgetApi

widgetApi: WidgetApi

Instance of WidgetApi

widgetInstance

widgetInstance: EmbedWidget | PopupWidget

Instance of EmbedWidget or PopupWidget

widgetType

widgetType: undefined | string

widgetType of widget to load

Accessors

`Static` observedAttributes

get observedAttributes(): string[]
Returns string[]
- Defined in src/widgets/declarative/DeclarativeWidgets.ts:85

Methods

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: HTMLElement
      
      ev: HTMLElementEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from DeclarativeWidget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10044
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from DeclarativeWidget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10045

after

after(...nodes): void
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.after
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5555

animate

animate(keyframes, options?): Animation
MDN Reference
Parameters
- keyframes: null | PropertyIndexedKeyframes | Keyframe[]
- Optional options: number | KeyframeAnimationOptions
Returns Animation
Inherited from DeclarativeWidget.animate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2398

append

append(...nodes): void
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.append
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16729

appendChild

appendChild<T>(node): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
Returns T
Inherited from DeclarativeWidget.appendChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16088

attachInternals

attachInternals(): ElementInternals
MDN Reference

Returns ElementInternals
Inherited from DeclarativeWidget.attachInternals
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10041

attachShadow

attachShadow(init): ShadowRoot
Creates a shadow root for element and returns it.

MDN Reference
Parameters
- init: ShadowRootInit
Returns ShadowRoot
Inherited from DeclarativeWidget.attachShadow
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7642

attributeChangedCallback

attributeChangedCallback(attr, oldVal, newVal): void
Parameters
- attr: string
- oldVal: string
- newVal: string
Returns void
- Defined in src/widgets/declarative/DeclarativeWidgets.ts:89

before

before(...nodes): void
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.before
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5563

blur

blur(): void
MDN Reference

Returns void
Inherited from DeclarativeWidget.blur
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11999

checkVisibility

checkVisibility(options?): boolean
Parameters
- Optional options: CheckVisibilityOptions
Returns boolean
Inherited from DeclarativeWidget.checkVisibility
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7643

click

click(): void
MDN Reference

Returns void
Inherited from DeclarativeWidget.click
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10043

cloneNode

cloneNode(deep?): Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

MDN Reference
Parameters
- Optional deep: boolean
Returns Node
Inherited from DeclarativeWidget.cloneNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16094

close

close(): void
Calls close method of widgetInstance

Returns void

Throws
Throws an Error if called before the widget has loaded
Inherited from DeclarativeWidget.close
- Defined in src/widgets/declarative/DeclarativeWidget.ts:247

closest

closest<K>(selector): null | HTMLElementTagNameMap[K]
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selector: K
Returns null | HTMLElementTagNameMap[K]
Inherited from DeclarativeWidget.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7649
closest<K>(selector): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selector: K
Returns null | SVGElementTagNameMap[K]
Inherited from DeclarativeWidget.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7650
closest<K>(selector): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selector: K
Returns null | MathMLElementTagNameMap[K]
Inherited from DeclarativeWidget.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7651
closest<E>(selectors): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E
Inherited from DeclarativeWidget.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7652

compareDocumentPosition

compareDocumentPosition(other): number
Returns a bitmask indicating the position of other relative to node.

MDN Reference
Parameters
- other: Node
Returns number
Inherited from DeclarativeWidget.compareDocumentPosition
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16100

computedStyleMap

computedStyleMap(): StylePropertyMapReadOnly
MDN Reference

Returns StylePropertyMapReadOnly
Inherited from DeclarativeWidget.computedStyleMap
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7654

connectedCallback

connectedCallback(): Promise<void>
Returns Promise<void>
- Defined in src/widgets/declarative/DeclarativeWidgets.ts:100

contains

contains(other): boolean
Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference
Parameters
- other: null | Node
Returns boolean
Inherited from DeclarativeWidget.contains
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16106

dispatchEvent

dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from DeclarativeWidget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8174

focus

focus(options?): void
MDN Reference
Parameters
- Optional options: FocusOptions
Returns void
Inherited from DeclarativeWidget.focus
- Defined in node_modules/typescript/lib/lib.dom.d.ts:12001

getAnimations

getAnimations(options?): Animation[]
MDN Reference
Parameters
- Optional options: GetAnimationsOptions
Returns Animation[]
Inherited from DeclarativeWidget.getAnimations
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2400

getAttribute

getAttribute(qualifiedName): null | string
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

MDN Reference
Parameters
- qualifiedName: string
Returns null | string
Inherited from DeclarativeWidget.getAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7660

getAttributeNS

getAttributeNS(namespace, localName): null | string
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns null | string
Inherited from DeclarativeWidget.getAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7666

getAttributeNames

getAttributeNames(): string[]
Returns the qualified names of all element's attributes. Can contain duplicates.

MDN Reference

Returns string[]
Inherited from DeclarativeWidget.getAttributeNames
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7672

getAttributeNode

getAttributeNode(qualifiedName): null | Attr
MDN Reference
Parameters
- qualifiedName: string
Returns null | Attr
Inherited from DeclarativeWidget.getAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7674

getAttributeNodeNS

getAttributeNodeNS(namespace, localName): null | Attr
MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns null | Attr
Inherited from DeclarativeWidget.getAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7676

getBoundingClientRect

getBoundingClientRect(): DOMRect
MDN Reference

Returns DOMRect
Inherited from DeclarativeWidget.getBoundingClientRect
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7678

getClientRects

getClientRects(): DOMRectList
MDN Reference

Returns DOMRectList
Inherited from DeclarativeWidget.getClientRects
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7680

getElementsByClassName

getElementsByClassName(classNames): HTMLCollectionOf<Element>
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

MDN Reference
Parameters
- classNames: string
Returns HTMLCollectionOf<Element>
Inherited from DeclarativeWidget.getElementsByClassName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7686

getElementsByTagName

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>
MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from DeclarativeWidget.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7688
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from DeclarativeWidget.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7689
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from DeclarativeWidget.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7690
getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated
Inherited from DeclarativeWidget.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7692
getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>
Parameters
- qualifiedName: string
Returns HTMLCollectionOf<Element>
Inherited from DeclarativeWidget.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7693

getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>
MDN Reference
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- localName: string
Returns HTMLCollectionOf<HTMLElement>
Inherited from DeclarativeWidget.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7695
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- localName: string
Returns HTMLCollectionOf<SVGElement>
Inherited from DeclarativeWidget.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7696
getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>
Parameters
- namespaceURI: "http://www.w3.org/1998/Math/MathML"
- localName: string
Returns HTMLCollectionOf<MathMLElement>
Inherited from DeclarativeWidget.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7697
getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>
Parameters
- namespace: null | string
- localName: string
Returns HTMLCollectionOf<Element>
Inherited from DeclarativeWidget.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7698

getRootNode

getRootNode(options?): Node
Returns node's root.

MDN Reference
Parameters
- Optional options: GetRootNodeOptions
Returns Node
Inherited from DeclarativeWidget.getRootNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16112

getWidgetInstance

getWidgetInstance(): Promise<EmbedWidget | PopupWidget>
Fetches widget content from SaaSquatch and builds a Widget instance to support rendering the widget in the DOM

Returns Promise<EmbedWidget | PopupWidget>
Instance of either EmbedWidget or PopupWidget depending on this.type

Throws
Throws an Error if widgetType is undefined
Inherited from DeclarativeWidget.getWidgetInstance
- Defined in src/widgets/declarative/DeclarativeWidget.ts:181

hasAttribute

hasAttribute(qualifiedName): boolean
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

MDN Reference
Parameters
- qualifiedName: string
Returns boolean
Inherited from DeclarativeWidget.hasAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7704

hasAttributeNS

hasAttributeNS(namespace, localName): boolean
Returns true if element has an attribute whose namespace is namespace and local name is localName.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns boolean
Inherited from DeclarativeWidget.hasAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7710

hasAttributes

hasAttributes(): boolean
Returns true if element has attributes, and false otherwise.

MDN Reference

Returns boolean
Inherited from DeclarativeWidget.hasAttributes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7716

hasChildNodes

hasChildNodes(): boolean
Returns whether node has children.

MDN Reference

Returns boolean
Inherited from DeclarativeWidget.hasChildNodes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16118

hasPointerCapture

hasPointerCapture(pointerId): boolean
MDN Reference
Parameters
- pointerId: number
Returns boolean
Inherited from DeclarativeWidget.hasPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7718

insertAdjacentElement

insertAdjacentElement(where, element): null | Element
MDN Reference
Parameters
- where: InsertPosition
- element: Element
Returns null | Element
Inherited from DeclarativeWidget.insertAdjacentElement
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7720

insertAdjacentHTML

insertAdjacentHTML(position, text): void
MDN Reference
Parameters
- position: InsertPosition
- text: string
Returns void
Inherited from DeclarativeWidget.insertAdjacentHTML
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7722

insertAdjacentText

insertAdjacentText(where, data): void
MDN Reference
Parameters
- where: InsertPosition
- data: string
Returns void
Inherited from DeclarativeWidget.insertAdjacentText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7724

insertBefore

insertBefore<T>(node, child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: T
- child: null | Node
Returns T
Inherited from DeclarativeWidget.insertBefore
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16120

isDefaultNamespace

isDefaultNamespace(namespace): boolean
MDN Reference
Parameters
- namespace: null | string
Returns boolean
Inherited from DeclarativeWidget.isDefaultNamespace
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16122

isEqualNode

isEqualNode(otherNode): boolean
Returns whether node and otherNode have the same properties.

MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from DeclarativeWidget.isEqualNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16128

isSameNode

isSameNode(otherNode): boolean
MDN Reference
Parameters
- otherNode: null | Node
Returns boolean
Inherited from DeclarativeWidget.isSameNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16130

lookupNamespaceURI

lookupNamespaceURI(prefix): null | string
MDN Reference
Parameters
- prefix: null | string
Returns null | string
Inherited from DeclarativeWidget.lookupNamespaceURI
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16132

lookupPrefix

lookupPrefix(namespace): null | string
MDN Reference
Parameters
- namespace: null | string
Returns null | string
Inherited from DeclarativeWidget.lookupPrefix
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16134

matches

matches(selectors): boolean
Returns true if matching selectors against element's root yields element, and false otherwise.

MDN Reference
Parameters
- selectors: string
Returns boolean
Inherited from DeclarativeWidget.matches
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7730

normalize

normalize(): void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

MDN Reference

Returns void
Inherited from DeclarativeWidget.normalize
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16140

open

open(): void
Calls open method of widgetInstance

Returns void

Throws
Throws an Error if called before the widget has loaded
Inherited from DeclarativeWidget.open
- Defined in src/widgets/declarative/DeclarativeWidget.ts:238

prepend

prepend(...nodes): void
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.prepend
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16737

querySelector

querySelector<K>(selectors): null | HTMLElementTagNameMap[K]
Returns the first element that is a descendant of node that matches selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementTagNameMap[K]
Inherited from DeclarativeWidget.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16743
querySelector<K>(selectors): null | SVGElementTagNameMap[K]
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns null | SVGElementTagNameMap[K]
Inherited from DeclarativeWidget.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16744
querySelector<K>(selectors): null | MathMLElementTagNameMap[K]
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns null | MathMLElementTagNameMap[K]
Inherited from DeclarativeWidget.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16745
querySelector<K>(selectors): null | HTMLElementDeprecatedTagNameMap[K]
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementDeprecatedTagNameMap[K]

Deprecated
Inherited from DeclarativeWidget.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16747
querySelector<E>(selectors): null | E
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns null | E
Inherited from DeclarativeWidget.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16748

querySelectorAll

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>
Returns all element descendants of node that match selectors.

MDN Reference
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
Inherited from DeclarativeWidget.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16754
querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
Inherited from DeclarativeWidget.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16755
querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>
Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<MathMLElementTagNameMap[K]>
Inherited from DeclarativeWidget.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16756
querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated
Inherited from DeclarativeWidget.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16758
querySelectorAll<E>(selectors): NodeListOf<E>
Type Parameters
- E extends Element = Element
Parameters
- selectors: string
Returns NodeListOf<E>
Inherited from DeclarativeWidget.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16759

releasePointerCapture

releasePointerCapture(pointerId): void
MDN Reference
Parameters
- pointerId: number
Returns void
Inherited from DeclarativeWidget.releasePointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7732

remove

remove(): void
Removes node.

MDN Reference

Returns void
Inherited from DeclarativeWidget.remove
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5569

removeAttribute

removeAttribute(qualifiedName): void
Removes element's first attribute whose qualified name is qualifiedName.

MDN Reference
Parameters
- qualifiedName: string
Returns void
Inherited from DeclarativeWidget.removeAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7738

removeAttributeNS

removeAttributeNS(namespace, localName): void
Removes element's attribute whose namespace is namespace and local name is localName.

MDN Reference
Parameters
- namespace: null | string
- localName: string
Returns void
Inherited from DeclarativeWidget.removeAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7744

removeAttributeNode

removeAttributeNode(attr): Attr
MDN Reference
Parameters
- attr: Attr
Returns Attr
Inherited from DeclarativeWidget.removeAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7746

removeChild

removeChild<T>(child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- child: T
Returns T
Inherited from DeclarativeWidget.removeChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16142

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      
      this: HTMLElement
      
      ev: HTMLElementEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from DeclarativeWidget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10046
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from DeclarativeWidget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10047

renderWidget

renderWidget(): Promise<void>
Calls getWidgetInstance to build the Widget instance and loads the widget iframe into the DOM

Returns Promise<void>
Inherited from DeclarativeWidget.renderWidget
- Defined in src/widgets/declarative/DeclarativeWidget.ts:204

replaceChild

replaceChild<T>(node, child): T
MDN Reference
Type Parameters
- T extends Node
Parameters
- node: Node
- child: T
Returns T
Inherited from DeclarativeWidget.replaceChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16144

replaceChildren

replaceChildren(...nodes): void
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.replaceChildren
- Defined in node_modules/typescript/lib/lib.dom.d.ts:16767

replaceWith

replaceWith(...nodes): void
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

MDN Reference
Parameters
- Rest ...nodes: (string | Node)[]
Returns void
Inherited from DeclarativeWidget.replaceWith
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5577

requestFullscreen

requestFullscreen(options?): Promise<void>
Displays element fullscreen and resolves promise when done.

When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

MDN Reference
Parameters
- Optional options: FullscreenOptions
Returns Promise<void>
Inherited from DeclarativeWidget.requestFullscreen
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7754

requestPointerLock

requestPointerLock(): void
MDN Reference

Returns void
Inherited from DeclarativeWidget.requestPointerLock
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7756

scroll

scroll(options?): void
MDN Reference
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from DeclarativeWidget.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7758
scroll(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from DeclarativeWidget.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7759

scrollBy

scrollBy(options?): void
MDN Reference
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from DeclarativeWidget.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7761
scrollBy(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from DeclarativeWidget.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7762

scrollIntoView

scrollIntoView(arg?): void
MDN Reference
Parameters
- Optional arg: boolean | ScrollIntoViewOptions
Returns void
Inherited from DeclarativeWidget.scrollIntoView
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7764

scrollTo

scrollTo(options?): void
MDN Reference
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from DeclarativeWidget.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7766
scrollTo(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from DeclarativeWidget.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7767

setAttribute

setAttribute(qualifiedName, value): void
Sets the value of element's first attribute whose qualified name is qualifiedName to value.

MDN Reference
Parameters
- qualifiedName: string
- value: string
Returns void
Inherited from DeclarativeWidget.setAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7773

setAttributeNS

setAttributeNS(namespace, qualifiedName, value): void
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

MDN Reference
Parameters
- namespace: null | string
- qualifiedName: string
- value: string
Returns void
Inherited from DeclarativeWidget.setAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7779

setAttributeNode

setAttributeNode(attr): null | Attr
MDN Reference
Parameters
- attr: Attr
Returns null | Attr
Inherited from DeclarativeWidget.setAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7781

setAttributeNodeNS

setAttributeNodeNS(attr): null | Attr
MDN Reference
Parameters
- attr: Attr
Returns null | Attr
Inherited from DeclarativeWidget.setAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7783

setErrorWidget

setErrorWidget(e): EmbedWidget | PopupWidget
Builds a Widget instance for the default error widget
Parameters
- e: Error
Returns EmbedWidget | PopupWidget
Instance of either EmbedWidget or PopupWidget depending on this.type
Inherited from DeclarativeWidget.setErrorWidget
- Defined in src/widgets/declarative/DeclarativeWidget.ts:213

setPointerCapture

setPointerCapture(pointerId): void
MDN Reference
Parameters
- pointerId: number
Returns void
Inherited from DeclarativeWidget.setPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7785

toggleAttribute

toggleAttribute(qualifiedName, force?): boolean
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

Returns true if qualifiedName is now present, and false otherwise.

MDN Reference
Parameters
- qualifiedName: string
- Optional force: boolean
Returns boolean
Inherited from DeclarativeWidget.toggleAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7793

webkitMatchesSelector

webkitMatchesSelector(selectors): boolean
Parameters
- selectors: string
Returns boolean

Deprecated
This is a legacy alias of matches.

MDN Reference
Inherited from DeclarativeWidget.webkitMatchesSelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7799

Class DeclarativePopupWidget

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DeclarativePopupWidget

Properties

Readonly ATTRIBUTE_NODE

Readonly CDATA_SECTION_NODE

Readonly COMMENT_NODE

Readonly DOCUMENT_FRAGMENT_NODE

Readonly DOCUMENT_NODE

Readonly DOCUMENT_POSITION_CONTAINED_BY

Readonly DOCUMENT_POSITION_CONTAINS

Readonly DOCUMENT_POSITION_DISCONNECTED

Readonly DOCUMENT_POSITION_FOLLOWING

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Readonly DOCUMENT_POSITION_PRECEDING

Readonly DOCUMENT_TYPE_NODE

Readonly ELEMENT_NODE

Readonly ENTITY_NODE

Readonly ENTITY_REFERENCE_NODE

Readonly NOTATION_NODE

Readonly PROCESSING_INSTRUCTION_NODE

Readonly TEXT_NODE

accessKey

Readonly accessKeyLabel

analyticsApi

ariaAtomic

ariaAutoComplete

ariaBusy

ariaChecked

ariaColCount

ariaColIndex

ariaColSpan

ariaCurrent

ariaDisabled

ariaExpanded

ariaHasPopup

ariaHidden

ariaInvalid

ariaKeyShortcuts

ariaLabel

ariaLevel

ariaLive

ariaModal

ariaMultiLine

ariaMultiSelectable

ariaOrientation

ariaPlaceholder

ariaPosInSet

ariaPressed

ariaReadOnly

ariaRequired

ariaRoleDescription

ariaRowCount

ariaRowIndex

ariaRowSpan

ariaSelected

ariaSetSize

ariaSort

ariaValueMax

ariaValueMin

ariaValueNow

ariaValueText

Readonly assignedSlot

Readonly attributeStyleMap

Readonly attributes

autocapitalize

autofocus

Readonly baseURI

Readonly childElementCount

Readonly childNodes

Readonly children

Readonly classList

`Readonly` ATTRIBUTE_NODE

`Readonly` CDATA_SECTION_NODE

`Readonly` COMMENT_NODE

`Readonly` DOCUMENT_FRAGMENT_NODE

`Readonly` DOCUMENT_NODE

`Readonly` DOCUMENT_POSITION_CONTAINED_BY

`Readonly` DOCUMENT_POSITION_CONTAINS

`Readonly` DOCUMENT_POSITION_DISCONNECTED

`Readonly` DOCUMENT_POSITION_FOLLOWING

`Readonly` DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

`Readonly` DOCUMENT_POSITION_PRECEDING

`Readonly` DOCUMENT_TYPE_NODE

`Readonly` ELEMENT_NODE

`Readonly` ENTITY_NODE

`Readonly` ENTITY_REFERENCE_NODE

`Readonly` NOTATION_NODE

`Readonly` PROCESSING_INSTRUCTION_NODE

`Readonly` TEXT_NODE

`Readonly` accessKeyLabel

`Readonly` assignedSlot

`Readonly` attributeStyleMap

`Readonly` attributes

`Readonly` baseURI

`Readonly` childElementCount

`Readonly` childNodes

`Readonly` children

`Readonly` classList

`Readonly` clientHeight

`Readonly` clientLeft

`Readonly` clientTop

`Readonly` clientWidth

`Readonly` dataset

`Readonly` firstChild

`Readonly` firstElementChild

`Readonly` isConnected

`Readonly` isContentEditable

`Readonly` lastChild

`Readonly` lastElementChild

`Readonly` localName

`Readonly` namespaceURI

`Readonly` nextElementSibling

`Readonly` nextSibling

`Readonly` nodeName

`Readonly` nodeType

`Optional` nonce

`Readonly` offsetHeight

`Readonly` offsetLeft

`Readonly` offsetParent

`Readonly` offsetTop

`Readonly` offsetWidth