Widget | @capitec/omni-widget

Component that hosts a remote widget. The Widget class provides static functions that can be used to interop from a <omni-widget> component hosted frame to the hosting window. The <omni-widget> component provides public instance functions that can be used to interop from the hosting window to the hosted frame.

import

import '@capitec/omni-components/widget';

example

<omni-widget src="https://some-widget-url"></omni-widget>

element

omni-widget

fires

{CustomEvent} frame-load - Dispatched from the component and also sent as a bridged message to the hosted widget frame, after the frame initially loads.

fires

{CustomEvent} bridge-message - Dispatched when a bridged message is received.

fires

{CustomEvent} event-name - Dispatched when a bridged message is received. The event-name is set by the bridgeEvent property of the received message data.

csspart

frame - Internal HTMLIFrameElement instance to be targeted via ::part(frame) selector in css.

Hierarchy

HTMLElement
- Widget

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Widget(): Widget

Overrides HTMLElement.constructor
- Defined in src/Widget.ts:109
Initialises the component.

hideconstructor
Returns Widget

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: null | string

ariaAutoComplete

ariaAutoComplete: null | string

ariaBusy

ariaBusy: null | string

ariaChecked

ariaChecked: null | string

ariaColCount

ariaColCount: null | string

ariaColIndex

ariaColIndex: null | string

ariaColSpan

ariaColSpan: null | string

ariaCurrent

ariaCurrent: null | string

ariaDisabled

ariaDisabled: null | string

ariaExpanded

ariaExpanded: null | string

ariaHasPopup

ariaHasPopup: null | string

ariaHidden

ariaHidden: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

ariaLabel

ariaLabel: null | string

ariaLevel

ariaLevel: null | string

ariaLive

ariaLive: null | string

ariaModal

ariaModal: null | string

ariaMultiLine

ariaMultiLine: null | string

ariaMultiSelectable

ariaMultiSelectable: null | string

ariaOrientation

ariaOrientation: null | string

ariaPlaceholder

ariaPlaceholder: null | string

ariaPosInSet

ariaPosInSet: null | string

ariaPressed

ariaPressed: null | string

ariaReadOnly

ariaReadOnly: null | string

ariaRequired

ariaRequired: null | string

ariaRoleDescription

ariaRoleDescription: null | string

ariaRowCount

ariaRowCount: null | string

ariaRowIndex

ariaRowIndex: null | string

ariaRowSpan

ariaRowSpan: null | string

ariaSelected

ariaSelected: null | string

ariaSetSize

ariaSetSize: null | string

ariaSort

ariaSort: null | string

ariaValueMax

ariaValueMax: null | string

ariaValueMin

ariaValueMin: null | string

ariaValueNow

ariaValueNow: null | string

ariaValueText

ariaValueText: null | string

Readonly assignedSlot

assignedSlot: null | HTMLSlotElement

Readonly attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

Readonly baseURI

baseURI: string

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

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly classList

classList: DOMTokenList

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

className

className: string

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

Readonly clientHeight

clientHeight: number

Readonly clientLeft

clientLeft: number

Readonly clientTop

clientTop: number

Readonly clientWidth

clientWidth: number

Private componentMessageListener

componentMessageListener: ((event: MessageEvent<any>) => void) = ...

Type declaration

- (event: MessageEvent<any>): void
- Parameters
  - event: MessageEvent<any>
  Returns void

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

Readonly firstChild

firstChild: null | ChildNode

Returns the first child.

Readonly firstElementChild

firstElementChild: null | Element

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

hidden

hidden: boolean

id

id: string

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

Readonly identifier

identifier: string = ...

Unique identifier for widget with which to track widget specific events

Readonly iframe

iframe: HTMLIFrameElement

Internal instance of HTMLIFrameElement

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly isContentEditable

isContentEditable: boolean

lang

lang: string

Readonly lastChild

lastChild: null | ChildNode

Returns the last child.

Readonly lastElementChild

lastElementChild: null | Element

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

Readonly localName

localName: string

Returns the local name.

Readonly namespaceURI

namespaceURI: null | string

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: null | Element

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

Readonly nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

Readonly nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: null | string

Optional nonce

nonce?: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: null | Element

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

param ev: The event.

onanimationcancel

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

onanimationend

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

onanimationiteration

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

onanimationstart

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

onauxclick

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

onblur

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

Fires when the object loses the input focus.

param ev: The focus event.

oncanplay

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

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

