Interface ComponentElement<T>

An element the component can be bound to.

Such element may contain a component slot containing a bound component context.

Type Parameters

  • T extends object = any

    A type of the bound component.

Hierarchy

  • Element
    • ComponentElement

Properties

ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE PROCESSING_INSTRUCTION_NODE TEXT_NODE [ComponentSlot__symbol]? ariaAtomic ariaAutoComplete ariaBusy ariaChecked ariaColCount ariaColIndex ariaColIndexText ariaColSpan ariaCurrent ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowIndexText ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot attributes baseURI childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth firstChild firstElementChild id innerHTML isConnected lastChild lastElementChild localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue onfullscreenchange onfullscreenerror outerHTML ownerDocument parentElement parentNode part prefix previousElementSibling previousSibling role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot tagName textContent

Methods

addEventListener after animate append appendChild attachShadow before cloneNode closest compareDocumentPosition contains dispatchEvent getAnimations getAttribute getAttributeNS getAttributeNames getAttributeNode getAttributeNodeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS getRootNode hasAttribute hasAttributeNS hasAttributes hasChildNodes hasPointerCapture insertAdjacentElement insertAdjacentHTML insertAdjacentText insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix matches normalize prepend querySelector querySelectorAll releasePointerCapture remove removeAttribute removeAttributeNS removeAttributeNode removeChild removeEventListener replaceChild replaceChildren replaceWith requestFullscreen requestPointerLock scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNS setAttributeNode setAttributeNodeNS setPointerCapture toggleAttribute webkitMatchesSelector

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.

Optional [ComponentSlot__symbol]

[ComponentSlot__symbol]?: ComponentSlot<T>

A component slot instance.

A ComponentSlot.of function may be used to access the slot instance, or construct it when necessary.

ariaAtomic

ariaAtomic: null | string

ariaAutoComplete

ariaAutoComplete: null | string

ariaBusy

ariaBusy: null | string

ariaChecked

ariaChecked: null | string

ariaColCount

ariaColCount: null | string

ariaColIndex

ariaColIndex: null | string

ariaColIndexText

ariaColIndexText: 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

ariaInvalid

ariaInvalid: 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

ariaRowIndexText

ariaRowIndexText: 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

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

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.

id

id: string

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

innerHTML

innerHTML: string

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

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

onfullscreenchange

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

onfullscreenerror

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

outerHTML

outerHTML: 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.

role

role: null | string

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.

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: null | string

Methods

addEventListener

  • Type Parameters

    • K extends keyof ElementEventMap

    Parameters

    • type: K
    • listener: ((this: Element, ev: ElementEventMap[K]) => any)
        • (this: Element, ev: ElementEventMap[K]): any

        • Parameters

          • this: Element
          • ev: ElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

after

  • 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

  • Parameters

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

    Returns Animation

append

  • 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

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

attachShadow

  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

before

  • 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

cloneNode

  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

closest

  • 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]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

compareDocumentPosition

  • Returns a bitmask indicating the position of other relative to node.

    Parameters

    • other: Node

    Returns number

contains

  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: null | Node

    Returns boolean

dispatchEvent

  • 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

getAnimations

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • 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

  • 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

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

getAttributeNode

  • Parameters

    • qualifiedName: string

    Returns null | Attr

getAttributeNodeNS

  • Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

getBoundingClientRect

  • Returns DOMRect

getClientRects

  • Returns DOMRectList

getElementsByClassName

  • 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

  • Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • 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

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

getRootNode

  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

hasAttribute

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • 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

  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

  • Returns whether node has children.

    Returns boolean

hasPointerCapture

  • Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

insertAdjacentHTML

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • Parameters

    • namespace: null | string

    Returns null | string

matches

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

normalize

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

prepend

  • 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

  • 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]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

querySelectorAll

  • Returns all element descendants of node that match selectors.

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • Parameters

    • pointerId: number

    Returns void

remove

  • Removes node.

    Returns void

removeAttribute

  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeAttributeNode

  • Parameters

    • attr: Attr

    Returns Attr

removeChild

  • Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

removeEventListener

  • Type Parameters

    • K extends keyof ElementEventMap

    Parameters

    • type: K
    • listener: ((this: Element, ev: ElementEventMap[K]) => any)
        • (this: Element, ev: ElementEventMap[K]): any

        • Parameters

          • this: Element
          • ev: ElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

replaceChild

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • 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

  • 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

  • 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

  • Returns void

scroll

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • 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

  • Parameters

    • attr: Attr

    Returns null | Attr

setAttributeNodeNS

  • Parameters

    • attr: Attr

    Returns null | Attr

setPointerCapture

  • Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • 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

  • Deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc