Class Image

NostoImage is a custom element that renders an image with responsive capabilities using the unpic library. refer https://unpic.dev for more details.

Examples

Using with Shopify image URL

This example demonstrates basic image rendering using a Shopify CDN URL with fixed dimensions and center cropping. The componen utilizes the resizing and transformation capabilties of Shopify's Image CDN internally and renders a responsive img element internally.

<nosto-image src="https://cdn.shopify.com/static/sample-images/bath.jpeg" width="800" height="600" crop="center"></nosto-image>

Using with BigCommerce image URL

This shows how to use the component with BigCommerce image URLs. The component recognizes BigCommerce CDN patterns and applies appropriate image transformations for optimal loading performance.

<nosto-image src="https://cdn11.bigcommerce.com/s-hm8pjhul3k/products/4055/images/23603/7-15297__04892.1719977920.1280.1280.jpg" width="800" height="600"></nosto-image>

Using with responsive sizes attribute

This example demonstrates responsive image loading with the sizes attribute, which helps the browser choose the optimal image size based on viewport width. The aspect ratio is controlled rather than a fixed height, making it more flexible for responsive layouts.

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="800"
  aspect-ratio="1.5"
  alt="Product showcase image"
  sizes="(max-width: 768px) 100vw, (max-width: 1200px) 50vw, 33vw">
</nosto-image>

Using with custom breakpoints

This shows how to specify custom breakpoints for responsive image generation. Instead of using default breakpoints, you can define specific widths that match your design system or layout requirements.

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="800"
  aspect-ratio="1.5"
  alt="Product showcase image"
  breakpoints="[320, 640, 768, 1024, 1280]">
</nosto-image>

Using with unstyled attribute to prevent inline styles

This example shows how to use the unstyled attribute to prevent the component from applying inline styles to the image element. This is useful when you want to handle all styling through CSS classes instead of relying on the component's default styling.

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="800"
  height="600"
  unstyled
  alt="Product image without inline styles">
</nosto-image>

Using lazy loading for performance optimization

This example demonstrates using the loading="lazy" attribute to defer loading of images until they're near the viewport. This is particularly useful for images below the fold, improving initial page load performance by only loading images when needed.

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="800"
  height="600"
  loading="lazy"
  alt="Product image with lazy loading">
</nosto-image>

Using eager loading for critical images

This example shows how to use the loading="eager" attribute to prioritize immediate loading of critical images. This is useful for above-the-fold images or hero banners that should be visible as soon as possible.

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="1200"
  height="600"
  loading="eager"
  alt="Hero banner with eager loading">
</nosto-image>

Styling the inner img element using ::part()

The inner <img> element is exposed via part="img", allowing you to style it from outside the shadow DOM using CSS ::part() selectors. This is useful for applying custom styles like border-radius, filters, or other visual effects.

<style>
  nosto-image::part(img) {
    border-radius: 8px;
    filter: grayscale(50%);
    transition: filter 0.3s ease;
  }
  
  nosto-image:hover::part(img) {
    filter: grayscale(0%);
  }
</style>

<nosto-image
  src="https://cdn.shopify.com/static/sample-images/bath.jpeg"
  width="800"
  height="600"
  alt="Product image with custom styling">
</nosto-image>

Remarks

  • Supports only Shopify and BigCommerce image URLs.
  • Support for format, pad_color and quality to be added in the future.
  • The inner <img> element can be styled from outside the shadow DOM using the ::part(img) selector.

Hierarchy

  • NostoElement
    • Image

Constructors

constructor

Properties

accessKey accessKeyLabel alt? ariaAtomic ariaAutoComplete ariaBrailleLabel ariaBrailleRoleDescription ariaBusy ariaChecked ariaColCount ariaColIndex ariaColSpan ariaCurrent ariaDescription ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText aspectRatio? assignedSlot ATTRIBUTE_NODE attributes attributeStyleMap autocapitalize autofocus baseURI breakpoints? CDATA_SECTION_NODE childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth COMMENT_NODE contentEditable crop? dataset dir 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 draggable ELEMENT_NODE enterKeyHint ENTITY_NODE ENTITY_REFERENCE_NODE fetchpriority? firstChild firstElementChild height? hidden id inert innerHTML innerText inputMode isConnected isContentEditable lang lastChild lastElementChild layout? loading? localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? NOTATION_NODE offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforetoggle onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextlost oncontextmenu oncontextrestored oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText ownerDocument parentElement parentNode part popover prefix previousElementSibling previousSibling PROCESSING_INSTRUCTION_NODE role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot sizes? slot spellcheck src style tabIndex tagName TEXT_NODE textContent title translate unstyled? width?

Methods

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

Constructors

constructor

Properties

accessKey

accessKey: string

MDN Reference

ReadonlyaccessKeyLabel

accessKeyLabel: string

MDN Reference

Optionalalt

alt?: string

Alternative text for the image for accessibility purposes.

ariaAtomic

ariaAtomic: null | string

MDN Reference

ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

ariaBrailleLabel

ariaBrailleLabel: null | string

MDN Reference

ariaBrailleRoleDescription

ariaBrailleRoleDescription: null | string

MDN Reference

ariaBusy

ariaBusy: null | string

MDN Reference

ariaChecked

ariaChecked: null | string

MDN Reference

ariaColCount

ariaColCount: null | string

MDN Reference

ariaColIndex

ariaColIndex: null | string

MDN Reference

ariaColSpan

ariaColSpan: null | string

MDN Reference

ariaCurrent

ariaCurrent: null | string

MDN Reference

ariaDescription

ariaDescription: null | string

MDN Reference

ariaDisabled

ariaDisabled: null | string

MDN Reference

ariaExpanded

ariaExpanded: null | string

MDN Reference

ariaHasPopup

ariaHasPopup: null | string

MDN Reference

ariaHidden

ariaHidden: null | string

MDN Reference

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

ariaLabel

ariaLabel: null | string

MDN Reference

ariaLevel

ariaLevel: null | string

MDN Reference

ariaLive

ariaLive: null | string

MDN Reference

ariaModal

ariaModal: null | string

MDN Reference

ariaMultiLine

ariaMultiLine: null | string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

ariaOrientation

ariaOrientation: null | string

MDN Reference

ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

ariaPosInSet

ariaPosInSet: null | string

MDN Reference

ariaPressed

ariaPressed: null | string

MDN Reference

ariaReadOnly

ariaReadOnly: null | string

MDN Reference

ariaRequired

ariaRequired: null | string

MDN Reference

ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

ariaRowCount

ariaRowCount: null | string

MDN Reference

ariaRowIndex

ariaRowIndex: null | string

MDN Reference

ariaRowSpan

ariaRowSpan: null | string

MDN Reference

ariaSelected

ariaSelected: null | string

MDN Reference

ariaSetSize

ariaSetSize: null | string

MDN Reference

ariaSort

ariaSort: null | string

MDN Reference

ariaValueMax

ariaValueMax: null | string

MDN Reference

ariaValueMin

ariaValueMin: null | string

MDN Reference

ariaValueNow

ariaValueNow: null | string

MDN Reference

ariaValueText

ariaValueText: null | string

MDN Reference

OptionalaspectRatio

aspectRatio?: number

(aspect-ratio) - The aspect ratio of the image (width / height value).

ReadonlyassignedSlot

assignedSlot: null | HTMLSlotElement

MDN Reference

ReadonlyATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

Readonlyattributes

attributes: NamedNodeMap

MDN Reference

ReadonlyattributeStyleMap

attributeStyleMap: StylePropertyMap

MDN Reference

autocapitalize

autocapitalize: string

MDN Reference

autofocus

autofocus: boolean

MDN Reference

ReadonlybaseURI

baseURI: string

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

MDN Reference

Optionalbreakpoints

breakpoints?: number[]

Custom widths for responsive image generation. Default breakpoints are generated based on common screen sizes.

ReadonlyCDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

ReadonlychildElementCount

childElementCount: number

MDN Reference

ReadonlychildNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

Readonlychildren

children: HTMLCollection

Returns the child elements.

MDN Reference

ReadonlyclassList

classList: DOMTokenList

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

MDN Reference

className

className: string

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

MDN Reference

ReadonlyclientHeight

clientHeight: number

MDN Reference

ReadonlyclientLeft

clientLeft: number

MDN Reference

ReadonlyclientTop

clientTop: number

MDN Reference

ReadonlyclientWidth

clientWidth: number

MDN Reference

ReadonlyCOMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

contentEditable

contentEditable: string

MDN Reference

Optionalcrop

crop?: Crop

Shopify only. The crop of the image. Can be "center", "left", "right", "top", or "bottom".

Readonlydataset

dataset: DOMStringMap

MDN Reference

dir

dir: string

MDN Reference

ReadonlyDOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

ReadonlyDOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

ReadonlyDOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

ReadonlyDOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

ReadonlyDOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

ReadonlyDOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

ReadonlyDOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

draggable

draggable: boolean

MDN Reference

ReadonlyELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

enterKeyHint

enterKeyHint: string

MDN Reference

ReadonlyENTITY_NODE

ENTITY_NODE: 6

ReadonlyENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

Optionalfetchpriority

fetchpriority?: "high" | "low" | "auto"

(fetch-priority) - Provides a hint to the browser about the priority of this image relative to other images.

ReadonlyfirstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

ReadonlyfirstElementChild

firstElementChild: null | Element

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

MDN Reference

Optionalheight

height?: number

The height of the image in pixels.

hidden

hidden: boolean

MDN Reference

id

id: string

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

MDN Reference

inert

inert: boolean

MDN Reference

innerHTML

innerHTML: string

MDN Reference

innerText

innerText: string

MDN Reference

inputMode

inputMode: string

MDN Reference

ReadonlyisConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

ReadonlyisContentEditable

isContentEditable: boolean

MDN Reference

lang

lang: string

MDN Reference

ReadonlylastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

ReadonlylastElementChild

lastElementChild: null | Element

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

MDN Reference

Optionallayout

layout?: Layout

The layout of the image. Can be "fixed", "constrained", or "fullWidth".

Optionalloading

loading?: "lazy" | "eager"

The loading behavior of the image. Use "lazy" for lazy loading or "eager" for immediate loading.

ReadonlylocalName

localName: string

Returns the local name.

MDN Reference

ReadonlynamespaceURI

namespaceURI: null | string

Returns the namespace.

MDN Reference

ReadonlynextElementSibling

nextElementSibling: null | Element

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

MDN Reference

ReadonlynextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

ReadonlynodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

ReadonlynodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

Optionalnonce

nonce?: string

MDN Reference

ReadonlyNOTATION_NODE

NOTATION_NODE: 12

ReadonlyoffsetHeight

offsetHeight: number

MDN Reference

ReadonlyoffsetLeft

offsetLeft: number

MDN Reference

ReadonlyoffsetParent

offsetParent: null | Element

MDN Reference

ReadonlyoffsetTop

offsetTop: number

MDN Reference

ReadonlyoffsetWidth

offsetWidth: number

MDN Reference

onabort

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

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onanimationcancel

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

MDN Reference

onanimationend

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

MDN Reference

onanimationiteration

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

MDN Reference

onanimationstart

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

MDN Reference

onauxclick

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

MDN Reference

onbeforeinput

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

MDN Reference

onbeforetoggle

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

MDN Reference

onblur

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

Fires when the object loses the input focus.

Param: ev

The focus event.

MDN Reference

oncancel

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

MDN Reference

oncanplay

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

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

Param: ev

The event.

MDN Reference

oncanplaythrough

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

MDN Reference

onchange

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

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

Param: ev

The event.

MDN Reference

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.

MDN Reference

onclose

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

MDN Reference

oncontextlost

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

MDN Reference

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.

MDN Reference

oncontextrestored

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

MDN Reference

oncopy

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

MDN Reference

oncuechange

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

MDN Reference

oncut

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

MDN Reference

ondblclick

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

Fires when the user double-clicks the object.

Param: ev

The mouse event.

MDN Reference

ondrag

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

Fires on the source object continuously during a drag operation.

Param: ev

The event.

MDN Reference

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.

MDN Reference

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.

MDN Reference

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.

MDN Reference

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.

MDN Reference

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.

MDN Reference

ondrop

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

MDN Reference

ondurationchange

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

Occurs when the duration attribute is updated.

Param: ev

The event.

MDN Reference

onemptied

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

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

Param: ev

The event.

MDN Reference

onended

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

Occurs when the end of playback is reached.

Param: ev

The event

MDN Reference

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus

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

Fires when the object receives focus.

Param: ev

The event.

MDN Reference

onformdata

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

MDN Reference

onfullscreenchange

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

MDN Reference

onfullscreenerror

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

MDN Reference

ongotpointercapture

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

MDN Reference

oninput

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

MDN Reference

oninvalid

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

MDN Reference

onkeydown

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

Fires when the user presses a key.

Param: ev

The keyboard event

MDN Reference

onkeypress

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

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

MDN Reference

onkeyup

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

Fires when the user releases a key.

Param: ev

The keyboard event

MDN Reference

onload

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

Fires immediately after the browser loads the object.

Param: ev

The event.

MDN Reference

onloadeddata

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

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

Param: ev

The event.

MDN Reference

onloadedmetadata

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

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

Param: ev

The event.

MDN Reference

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

MDN Reference

onlostpointercapture

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

MDN Reference

onmousedown

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

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

Param: ev

The mouse event.

MDN Reference

onmouseenter

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

MDN Reference

onmouseleave

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

MDN Reference

onmousemove

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

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

MDN Reference

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.

MDN Reference

onmouseover

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

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

Param: ev

The mouse event.

MDN Reference

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.

MDN Reference

onpaste

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

MDN Reference

onpause

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

Occurs when playback is paused.

Param: ev

The event.

MDN Reference

onplay

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

Occurs when the play method is requested.

Param: ev

The event.

MDN Reference

onplaying

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

Occurs when the audio or video has started playing.

Param: ev

The event.

MDN Reference

onpointercancel

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

MDN Reference

onpointerdown

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

MDN Reference

onpointerenter

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

MDN Reference

onpointerleave

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

MDN Reference

onpointermove

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

MDN Reference

onpointerout

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

MDN Reference

onpointerover

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

MDN Reference

onpointerup

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

MDN Reference

onprogress

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

Occurs to indicate progress while downloading media data.

Param: ev

The event.

MDN Reference

onratechange

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

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

MDN Reference

onreset

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

Fires when the user resets a form.

Param: ev

The event.

MDN Reference

onresize

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

MDN Reference

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.

MDN Reference

onscrollend

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

MDN Reference

onsecuritypolicyviolation

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

MDN Reference

onseeked

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

Occurs when the seek operation ends.

Param: ev

The event.

MDN Reference

onseeking

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

Occurs when the current playback position is moved.

Param: ev

The event.

MDN Reference

onselect

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

Fires when the current selection changes.

Param: ev

The event.

MDN Reference

onselectionchange

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

MDN Reference

onselectstart

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

MDN Reference

onslotchange

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

MDN Reference

onstalled

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

Occurs when the download has stopped.

Param: ev

The event.

MDN Reference

onsubmit

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

MDN Reference

onsuspend

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

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

MDN Reference

ontimeupdate

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

Occurs to indicate the current playback position.

Param: ev

The event.

MDN Reference

ontoggle

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

MDN Reference

Optionalontouchcancel

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

MDN Reference

Optionalontouchend

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

MDN Reference

Optionalontouchmove

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

MDN Reference

Optionalontouchstart

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

MDN Reference

ontransitioncancel

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

MDN Reference

ontransitionend

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

MDN Reference

ontransitionrun

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

MDN Reference

ontransitionstart

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

MDN Reference

onvolumechange

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

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

Param: ev

The event.

MDN Reference

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.

MDN Reference

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

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

MDN Reference

outerHTML

outerHTML: string

MDN Reference

outerText

outerText: string

MDN Reference

ReadonlyownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

ReadonlyparentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

ReadonlyparentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

Readonlypart

part: DOMTokenList

MDN Reference

popover

popover: null | string

MDN Reference

Readonlyprefix

prefix: null | string

Returns the namespace prefix.

MDN Reference

ReadonlypreviousElementSibling

previousElementSibling: null | Element

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

MDN Reference

ReadonlypreviousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

ReadonlyPROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

role

role: null | string

ReadonlyscrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

ReadonlyscrollWidth

scrollWidth: number

MDN Reference

ReadonlyshadowRoot

shadowRoot: null | ShadowRoot

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

MDN Reference

Optionalsizes

sizes?: string

The sizes attribute for responsive images to help the browser choose the right image size.

slot

slot: string

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

MDN Reference