param ev: The event.

oncanplaythrough

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

onchange

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

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

param ev: The event.

onclick

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

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

param ev: The mouse event.

onclose

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

oncontextmenu

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

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

param ev: The mouse event.

oncopy

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

oncuechange

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

oncut

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

ondblclick

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

Fires when the user double-clicks the object.

param ev: The mouse event.

ondrag

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

Fires on the source object continuously during a drag operation.

param ev: The event.

ondragend

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

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

param ev: The event.

ondragenter

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

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

param ev: The drag event.

ondragleave

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

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

param ev: The drag event.

ondragover

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

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

param ev: The event.

ondragstart

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

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

param ev: The event.

ondrop

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

ondurationchange

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

Occurs when the duration attribute is updated.

param ev: The event.

onemptied

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

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

param ev: The event.

onended

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

Occurs when the end of playback is reached.

param ev: The event

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

param ev: The event.

onfocus

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

Fires when the object receives focus.

param ev: The event.

onformdata

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

onfullscreenchange

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

onfullscreenerror

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

ongotpointercapture

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

oninput

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

oninvalid

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

onkeydown

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

Fires when the user presses a key.

param ev: The keyboard event

onkeypress

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

Fires when the user presses an alphanumeric key.

param ev: The event.
deprecated

onkeyup

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

Fires when the user releases a key.

param ev: The keyboard event

onload

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

Fires immediately after the browser loads the object.

param ev: The event.

onloadeddata

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

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

param ev: The event.

onloadedmetadata

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

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

param ev: The event.

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

param ev: The event.

onlostpointercapture

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

onmousedown

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

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

param ev: The mouse event.

onmouseenter

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

onmouseleave

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

onmousemove

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

Fires when the user moves the mouse over the object.

param ev: The mouse event.

onmouseout

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

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

param ev: The mouse event.

onmouseover

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

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

param ev: The mouse event.

onmouseup

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

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

param ev: The mouse event.

onpaste

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

onpause

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

Occurs when playback is paused.

param ev: The event.

onplay

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

Occurs when the play method is requested.

param ev: The event.

onplaying

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

Occurs when the audio or video has started playing.

param ev: The event.

onpointercancel

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

onpointerdown

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

onpointerenter

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

onpointerleave

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

onpointermove

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

onpointerout

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

onpointerover

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

onpointerup

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

onprogress

onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any)

Occurs to indicate progress while downloading media data.

param ev: The event.

onratechange

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

Occurs when the playback rate is increased or decreased.

param ev: The event.

onreset

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

Fires when the user resets a form.

param ev: The event.

onresize

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

onscroll

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

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

param ev: The event.

onsecuritypolicyviolation

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

onseeked

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

Occurs when the seek operation ends.

param ev: The event.

onseeking

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

Occurs when the current playback position is moved.

param ev: The event.

onselect

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

Fires when the current selection changes.

param ev: The event.

onselectionchange

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

onselectstart

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

onslotchange

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

onstalled

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

Occurs when the download has stopped.

param ev: The event.

onsubmit

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

onsuspend

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

Occurs if the load operation has been intentionally halted.

param ev: The event.

ontimeupdate

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

Occurs to indicate the current playback position.

param ev: The event.

ontoggle

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

Optional ontouchcancel

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

Optional ontouchend

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

Optional ontouchmove

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

Optional ontouchstart

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

ontransitioncancel

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

ontransitionend

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

ontransitionrun

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

ontransitionstart

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

onvolumechange

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

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

param ev: The event.

onwaiting

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

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

param ev: The event.

onwebkitanimationend

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

deprecated: This is a legacy alias of onanimationend.

onwebkitanimationiteration

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

deprecated: This is a legacy alias of onanimationiteration.

onwebkitanimationstart

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

deprecated: This is a legacy alias of onanimationstart.

onwebkittransitionend

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

deprecated: This is a legacy alias of ontransitionend.

onwheel

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

outerHTML

outerHTML: string

outerText

outerText: string

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: null | HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: null | ParentNode

Returns the parent.

Readonly part

part: DOMTokenList

Readonly prefix

prefix: null | string

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: null | Element

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

Readonly previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: null | ShadowRoot

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

slot

slot: string

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

spellcheck

spellcheck: boolean

Readonly style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: null | string

title

title: string

translate

translate: boolean

Static Private Optional _currentIdentifier

_currentIdentifier?: string

Accessors

src

