Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseComponent<P>

Base class for components. Use in derived classes with a path to a template file, and additional setup steps callback. Override 'render' method (mandatory) for event wiring and data/dom manipulation or creation (dynamic part).

If the component shall show nothing or has temporarily nothing to render just return null.

Components must be decorated with at least the {@link {CustomElement}} decorator. That defines the name is required to render properly. Additional class decorators are available:

  • {@link InjectService:} Injects a service class und a singleton instance becomes avaiable through the property services.

After the render method has been called the first time the property initialized becomes true. All properties can be bound, so any change will re-render the content. See {@link {Properties}} decorator. If you use jsx in the render method you must import JSX function. This is same behavior as in React. It isn't React, though.

https://www.mikedoesweb.com/2017/dynamic-super-classes-extends-in-es6/

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

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.

__uniqueId__

__uniqueId__: any

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

Readonly assignedSlot

assignedSlot: HTMLSlotElement | null

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

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

Readonly firstChild

firstChild: ChildNode | null

Returns the first child.

Readonly firstElementChild

firstElementChild: Element | null

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.

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

isInitalized

isInitalized: boolean = false

lang

lang: string

Readonly lastChild

lastChild: ChildNode | null

Returns the last child.

Readonly lastElementChild

lastElementChild: Element | null

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

Readonly localName

localName: string

Returns the local name.

Readonly namespaceURI

namespaceURI: string | null

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: Element | null

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

Readonly nextSibling

nextSibling: ChildNode | null

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: string | null

Optional nonce

nonce: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: Element | null

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

param

The event.

onanimationcancel

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

onanimationend

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

onanimationiteration

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

onanimationstart

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

onauxclick

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

onblur

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

Fires when the object loses the input focus.

param

The focus event.

oncancel

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

oncanplay

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

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

param

The event.

oncanplaythrough

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

onchange

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

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

param

The event.

onclick

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

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

param

The mouse event.

onclose

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

oncontextmenu

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

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

param

The mouse event.

oncopy

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

oncuechange

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

oncut

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

ondblclick

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

Fires when the user double-clicks the object.

param

The mouse event.

ondrag

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

Fires on the source object continuously during a drag operation.

param

The event.

ondragend

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

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

param

The event.

ondragenter

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

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

param

The drag event.

ondragexit

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

ondragleave

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

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

param

The drag event.

ondragover

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

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

param

The event.

ondragstart

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

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

param

The event.

ondrop

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

ondurationchange

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

Occurs when the duration attribute is updated.

param

The event.

onemptied

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

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

param

The event.

onended

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

Occurs when the end of playback is reached.

param

The event

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

param

The event.

onfocus

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

Fires when the object receives focus.

param

The event.

onfullscreenchange

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

onfullscreenerror

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

ongotpointercapture

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

oninput

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

oninvalid

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

onkeydown

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

Fires when the user presses a key.

param

The keyboard event

onkeypress

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

Fires when the user presses an alphanumeric key.

param

The event.

onkeyup

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

Fires when the user releases a key.

param

The keyboard event

onlifecycle

onlifecycle: Function

onload

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

Fires immediately after the browser loads the object.

param

The event.

onloadeddata

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

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

param

The event.

onloadedmetadata

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

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

param

The event.

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

param

The event.

onlostpointercapture

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

onmousedown

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

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

param

The mouse event.

onmouseenter

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

onmouseleave

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

onmousemove

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

Fires when the user moves the mouse over the object.

param

The mouse event.

onmouseout

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

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

param

The mouse event.

onmouseover

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

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

param

The mouse event.

onmouseup

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

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

param

The mouse event.

onpaste

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

onpause

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

Occurs when playback is paused.

param

The event.

onplay

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

Occurs when the play method is requested.

param

The event.

onplaying

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

Occurs when the audio or video has started playing.

param

The event.

onpointercancel

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

onpointerdown

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

onpointerenter

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

onpointerleave

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

onpointermove

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

onpointerout

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

onpointerover

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

onpointerup

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

onprogress

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

Occurs to indicate progress while downloading media data.

param

The event.

onratechange

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

Occurs when the playback rate is increased or decreased.

param

The event.