spellcheck

spellcheck: boolean

MDN Reference

src

src: string

The source URL of the image.

Readonlystyle

style: CSSStyleDeclaration

MDN Reference

tabIndex

tabIndex: number

MDN Reference

ReadonlytagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

ReadonlyTEXT_NODE

TEXT_NODE: 3

node is a Text node.

textContent

textContent: null | string

MDN Reference

title

title: string

MDN Reference

translate

translate: boolean

MDN Reference

Optionalunstyled

unstyled?: boolean

When present, prevents inline styles from being applied to the image element.

Optionalwidth

width?: number

The width of the image in pixels.

Methods

addEventListener

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

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void

    Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: 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.

    MDN Reference

    Parameters

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

    Returns void

animate

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

    MDN Reference

    Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optionaloptions: 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.

    MDN Reference

    Parameters

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

    Returns void

appendChild

  • appendChild<T extends Node>(node: T): T

    MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

attachInternals

  • attachInternals(): ElementInternals

    MDN Reference

    Returns ElementInternals

attachShadow

  • attachShadow(init: ShadowRootInit): ShadowRoot

    Creates a shadow root for element and returns it.

    MDN Reference

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

attributeChangedCallback

  • attributeChangedCallback(
        _: string,
        oldValue: null | string,
        newValue: null | string,
    ): void

    Parameters

    • _: string
    • oldValue: null | string
    • newValue: null | string

    Returns void

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.

    MDN Reference

    Parameters

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

    Returns void

blur

  • blur(): void

    MDN Reference

    Returns void

checkVisibility

  • checkVisibility(options?: CheckVisibilityOptions): boolean

    MDN Reference

    Parameters

    • Optionaloptions: CheckVisibilityOptions

    Returns boolean

click

  • click(): void

    MDN Reference

    Returns void

cloneNode

  • cloneNode(deep?: boolean): Node

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

    MDN Reference

    Parameters

    • Optionaldeep: boolean

    Returns Node

closest

  • closest<K extends keyof HTMLElementTagNameMap>(
        selector: K,
    ): null | HTMLElementTagNameMap[K]

    Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • closest<K extends keyof SVGElementTagNameMap>(
        selector: K,
    ): null | SVGElementTagNameMap[K]

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • closest<K extends keyof MathMLElementTagNameMap>(
        selector: K,
    ): null | MathMLElementTagNameMap[K]

    Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | MathMLElementTagNameMap[K]

  • closest<E extends Element = Element>(selectors: string): null | E

    Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

compareDocumentPosition

  • compareDocumentPosition(other: Node): number

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

    MDN Reference

    Parameters

    • other: Node

    Returns number

computedStyleMap

  • computedStyleMap(): StylePropertyMapReadOnly

    MDN Reference

    Returns StylePropertyMapReadOnly

connectedCallback

contains

  • contains(other: null | Node): boolean

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

    MDN Reference

    Parameters

    • other: null | Node

    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.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

focus

  • focus(options?: FocusOptions): void

    MDN Reference

    Parameters

    • Optionaloptions: FocusOptions

    Returns void

getAnimations

  • getAnimations(options?: GetAnimationsOptions): Animation[]

    MDN Reference

    Parameters

    • Optionaloptions: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName: string): null | string

    Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | string

getAttributeNames

  • getAttributeNames(): string[]

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

    MDN Reference

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName: string): null | Attr

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | Attr

getAttributeNodeNS

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

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

getAttributeNS

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

    Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

    MDN Reference

    Returns DOMRect