get src(): string
set src(value: string): void

- Defined in src/Widget.ts:43
The URI path to the widget.

attr
Returns string
- Defined in src/Widget.ts:47
The URI path to the widget.

attr
Parameters
- value: string
Returns void

Static currentIdentifier

get currentIdentifier(): undefined | string
set currentIdentifier(identifier: undefined | string): void

- Defined in src/Widget.ts:76
If current window is hosted within a frame by the omni-widget component and the widget has been initialised, will be the current identifier for the widget to use when sending messages.

Returns undefined | string
- Defined in src/Widget.ts:80
If current window is hosted within a frame by the omni-widget component and the widget has been initialised, will be the current identifier for the widget to use when sending messages.

Parameters
- identifier: undefined | string
Returns void

Static isHosted

get isHosted(): boolean

- Defined in src/Widget.ts:67
Determines whether the current window is hosted within a frame. Will be false if current window is the top level window.

Returns boolean

Static isInitialised

get isInitialised(): boolean

- Defined in src/Widget.ts:87
Will be true if the current window is hosted within a frame by the omni-widget component and the widget has been initialised.

Returns boolean

Static observedAttributes

get observedAttributes(): string[]

- Defined in src/Widget.ts:145
List of attributes that will trigger attributeChangedCallback when set.

Returns string[]

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

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

after

after(...nodes: (string | Node)[]): void

Inherited from HTMLElement.after
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3574
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

animate

animate(keyframes: null | PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation

Inherited from HTMLElement.animate
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2047
Parameters
- keyframes: null | PropertyIndexedKeyframes | Keyframe[]
- Optional options: number | KeyframeAnimationOptions
Returns Animation

append

append(...nodes: (string | Node)[]): void

Inherited from HTMLElement.append
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10419
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

appendChild

appendChild<T>(node: T): T

Inherited from HTMLElement.appendChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10067
Type Parameters
- T extends Node<T>
Parameters
- node: T
Returns T

attachInternals

attachInternals(): ElementInternals

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

attachShadow

attachShadow(init: ShadowRootInit): ShadowRoot

Inherited from HTMLElement.attachShadow
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4885
Creates a shadow root for element and returns it.

Parameters
- init: ShadowRootInit
Returns ShadowRoot

attributeChangedCallback

attributeChangedCallback(name: string, oldValue: string, newValue: string): void

- Defined in src/Widget.ts:168
Callback on change for any attribute listed in observedAttributes.

Parameters
- name: string
- oldValue: string
- newValue: string
Returns void

before

before(...nodes: (string | Node)[]): void

Inherited from HTMLElement.before
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3580
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

blur

blur(): void

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

click

click(): void

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

cloneNode

cloneNode(deep?: boolean): Node

Inherited from HTMLElement.cloneNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10069
Returns a copy of node. If deep is true, the copy also includes the node's descendants.

Parameters
- Optional deep: boolean
Returns Node

closest

closest<K>(selector: K): null | HTMLElementTagNameMap[K]
closest<K>(selector: K): null | SVGElementTagNameMap[K]
closest<E>(selectors: string): null | E

Inherited from HTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4887
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selector: K
Returns null | HTMLElementTagNameMap[K]
Inherited from HTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4888
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selector: K
Returns null | SVGElementTagNameMap[K]
Inherited from HTMLElement.closest
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4889
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns null | E

compareDocumentPosition

compareDocumentPosition(other: Node): number

Inherited from HTMLElement.compareDocumentPosition
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10071
Returns a bitmask indicating the position of other relative to node.

Parameters
- other: Node
Returns number

connectedCallback

connectedCallback(): void

- Defined in src/Widget.ts:152
Setup the component once added to the DOM.

Returns void

contains

contains(other: null | Node): boolean

Inherited from HTMLElement.contains
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10073
Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters
- other: null | Node
Returns boolean

disconnectedCallback

disconnectedCallback(): void

- Defined in src/Widget.ts:160
Clean up the component once removed from the DOM.

Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from HTMLElement.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:5138
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.

Parameters
- event: Event
Returns boolean

focus

focus(options?: FocusOptions): void

Inherited from HTMLElement.focus
- Defined in node_modules/typescript/lib/lib.dom.d.ts:7552
Parameters
- Optional options: FocusOptions
Returns void

Private frameLoaded

frameLoaded(): Promise<void>

- Defined in src/Widget.ts:199
Returns Promise<void>

getAnimations

getAnimations(options?: GetAnimationsOptions): Animation[]

Inherited from HTMLElement.getAnimations
- Defined in node_modules/typescript/lib/lib.dom.d.ts:2048
Parameters
- Optional options: GetAnimationsOptions
Returns Animation[]

getAttribute

getAttribute(qualifiedName: string): null | string

Inherited from HTMLElement.getAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4891
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

Parameters
- qualifiedName: string
Returns null | string

getAttributeNS

getAttributeNS(namespace: null | string, localName: string): null | string

Inherited from HTMLElement.getAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4893
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

Parameters
- namespace: null | string
- localName: string
Returns null | string

getAttributeNames

getAttributeNames(): string[]

Inherited from HTMLElement.getAttributeNames
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4895
Returns the qualified names of all element's attributes. Can contain duplicates.

Returns string[]

getAttributeNode

getAttributeNode(qualifiedName: string): null | Attr

Inherited from HTMLElement.getAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4896
Parameters
- qualifiedName: string
Returns null | Attr

getAttributeNodeNS

getAttributeNodeNS(namespace: null | string, localName: string): null | Attr

Inherited from HTMLElement.getAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4897
Parameters
- namespace: null | string
- localName: string
Returns null | Attr

getBoundingClientRect

getBoundingClientRect(): DOMRect

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

getClientRects

getClientRects(): DOMRectList

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

getElementsByClassName

getElementsByClassName(classNames: string): HTMLCollectionOf<Element>

Inherited from HTMLElement.getElementsByClassName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4901
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.

Parameters
- classNames: string
Returns HTMLCollectionOf<Element>

getElementsByTagName

getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>

Inherited from HTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4902
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from HTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4903
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- qualifiedName: K
Returns HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from HTMLElement.getElementsByTagName
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4904
Parameters
- qualifiedName: string
Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>
getElementsByTagNameNS(namespace: null | string, localName: string): HTMLCollectionOf<Element>

Inherited from HTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4905
Parameters
- namespaceURI: "http://www.w3.org/1999/xhtml"
- localName: string
Returns HTMLCollectionOf<HTMLElement>
Inherited from HTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4906
Parameters
- namespaceURI: "http://www.w3.org/2000/svg"
- localName: string
Returns HTMLCollectionOf<SVGElement>
Inherited from HTMLElement.getElementsByTagNameNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4907
Parameters
- namespace: null | string
- localName: string
Returns HTMLCollectionOf<Element>

getRootNode

getRootNode(options?: GetRootNodeOptions): Node

Inherited from HTMLElement.getRootNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10075
Returns node's root.

Parameters
- Optional options: GetRootNodeOptions
Returns Node

hasAttribute

hasAttribute(qualifiedName: string): boolean

Inherited from HTMLElement.hasAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4909
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

Parameters
- qualifiedName: string
Returns boolean

hasAttributeNS

hasAttributeNS(namespace: null | string, localName: string): boolean

Inherited from HTMLElement.hasAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4911
Returns true if element has an attribute whose namespace is namespace and local name is localName.

Parameters
- namespace: null | string
- localName: string
Returns boolean

hasAttributes

hasAttributes(): boolean

Inherited from HTMLElement.hasAttributes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4913
Returns true if element has attributes, and false otherwise.

Returns boolean

hasChildNodes

hasChildNodes(): boolean

Inherited from HTMLElement.hasChildNodes
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10077
Returns whether node has children.

Returns boolean

hasPointerCapture

hasPointerCapture(pointerId: number): boolean

Inherited from HTMLElement.hasPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4914
Parameters
- pointerId: number
Returns boolean

insertAdjacentElement

insertAdjacentElement(where: InsertPosition, element: Element): null | Element

Inherited from HTMLElement.insertAdjacentElement
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4915
Parameters
- where: InsertPosition
- element: Element
Returns null | Element

insertAdjacentHTML

insertAdjacentHTML(position: InsertPosition, text: string): void

Inherited from HTMLElement.insertAdjacentHTML
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4916
Parameters
- position: InsertPosition
- text: string
Returns void

insertAdjacentText

insertAdjacentText(where: InsertPosition, data: string): void

Inherited from HTMLElement.insertAdjacentText
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4917
Parameters
- where: InsertPosition
- data: string
Returns void

insertBefore

insertBefore<T>(node: T, child: null | Node): T

Inherited from HTMLElement.insertBefore
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10078
Type Parameters
- T extends Node<T>
Parameters
- node: T
- child: null | Node
Returns T

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean

Inherited from HTMLElement.isDefaultNamespace
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10079
Parameters
- namespace: null | string
Returns boolean

isEqualNode

isEqualNode(otherNode: null | Node): boolean

Inherited from HTMLElement.isEqualNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10081
Returns whether node and otherNode have the same properties.

Parameters
- otherNode: null | Node
Returns boolean

isSameNode

isSameNode(otherNode: null | Node): boolean

Inherited from HTMLElement.isSameNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10082
Parameters
- otherNode: null | Node
Returns boolean

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | string

Inherited from HTMLElement.lookupNamespaceURI
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10083
Parameters
- prefix: null | string
Returns null | string

lookupPrefix

lookupPrefix(namespace: null | string): null | string

Inherited from HTMLElement.lookupPrefix
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10084
Parameters
- namespace: null | string
Returns null | string

matches

matches(selectors: string): boolean

Inherited from HTMLElement.matches
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4919
Returns true if matching selectors against element's root yields element, and false otherwise.

Parameters
- selectors: string
Returns boolean

messageWidget

messageWidget<T, U>(eventName: string, detail?: T, callback?: ((detail: U) => void), timeout?: number, timeoutCallback?: (() => void), callbackIdentifierPrefix?: string): void

- Defined in src/Widget.ts:249
Send a bridged message to the hosted widget frame.

Type Parameters
- T = any
- U = any
Parameters
- eventName: string
  
  The event this message correlates to.
- Optional detail: T
  
  Custom detail to attach as event detail.
- Optional callback: ((detail: U) => void)
  
  (Optional) Callback function to invoke on widget response.
  - - (detail: U): void
    - Parameters
      - detail: U
      Returns void
- Optional timeout: number
  
  (Optional) Duration to wait for callback.
- Optional timeoutCallback: (() => void)
  
  (Optional) Callback function to invoke if response timeout is exceeded
  - - (): void
    - Returns void
- callbackIdentifierPrefix: string = 'widget-callback'
  
  (Optional) Prefix to apply on generated widget callback id
Returns void

messageWidgetAsync

messageWidgetAsync<T, U>(eventName: string, detail?: T, timeout?: number, callbackIdentifierPrefix?: string): Promise<U>

- Defined in src/Widget.ts:308
Asynchronously sends a bridged message to the hosted widget frame, then awaits and returns its response.

Type Parameters
- T = any
- U = any
Parameters
- eventName: string
  
  The event this message correlates to.
- Optional detail: T
  
  Custom detail to attach as event detail.
- Optional timeout: number
  
  (Optional) Duration to wait for before rejecting the promise. If not specified, will wait indefinitely
- callbackIdentifierPrefix: string = 'widget-callback'
  
  (Optional) Prefix to apply on generated widget callback id.
Returns Promise<U>

normalize

normalize(): void

Inherited from HTMLElement.normalize
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10086
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

Returns void

prepend

prepend(...nodes: (string | Node)[]): void

Inherited from HTMLElement.prepend
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10425
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

querySelector

querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
querySelector<E>(selectors: string): null | E

Inherited from HTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10427
Returns the first element that is a descendant of node that matches selectors.

Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns null | HTMLElementTagNameMap[K]
Inherited from HTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10428
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns null | SVGElementTagNameMap[K]
Inherited from HTMLElement.querySelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10429
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns null | E

querySelectorAll

querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
querySelectorAll<E>(selectors: string): NodeListOf<E>

Inherited from HTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10431
Returns all element descendants of node that match selectors.

Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
Inherited from HTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10432
Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
Inherited from HTMLElement.querySelectorAll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10433
Type Parameters
- E extends Element<E> = Element
Parameters
- selectors: string
Returns NodeListOf<E>

releasePointerCapture

releasePointerCapture(pointerId: number): void

Inherited from HTMLElement.releasePointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4920
Parameters
- pointerId: number
Returns void

remove

remove(): void

Inherited from HTMLElement.remove
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3582
Removes node.

Returns void

removeAttribute

removeAttribute(qualifiedName: string): void

Inherited from HTMLElement.removeAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4922
Removes element's first attribute whose qualified name is qualifiedName.

Parameters
- qualifiedName: string
Returns void

removeAttributeNS

removeAttributeNS(namespace: null | string, localName: string): void

Inherited from HTMLElement.removeAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4924
Removes element's attribute whose namespace is namespace and local name is localName.

Parameters
- namespace: null | string
- localName: string
Returns void

removeAttributeNode

removeAttributeNode(attr: Attr): Attr

Inherited from HTMLElement.removeAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4925
Parameters
- attr: Attr
Returns Attr

removeChild

removeChild<T>(child: T): T

Inherited from HTMLElement.removeChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10087
Type Parameters
- T extends Node<T>
Parameters
- child: T
Returns T

removeEventListener

removeEventListener<K>(type: K, listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any), options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

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

replaceChild

replaceChild<T>(node: Node, child: T): T

Inherited from HTMLElement.replaceChild
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10088
Type Parameters
- T extends Node<T>
Parameters
- node: Node
- child: T
Returns T

replaceChildren

replaceChildren(...nodes: (string | Node)[]): void

Inherited from HTMLElement.replaceChildren
- Defined in node_modules/typescript/lib/lib.dom.d.ts:10439
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

replaceWith

replaceWith(...nodes: (string | Node)[]): void

Inherited from HTMLElement.replaceWith
- Defined in node_modules/typescript/lib/lib.dom.d.ts:3588
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.

Parameters
- Rest ...nodes: (string | Node)[]
Returns void

requestFullscreen

requestFullscreen(options?: FullscreenOptions): Promise<void>

Inherited from HTMLElement.requestFullscreen
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4931
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.

Parameters
- Optional options: FullscreenOptions
Returns Promise<void>

requestPointerLock

requestPointerLock(): void

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

scroll

scroll(options?: ScrollToOptions): void
scroll(x: number, y: number): void

Inherited from HTMLElement.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4933
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from HTMLElement.scroll
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4934
Parameters
- x: number
- y: number
Returns void

scrollBy

scrollBy(options?: ScrollToOptions): void
scrollBy(x: number, y: number): void

Inherited from HTMLElement.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4935
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from HTMLElement.scrollBy
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4936
Parameters
- x: number
- y: number
Returns void

scrollIntoView

scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void

Inherited from HTMLElement.scrollIntoView
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4937
Parameters
- Optional arg: boolean | ScrollIntoViewOptions
Returns void

scrollTo

scrollTo(options?: ScrollToOptions): void
scrollTo(x: number, y: number): void

Inherited from HTMLElement.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4938
Parameters
- Optional options: ScrollToOptions
Returns void
Inherited from HTMLElement.scrollTo
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4939
Parameters
- x: number
- y: number
Returns void

setAttribute

setAttribute(qualifiedName: string, value: string): void

Inherited from HTMLElement.setAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4941
Sets the value of element's first attribute whose qualified name is qualifiedName to value.

Parameters
- qualifiedName: string
- value: string
Returns void

setAttributeNS

setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void

Inherited from HTMLElement.setAttributeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4943
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

Parameters
- namespace: null | string
- qualifiedName: string
- value: string
Returns void

setAttributeNode

setAttributeNode(attr: Attr): null | Attr

Inherited from HTMLElement.setAttributeNode
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4944
Parameters
- attr: Attr
Returns null | Attr

setAttributeNodeNS

setAttributeNodeNS(attr: Attr): null | Attr

Inherited from HTMLElement.setAttributeNodeNS
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4945
Parameters
- attr: Attr
Returns null | Attr

setPointerCapture

setPointerCapture(pointerId: number): void

Inherited from HTMLElement.setPointerCapture
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4946
Parameters
- pointerId: number
Returns void

toggleAttribute

toggleAttribute(qualifiedName: string, force?: boolean): boolean

Inherited from HTMLElement.toggleAttribute
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4952
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.

Parameters
- qualifiedName: string
- Optional force: boolean
Returns boolean

webkitMatchesSelector

webkitMatchesSelector(selectors: string): boolean

Inherited from HTMLElement.webkitMatchesSelector
- Defined in node_modules/typescript/lib/lib.dom.d.ts:4954
deprecated
This is a legacy alias of matches.

Parameters
- selectors: string
Returns boolean

Private widgetMessageReceived

widgetMessageReceived<T>(event: MessageEvent<BridgeInfo<T>>): void

- Defined in src/Widget.ts:212
Type Parameters
- T
Parameters
- event: MessageEvent<BridgeInfo<T>>
Returns void

Static addEventListener

addEventListener<T, U>(eventName: string, listener: ((event: WidgetEventDetail<T, U>) => void)): ((event: MessageEvent<BridgeInfo<T>>) => void)

- Defined in src/Widget.ts:444
Set up a callback for the specified event from the widget component in a hosting application.

Type Parameters
- T = any
- U = any
Parameters
- eventName: string
  
  The event name to listen for when receiving bridged messages.
- listener: ((event: WidgetEventDetail<T, U>) => void)
  
  The callback to invoke when the specified event occurs.
  - - (event: WidgetEventDetail<T, U>): void
    - Parameters
      - event: WidgetEventDetail<T, U>
      Returns void
Returns ((event: MessageEvent<BridgeInfo<T>>) => void)
Event listener instance that can be used to remove the listener via Widget.removeEventListener
- - (event: MessageEvent<BridgeInfo<T>>): void
  - Parameters
    - event: MessageEvent<BridgeInfo<T>>
    Returns void

Static initialise

initialise(frameLoaded: ((identifier: string) => void)): void

- Defined in src/Widget.ts:428
Set up a callback for the frame-load event from the widget component in a hosting application. Can be used by a widget application to retrieve its identifier from the widget component.

Parameters
- frameLoaded: ((identifier: string) => void)
  
  The callback to invoke when the frame-load event occurs.
  - - (identifier: string): void
    - Parameters
      - identifier: string
      Returns void
Returns void

Static messageApplication

messageApplication<T, U>(identifier: string, eventName: string, detail?: T, callback?: ((detail: U) => void), timeout?: number, timeoutCallback?: (() => void), callbackIdentifierPrefix?: string): void

- Defined in src/Widget.ts:337
Send a bridged message to the hosting application frame as a widget.

Type Parameters
- T
- U = any
Parameters
- identifier: string
  
  Identifier to represent widget.
- eventName: string
  
  Name of event to send to application.
- Optional detail: T
  
  Custom detail to attach as event detail.
- Optional callback: ((detail: U) => void)
  
  (Optional) Callback function to invoke on widget response.
  - - (detail: U): void
    - Parameters
      - detail: U
      Returns void
- Optional timeout: number
  
  (Optional) Duration to wait for callback.
- Optional timeoutCallback: (() => void)
  
  (Optional) Callback function to invoke if response timeout is exceeded
  - - (): void
    - Returns void
- callbackIdentifierPrefix: string = 'widget-callback'
  
  (Optional) Prefix to apply on generated widget callback id
Returns void

Static messageApplicationAsync

messageApplicationAsync<T, U>(identifier: string, eventName: string, detail: T, timeout?: number, callbackIdentifierPrefix?: string): Promise<U>

- Defined in src/Widget.ts:399
Asynchronously sends a bridged message to the hosting application frame as a widget, then awaits and returns its response.

Type Parameters
- T
- U = any
Parameters
- identifier: string
  
  Identifier to represent widget.
- eventName: string
  
  The event this message correlates to.
- detail: T
  
  Custom detail to attach as event detail.
- timeout: number = 3000
  
  (Optional) Duration to wait for before rejecting the promise. If not specified, will wait indefinitely.
- callbackIdentifierPrefix: string = 'widget-callback'
  
  (Optional) Prefix to apply on generated widget callback id
Returns Promise<U>

Static removeEventListener

removeEventListener<T>(messageListener: ((event: MessageEvent<BridgeInfo<T>>) => void)): void

- Defined in src/Widget.ts:474
Remove the listener from the widget component in a hosting application.

Type Parameters
- T = any
Parameters
- messageListener: ((event: MessageEvent<BridgeInfo<T>>) => void)
  
  The listener instance created by Widget.addEventListener to remove
  - - (event: MessageEvent<BridgeInfo<T>>): void
    - Parameters
      - event: MessageEvent<BridgeInfo<T>>
      Returns void
Returns void

Static uuidv4

uuidv4(): string

- Defined in src/Widget.ts:177
Generate a unique identifier string

Returns string

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Widget

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

ariaAtomic

ariaAutoComplete

ariaBusy

ariaChecked

ariaColCount

ariaColIndex

ariaColSpan

ariaCurrent

ariaDisabled

ariaExpanded

ariaHasPopup

ariaHidden

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 attributes

autocapitalize

autofocus

Readonly baseURI

Readonly childElementCount

Readonly childNodes

Readonly children

Readonly classList

className

Readonly clientHeight

Readonly clientLeft

Readonly clientTop

Readonly clientWidth