onreset

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

Fires when the user resets a form.

param

The event.

onresize

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

onscroll

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

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

param

The event.

onsecuritypolicyviolation

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

onseeked

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

Occurs when the seek operation ends.

param

The event.

onseeking

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

Occurs when the current playback position is moved.

param

The event.

onselect

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

Fires when the current selection changes.

param

The event.

onselectionchange

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

onselectstart

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

onstalled

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

Occurs when the download has stopped.

param

The event.

onsubmit

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

onsuspend

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

Occurs if the load operation has been intentionally halted.

param

The event.

ontimeupdate

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

Occurs to indicate the current playback position.

param

The event.

ontoggle

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

Optional ontouchcancel

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

Optional ontouchend

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

Optional ontouchmove

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

Optional ontouchstart

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

ontransitioncancel

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

ontransitionend

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

ontransitionrun

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

ontransitionstart

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

onvolumechange

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

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

param

The event.

onwaiting

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

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

param

The event.

onwheel

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

outerHTML

outerHTML: string

Readonly ownerDocument

ownerDocument: Document

Readonly parentElement

parentElement: HTMLElement | null

Returns the parent element.

Readonly parentNode

parentNode: (Node & ParentNode) | null

Returns the parent.

Readonly prefix

prefix: string | null

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: Element | null

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

Readonly previousSibling

previousSibling: ChildNode | null

Returns the previous sibling.

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: ShadowRoot | null

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: string | null

title

title: string

translate

translate: boolean

Static HTMLElement

HTMLElement: { constructor: any; prototype: HTMLElement }

Type declaration

Static Readonly [CustomElement_Symbol_Selector]

[CustomElement_Symbol_Selector]: string

Set by decorator {@link {CustomElement}}. It's the element's name in CSS selector style.

Static Readonly [ShadowDOM_Symbol_WithShadow]

[ShadowDOM_Symbol_WithShadow]: boolean

Set by decorator {@link {UseShadowDOM}}. A shadowed component is technically isolated.

Accessors

Protected currentLifeCycle

Protected data

  • get data(): P

Protected lifeCycleState

  • Promote the lifecycle changes:

    • first by a sync call of the LifeCycle method
    • second by dispatching the 'onlifecycle' event. Use addEventListener('lifecycle', ...) to catch the event.
    • third a property 'onLifecycle' is being called if a handler function is attached.

    Parameters

    Returns void

Static Protected observedAttributes

  • get observedAttributes(): 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
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
        • Parameters

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

after

  • after(...nodes: (string | Node)[]): 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.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

animate

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

    • keyframes: Keyframe[] | PropertyIndexedKeyframes | null
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes: (string | Node)[]): 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.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • appendChild<T>(newChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T

    Returns T

attachShadow

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

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

before

  • before(...nodes: (string | Node)[]): 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.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

blur

  • blur(): void
  • Returns void

click

  • click(): void
  • Returns void

cloneNode

  • cloneNode(deep?: boolean): Node
  • 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): HTMLElementTagNameMap[K] | null
  • closest<K>(selector: K): SVGElementTagNameMap[K] | null
  • closest<E>(selector: string): E | null
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selector: string

    Returns E | null

compareDocumentPosition

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

    Parameters

    • other: Node

    Returns number

contains

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

    Parameters

    • other: Node | null

    Returns boolean

Protected dispatch

  • dispatch(name: string, data: CustomEventInit): boolean
  • Call this method to dispatch a custom event. Returns the result of the event handler conform to default ECMAScript events.

    Parameters

    • name: string

      Dispatch a custom event bound to the current component.

    • data: CustomEventInit

      Some custom data and settings.

    Returns boolean