getClientRects

  • getClientRects(): DOMRectList

    MDN Reference

    Returns 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.

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

  • getElementsByTagName<K extends keyof HTMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementTagNameMap[K]>

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • getElementsByTagName<K extends keyof SVGElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<SVGElementTagNameMap[K]>

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • getElementsByTagName<K extends keyof MathMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<MathMLElementTagNameMap[K]>

    Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>

    Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1999/xhtml",
        localName: string,
    ): HTMLCollectionOf<HTMLElement>

    MDN Reference

    Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/2000/svg",
        localName: string,
    ): HTMLCollectionOf<SVGElement>

    Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        localName: string,
    ): HTMLCollectionOf<MathMLElement>

    Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • getElementsByTagNameNS(
        namespace: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>

    Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

getHTML

  • getHTML(options?: GetHTMLOptions): string

    MDN Reference

    Parameters

    • Optionaloptions: GetHTMLOptions

    Returns string

getRootNode

  • getRootNode(options?: GetRootNodeOptions): Node

    Returns node's root.

    MDN Reference

    Parameters

    • Optionaloptions: GetRootNodeOptions

    Returns Node

hasAttribute

  • hasAttribute(qualifiedName: string): boolean

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

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

    Returns true if element has an attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

    Returns true if element has attributes, and false otherwise.

    MDN Reference

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

    Returns whether node has children.

    MDN Reference

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean

    MDN Reference

    Parameters

    • pointerId: number

    Returns boolean

hidePopover

  • hidePopover(): void

    MDN Reference

    Returns void

insertAdjacentElement

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

    MDN Reference

    Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

insertAdjacentHTML

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

    MDN Reference

    Parameters

    • position: InsertPosition
    • string: string

    Returns void

insertAdjacentText

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

    MDN Reference

    Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

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

    MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace: null | string): boolean

    MDN Reference

    Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: null | Node): boolean

    Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • isSameNode(otherNode: null | Node): boolean

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

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

    MDN Reference

    Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

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

    MDN Reference

    Parameters

    • namespace: null | string

    Returns null | string

matches

  • matches(selectors: string): boolean

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

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

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

    MDN Reference

    Returns void

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.

    MDN Reference

    Parameters

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

    Returns void

querySelector

  • querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K]

    Returns the first element that is a descendant of node that matches selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K]

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K]

    Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | MathMLElementTagNameMap[K]

  • querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K]

    Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementDeprecatedTagNameMap[K]

    Deprecated

  • querySelector<E extends Element = Element>(selectors: string): null | E

    Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

querySelectorAll

  • querySelectorAll<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementTagNameMap[K]>

    Returns all element descendants of node that match selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • querySelectorAll<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): NodeListOf<SVGElementTagNameMap[K]>

    Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • querySelectorAll<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<MathMLElementTagNameMap[K]>

    Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>

    Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId: number): void

    MDN Reference

    Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

    Removes node.

    MDN Reference

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr: Attr): Attr

    MDN Reference

    Parameters

    • attr: Attr

    Returns Attr

removeAttributeNS

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

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

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeChild

  • removeChild<T extends Node>(child: T): T

    MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

removeEventListener

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

    Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void

    Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

replaceChild

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

    MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

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

    Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

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

    MDN Reference

    Parameters

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

    Returns void

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.

    MDN Reference

    Parameters

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

    MDN Reference

    Parameters

    • Optionaloptions: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(options?: PointerLockOptions): Promise<void>

    MDN Reference

    Parameters

    • Optionaloptions: PointerLockOptions

    Returns Promise<void>

scroll

  • scroll(options?: ScrollToOptions): void

    MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scroll(x: number, y: number): void

    Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void

    MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollBy(x: number, y: number): void

    Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

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

    MDN Reference

    Parameters

    • Optionalarg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?: ScrollToOptions): void

    MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollTo(x: number, y: number): void

    Parameters

    • x: number
    • y: number

    Returns void

setAttribute

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

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

    MDN Reference

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): null | Attr

    MDN Reference

    Parameters

    • attr: Attr

    Returns null | Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): null | Attr

    MDN Reference

    Parameters

    • attr: Attr

    Returns null | Attr

setAttributeNS

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

    Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    MDN Reference

    Parameters

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

    Returns void

setHTMLUnsafe

  • setHTMLUnsafe(html: string): void

    MDN Reference

    Parameters

    • html: string

    Returns void

setPointerCapture

  • setPointerCapture(pointerId: number): void

    MDN Reference

    Parameters

    • pointerId: number

    Returns void

showPopover

  • showPopover(): void

    MDN Reference

    Returns 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.

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

togglePopover

  • togglePopover(force?: boolean): boolean

    MDN Reference

    Parameters

    • Optionalforce: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean

    Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

Settings

Member Visibility

On This Page

