jsMain.web.dom.Element.kt Maven / Gradle / Ivy

Go to download
// Automatically generated - do not modify!

package web.dom

import js.core.ReadonlyArray
import js.core.Void
import web.aria.ARIAMixin
import web.cssom.StylePropertyMapReadOnly
import web.events.Event
import web.events.EventHandler
import web.fullscreen.FullscreenOptions
import web.geometry.DOMRect
import web.geometry.DOMRectList
import web.html.*
import web.mathml.MATHML_NAMESPACE
import web.mathml.MathMLElement
import web.mathml.MathMLTagName
import web.scroll.ScrollIntoViewOptions
import web.scroll.ScrollToOptions
import web.svg.SVGElement
import web.svg.SVG_NAMESPACE
import web.svg.SvgTagName
import kotlin.js.Promise

abstract external class Element :
    Node,
    ARIAMixin,
    /* Animatable, */
    ChildNode,
    InnerHTML,
    NonDocumentTypeChildNode,
    ParentNode,
    Slottable {
    val attributes: NamedNodeMap

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

    /** Returns the value of element's class content attribute. Can be set to change it. */
    var className: String
    val clientHeight: Int
    val clientLeft: Int
    val clientTop: Int
    val clientWidth: Int

    /** Returns the value of element's id content attribute. Can be set to change it. */
    var id: String

    /** Returns the local name. */
    val localName: String

    /** Returns the namespace. */
    val namespaceURI: String?
    var onfullscreenchange: EventHandler?
    var onfullscreenerror: EventHandler?
    var outerHTML: String
    override val ownerDocument: Document
    val part: DOMTokenList

    /** Returns the namespace prefix. */
    val prefix: String?
    val scrollHeight: Int
    var scrollLeft: Double
    var scrollTop: Double
    val scrollWidth: Int

    /** Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. */
    val shadowRoot: ShadowRoot?

    /** Returns the value of element's slot content attribute. Can be set to change it. */
    var slot: String

    /** Returns the HTML-uppercased qualified name. */
    val tagName: String

    /** Creates a shadow root for element and returns it. */
    fun attachShadow(init: ShadowRootInit): ShadowRoot
    fun checkVisibility(options: CheckVisibilityOptions = definedExternally): Boolean

    /** Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. */
    fun  closest(selector: HtmlTagName): T?
    fun  closest(selector: SvgTagName): T?
    fun  closest(selector: MathMLTagName): T?
    fun closest(selector: String): Element?
    fun computedStyleMap(): StylePropertyMapReadOnly

    /** Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. */
    fun getAttribute(qualifiedName: String): String?

    /** Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. */
    fun getAttributeNS(
        namespace: String?,
        localName: String,
    ): String?

    /** Returns the qualified names of all element's attributes. Can contain duplicates. */
    fun getAttributeNames(): ReadonlyArray
    fun getAttributeNode(qualifiedName: String): Attr?
    fun getAttributeNodeNS(
        namespace: String?,
        localName: String,
    ): Attr?

    fun getBoundingClientRect(): DOMRect
    fun getClientRects(): DOMRectList

    /** 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. */
    fun getElementsByClassName(classNames: String): HTMLCollectionOf
    fun  getElementsByTagName(qualifiedName: HtmlTagName): HTMLCollectionOf
    fun  getElementsByTagName(qualifiedName: SvgTagName): HTMLCollectionOf
    fun  getElementsByTagName(qualifiedName: MathMLTagName): HTMLCollectionOf
    fun getElementsByTagName(qualifiedName: String): HTMLCollectionOf
    fun  getElementsByTagNameNS(
        namespaceURI: SVG_NAMESPACE,
        localName: SvgTagName,
    ): HTMLCollectionOf

    fun  getElementsByTagNameNS(
        namespaceURI: MATHML_NAMESPACE,
        localName: MathMLTagName,
    ): HTMLCollectionOf

    fun getElementsByTagNameNS(
        namespace: String?,
        localName: String,
    ): HTMLCollectionOf

    /** Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. */
    fun hasAttribute(qualifiedName: String): Boolean

    /** Returns true if element has an attribute whose namespace is namespace and local name is localName. */
    fun hasAttributeNS(
        namespace: String?,
        localName: String,
    ): Boolean

    /** Returns true if element has attributes, and false otherwise. */
    fun hasAttributes(): Boolean
    fun hasPointerCapture(pointerId: Number): Boolean
    fun insertAdjacentElement(
        where: InsertPosition,
        element: Element,
    ): Element?

    fun insertAdjacentHTML(
        position: InsertPosition,
        text: String,
    )

    fun insertAdjacentText(
        where: InsertPosition,
        data: String,
    )

    /** Returns true if matching selectors against element's root yields element, and false otherwise. */
    fun matches(selectors: String): Boolean
    fun releasePointerCapture(pointerId: Number)

    /** Removes element's first attribute whose qualified name is qualifiedName. */
    fun removeAttribute(qualifiedName: String)

    /** Removes element's attribute whose namespace is namespace and local name is localName. */
    fun removeAttributeNS(
        namespace: String?,
        localName: String,
    )

    fun removeAttributeNode(attr: Attr): Attr

    /**
     * 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.
     */
    fun requestFullscreen(options: FullscreenOptions = definedExternally): Promise
    fun requestPointerLock()
    fun scroll(options: ScrollToOptions = definedExternally)
    fun scroll(
        x: Number,
        y: Number,
    )

    fun scrollBy(options: ScrollToOptions = definedExternally)
    fun scrollBy(
        x: Number,
        y: Number,
    )

    fun scrollIntoView(options: ScrollIntoViewOptions = definedExternally)
    fun scrollTo(options: ScrollToOptions = definedExternally)
    fun scrollTo(
        x: Number,
        y: Number,
    )

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

    /** Sets the value of element's attribute whose namespace is namespace and local name is localName to value. */
    fun setAttributeNS(
        namespace: String?,
        qualifiedName: String,
        value: String,
    )

    fun setAttributeNode(attr: Attr): Attr?
    fun setAttributeNodeNS(attr: Attr): Attr?
    fun setPointerCapture(pointerId: Number)

    /**
     * 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.
     */
    fun toggleAttribute(
        qualifiedName: String,
        force: Boolean = definedExternally,
    ): Boolean
}