dispatchEvent

  • dispatchEvent(event: 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.

    Parameters

    • event: Event

    Returns boolean

Protected dispose

  • dispose(): void

focus

  • focus(options?: FocusOptions): void
  • Parameters

    • Optional options: FocusOptions

    Returns void

getAnimations

  • getAnimations(): Animation[]

getAttribute

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

    Parameters

    • qualifiedName: string

    Returns string | null

getAttributeNS

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns string | null

getAttributeNames

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

    Returns string[]

getAttributeNode

  • getAttributeNode(name: string): Attr | null
  • Parameters

    • name: string

    Returns Attr | null

getAttributeNodeNS

  • getAttributeNodeNS(namespaceURI: string, localName: string): Attr | null
  • Parameters

    • namespaceURI: string
    • localName: string

    Returns Attr | null

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

getClientRects

  • getClientRects(): DOMRectList

getElementsByClassName

  • getElementsByClassName(classNames: string): 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.

    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>
  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • 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(namespaceURI: string, localName: string): HTMLCollectionOf<Element>
  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: string
    • localName: string

    Returns HTMLCollectionOf<Element>

getRootNode

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

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

hasAttribute

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

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns boolean

hasAttributes

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

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • insertAdjacentElement(position: InsertPosition, insertedElement: Element): Element | null
  • Parameters

    • position: InsertPosition
    • insertedElement: Element

    Returns Element | null

insertAdjacentHTML

  • insertAdjacentHTML(where: InsertPosition, html: string): void
  • Parameters

    • where: InsertPosition
    • html: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where: InsertPosition, text: string): void
  • Parameters

    • where: InsertPosition
    • text: string

    Returns void

insertBefore

  • insertBefore<T>(newChild: T, refChild: Node | null): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: T
    • refChild: Node | null

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: string | null): boolean
  • Parameters

    • namespace: string | null

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: Node | null): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: Node | null

    Returns boolean

isSameNode

  • isSameNode(otherNode: Node | null): boolean
  • Parameters

    • otherNode: Node | null

    Returns boolean

Protected lifeCycle

lookupNamespaceURI

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

    • prefix: string | null

    Returns string | null

lookupPrefix

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

    • namespace: string | null

    Returns string | null

matches

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

    Parameters

    • selectors: string

    Returns boolean

msGetRegionContent

  • msGetRegionContent(): any

normalize

  • normalize(): void
  • 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
  • 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): HTMLElementTagNameMap[K] | null
  • querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null
  • querySelector<E>(selectors: string): E | null
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K] | null

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K] | null

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns E | null

querySelectorAll

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

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    • E: Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

Protected readAttribute

  • readAttribute(name: string, defaultValue?: any): any

releasePointerCapture

  • releasePointerCapture(pointerId: number): void

remove

  • remove(): void
  • Removes node.

    Returns void

removeAttribute

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

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

    Parameters

    • namespace: string | null
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr

removeChild

  • removeChild<T>(oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • oldChild: 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
  • Type parameters

    • K: keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
        • Parameters

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

Abstract render

  • render(): string

replaceChild

  • replaceChild<T>(newChild: Node, oldChild: T): T
  • Type parameters

    • T: Node

    Parameters

    • newChild: Node
    • oldChild: T

    Returns T

replaceWith

  • replaceWith(...nodes: (string | Node)[]): 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.

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

requestFullscreen

  • requestFullscreen(options?: FullscreenOptions): 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.

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(): void

scroll

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

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

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

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

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

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

Protected services

  • services<S>(serviceId: string): S

setAttribute

  • setAttribute(qualifiedName: string, value: string): void
  • 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: string | null, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

    • namespace: string | null
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): Attr | null
  • Parameters

    • attr: Attr

    Returns Attr | null

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): Attr | null

setData

  • setData(name: , newValue: any, noRender?: boolean): void
  • Change the state of the internal data object. If necessary, the component re-renders. Render can be suppressed. Omit the @param noRender at it renders on change. Set to true to suppress entirely. Set to false to enforce explicitly.

    Parameters

    • name:

      Name of the property. Must be defined in the generic P to assure being observed.

    • newValue: any

      The actual new value.

    • Optional noRender: boolean

      Prevent or enforce the re-rendering. Used if multiple attributes are being written and a render process for each is not required.

    Returns void

setPointerCapture

  • setPointerCapture(pointerId: number): void

Protected setup

  • setup(): Promise<void>

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): 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.

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean

Object literals

proxyAttributeHandler

proxyAttributeHandler: object

get

  • get(obj: P, prop: string): any

set

  • set(obj: P, prop: string, value: any, receiver: any): boolean

Generated using TypeDoc