Examples
Constructors
Properties
accessKeyaccessKeyLabelaltariaAtomicariaAutoCompleteariaBrailleLabelariaBrailleRoleDescriptionariaBusyariaCheckedariaColCountariaColIndexariaColSpanariaCurrentariaDescriptionariaDisabledariaExpandedariaHasPopupariaHiddenariaInvalidariaKeyShortcutsariaLabelariaLevelariaLiveariaModalariaMultiLineariaMultiSelectableariaOrientationariaPlaceholderariaPosInSetariaPressedariaReadOnlyariaRequiredariaRoleDescriptionariaRowCountariaRowIndexariaRowSpanariaSelectedariaSetSizeariaSortariaValueMaxariaValueMinariaValueNowariaValueTextaspectRatioassignedSlotATTRIBUTE_NODEattributesattributeStyleMapautocapitalizeautofocusbaseURIbreakpointsCDATA_SECTION_NODEchildElementCountchildNodeschildrenclassListclassNameclientHeightclientLeftclientTopclientWidthCOMMENT_NODEcontentEditablecropdatasetdirDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEdraggableELEMENT_NODEenterKeyHintENTITY_NODEENTITY_REFERENCE_NODEfetchpriorityfirstChildfirstElementChildheighthiddenidinertinnerHTMLinnerTextinputModeisConnectedisContentEditablelanglastChildlastElementChildlayoutloadinglocalNamenamespaceURInextElementSiblingnextSiblingnodeNamenodeTypenodeValuenonceNOTATION_NODEoffsetHeightoffsetLeftoffsetParentoffsetTopoffsetWidthonabortonanimationcancelonanimationendonanimationiterationonanimationstartonauxclickonbeforeinputonbeforetoggleonbluroncanceloncanplayoncanplaythroughonchangeonclickoncloseoncontextlostoncontextmenuoncontextrestoredoncopyoncuechangeoncutondblclickondragondragendondragenterondragleaveondragoverondragstartondropondurationchangeonemptiedonendedonerroronfocusonformdataonfullscreenchangeonfullscreenerrorongotpointercaptureoninputoninvalidonkeydownonkeypressonkeyuponloadonloadeddataonloadedmetadataonloadstartonlostpointercaptureonmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponpasteonpauseonplayonplayingonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointeruponprogressonratechangeonresetonresizeonscrollonscrollendonsecuritypolicyviolationonseekedonseekingonselectonselectionchangeonselectstartonslotchangeonstalledonsubmitonsuspendontimeupdateontoggleontouchcancelontouchendontouchmoveontouchstartontransitioncancelontransitionendontransitionrunontransitionstartonvolumechangeonwaitingonwebkitanimationendonwebkitanimationiterationonwebkitanimationstartonwebkittransitionendonwheelouterHTMLouterTextownerDocumentparentElementparentNodepartpopoverprefixpreviousElementSiblingpreviousSiblingPROCESSING_INSTRUCTION_NODErolescrollHeightscrollLeftscrollTopscrollWidthshadowRootsizesslotspellchecksrcstyletabIndextagNameTEXT_NODEtextContenttitletranslateunstyledwidth
Methods
addEventListenerafteranimateappendappendChildattachInternalsattachShadowattributeChangedCallbackbeforeblurcheckVisibilityclickcloneNodeclosestcompareDocumentPositioncomputedStyleMapconnectedCallbackcontainsdispatchEventfocusgetAnimationsgetAttributegetAttributeNamesgetAttributeNodegetAttributeNodeNSgetAttributeNSgetBoundingClientRectgetClientRectsgetElementsByClassNamegetElementsByTagNamegetElementsByTagNameNSgetHTMLgetRootNodehasAttributehasAttributeNShasAttributeshasChildNodeshasPointerCapturehidePopoverinsertAdjacentElementinsertAdjacentHTMLinsertAdjacentTextinsertBeforeisDefaultNamespaceisEqualNodeisSameNodelookupNamespaceURIlookupPrefixmatchesnormalizeprependquerySelectorquerySelectorAllreleasePointerCaptureremoveremoveAttributeremoveAttributeNoderemoveAttributeNSremoveChildremoveEventListenerreplaceChildreplaceChildrenreplaceWithrequestFullscreenrequestPointerLockscrollscrollByscrollIntoViewscrollTosetAttributesetAttributeNodesetAttributeNodeNSsetAttributeNSsetHTMLUnsafesetPointerCaptureshowPopovertoggleAttributetogglePopoverwebkitMatchesSelector