A button that can be toggled on and off

Hierarchy

  • Component
    • Pin

Configuration

Events

Operations

Other

accessKey accessKeyLabel autocapitalize dir draggable hidden inert innerText lang offsetHeight offsetLeft offsetParent offsetTop offsetWidth outerText popover spellcheck title translate attachInternals click hidePopover showPopover togglePopover addEventListener removeEventListener attributes classList className clientHeight clientLeft clientTop clientWidth id localName namespaceURI onfullscreenchange onfullscreenerror outerHTML ownerDocument part prefix scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot tagName attachShadow checkVisibility closest computedStyleMap getAttribute getAttributeNS getAttributeNames getAttributeNode getAttributeNodeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS hasAttribute hasAttributeNS hasAttributes hasPointerCapture insertAdjacentElement insertAdjacentHTML insertAdjacentText matches releasePointerCapture removeAttribute removeAttributeNS removeAttributeNode requestFullscreen requestPointerLock scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNS setAttributeNode setAttributeNodeNS setPointerCapture toggleAttribute webkitMatchesSelector baseURI childNodes firstChild isConnected lastChild nextSibling nodeName nodeType nodeValue parentElement parentNode previousSibling textContent appendChild cloneNode compareDocumentPosition contains getRootNode hasChildNodes insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix normalize removeChild replaceChild ELEMENT_NODE ATTRIBUTE_NODE TEXT_NODE CDATA_SECTION_NODE ENTITY_REFERENCE_NODE ENTITY_NODE PROCESSING_INSTRUCTION_NODE COMMENT_NODE DOCUMENT_NODE DOCUMENT_TYPE_NODE DOCUMENT_FRAGMENT_NODE NOTATION_NODE DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_PRECEDING DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC dispatchEvent ariaAtomic ariaAutoComplete 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 role animate getAnimations after before remove replaceWith innerHTML nextElementSibling previousElementSibling childElementCount children firstElementChild lastElementChild append prepend querySelector querySelectorAll replaceChildren assignedSlot attributeStyleMap style contentEditable enterKeyHint inputMode isContentEditable onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforetoggle onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata 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 autofocus dataset nonce? tabIndex blur focus

State

Configuration

  • get Tag(): string
  • The tag name of the component

    Returns string

Events

  • set onhide(handler): void
  • Triggered via .hide()

    Parameters

    • handler: Handler

    Returns void

  • set onshow(handler): void
  • Triggered via .show()

    Parameters

    • handler: Handler

    Returns void

  • set onpin(handler): void
  • Triggered via .on()

    Parameters

    • handler: Handler

    Returns void

  • set onunpin(handler): void
  • Triggered via .off()

    Parameters

    • handler: Handler

    Returns void

  • Add a handler to all events at the same time or to a specific event

    Parameters

    • type: string
    • handler: Handler

    Returns void

Operations

  • Change the visibility of the button to no

    Returns "no"

  • Change the visibility of the button to yes

    Returns "yes"

  • Change the state of the button to on

    Returns "pinned"

  • Change the state of the button to off

    Returns "unpinned"

  • Toggle the state of the button

    Returns "pinned" | "unpinned"

Other

accessKey: string
accessKeyLabel: string
autocapitalize: string
dir: string
draggable: boolean
hidden: boolean
inert: boolean
innerText: string
lang: string
offsetHeight: number
offsetLeft: number
offsetParent: Element
offsetTop: number
offsetWidth: number
outerText: string
popover: string
spellcheck: boolean
title: string
translate: boolean
  • Returns ElementInternals

  • Returns void

  • Returns void

  • Returns void

  • Parameters

    • Optional force: boolean

    Returns boolean

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

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

    Returns void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

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

    Returns void

attributes: NamedNodeMap
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: string

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

MDN Reference

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
id: string

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

MDN Reference

localName: string

Returns the local name.

MDN Reference

namespaceURI: string

Returns the namespace.

MDN Reference

onfullscreenchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

outerHTML: string
ownerDocument: Document
part: DOMTokenList
prefix: string

Returns the namespace prefix.

MDN Reference

scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: ShadowRoot

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

MDN Reference

slot: string

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

MDN Reference

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

  • Creates a shadow root for element and returns it.

    MDN Reference

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Parameters

    • Optional options: CheckVisibilityOptions

    Returns boolean

  • 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 HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns MathMLElementTagNameMap[K]

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

  • Returns StylePropertyMapReadOnly

  • 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 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: string
    • localName: string

    Returns string

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

    MDN Reference

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

  • Returns DOMRect

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

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

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

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • Parameters

    • qualifiedName: string

    Returns 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: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

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

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns boolean

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

    MDN Reference

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

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

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

  • Parameters

    • pointerId: number

    Returns void

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

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

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns void

  • Parameters

    • attr: Attr

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

    MDN Reference

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

  • Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns 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

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

    MDN Reference

    Parameters

    • namespace: string
    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • pointerId: number

    Returns void

  • 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
    • Optional force: boolean

    Returns boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

baseURI: string

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

MDN Reference

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

firstChild: ChildNode

Returns the first child.

MDN Reference

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild: ChildNode

Returns the last child.

MDN Reference

nextSibling: ChildNode

Returns the next sibling.

MDN Reference

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

nodeType: number

Returns the type of node.

MDN Reference

nodeValue: string
parentElement: HTMLElement

Returns the parent element.

MDN Reference

parentNode: ParentNode

Returns the parent.

MDN Reference

previousSibling: ChildNode

Returns the previous sibling.

MDN Reference

textContent: string
  • Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

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

    MDN Reference

    Parameters

    • Optional deep: boolean

    Returns Node

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

    MDN Reference

    Parameters

    • other: Node

    Returns number

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

    MDN Reference

    Parameters

    • other: Node

    Returns boolean

  • Returns node's root.

    MDN Reference

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

  • Returns whether node has children.

    MDN Reference

    Returns boolean

  • Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: Node

    Returns T

  • Parameters

    • namespace: string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • prefix: string

    Returns string

  • Parameters

    • namespace: string

    Returns string

  • 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

  • Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

  • Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

ELEMENT_NODE: 1

node is an element.

ATTRIBUTE_NODE: 2
TEXT_NODE: 3

node is a Text node.

CDATA_SECTION_NODE: 4

node is a CDATASection node.

ENTITY_REFERENCE_NODE: 5
ENTITY_NODE: 6
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

COMMENT_NODE: 8

node is a Comment node.

DOCUMENT_NODE: 9

node is a document.

DOCUMENT_TYPE_NODE: 10

node is a doctype.

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

NOTATION_NODE: 12
DOCUMENT_POSITION_DISCONNECTED: 1

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

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
  • 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

ariaAtomic: string
ariaAutoComplete: string
ariaBusy: string
ariaChecked: string
ariaColCount: string
ariaColIndex: string
ariaColSpan: string
ariaCurrent: string
ariaDescription: string
ariaDisabled: string
ariaExpanded: string
ariaHasPopup: string
ariaHidden: string
ariaInvalid: string
ariaKeyShortcuts: string
ariaLabel: string
ariaLevel: string
ariaLive: string
ariaModal: string
ariaMultiLine: string
ariaMultiSelectable: string
ariaOrientation: string
ariaPlaceholder: string
ariaPosInSet: string
ariaPressed: string
ariaReadOnly: string
ariaRequired: string
ariaRoleDescription: string
ariaRowCount: string
ariaRowIndex: string
ariaRowSpan: string
ariaSelected: string
ariaSetSize: string
ariaSort: string
ariaValueMax: string
ariaValueMin: string
ariaValueNow: string
ariaValueText: string
role: string
  • Parameters

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

    Returns Animation

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

  • 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

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

    Returns 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

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

    Returns void

  • Removes node.

    MDN Reference

    Returns 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

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

    Returns void

innerHTML: string
nextElementSibling: Element

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

MDN Reference

previousElementSibling: Element

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

MDN Reference

childElementCount: number
children: HTMLCollection

Returns the child elements.

MDN Reference

firstElementChild: Element

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

MDN Reference

lastElementChild: Element

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

MDN Reference

  • 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

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

    Returns 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

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

    Returns void

  • 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 HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementDeprecatedTagNameMap[K]

    Deprecated

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

  • Returns all element descendants of node that match selectors.

    MDN Reference

    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

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

  • 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

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

    Returns void

assignedSlot: HTMLSlotElement
attributeStyleMap: StylePropertyMap
style: CSSStyleDeclaration
contentEditable: string
enterKeyHint: string
inputMode: string
isContentEditable: boolean
onabort: ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onanimationcancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onbeforetoggle: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onblur: ((this, ev) => any)

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

        MDN Reference

      Returns any

oncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

oncanplaythrough: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onclick: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onclose: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

oncopy: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick: ((this, ev) => any)

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

ondrag: ((this, ev) => any)

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ondragend: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ondragenter: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragleave: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragover: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ondragstart: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ondrop: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange: ((this, ev) => any)

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onemptied: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onended: ((this, ev) => any)

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus: ((this, ev) => any)

Fires when the object receives focus.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onformdata: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

ongotpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown: ((this, ev) => any)

Fires when the user presses a key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onkeypress: ((this, ev) => any)

Fires when the user presses an alphanumeric key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

Deprecated

MDN Reference

onkeyup: ((this, ev) => any)

Fires when the user releases a key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onload: ((this, ev) => any)

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onloadeddata: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onloadedmetadata: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onloadstart: ((this, ev) => any)

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onlostpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseenter: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove: ((this, ev) => any)

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseout: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseover: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseup: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onpaste: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause: ((this, ev) => any)

Occurs when playback is paused.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onplay: ((this, ev) => any)

Occurs when the play method is requested.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onplaying: ((this, ev) => any)

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onpointercancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress: ((this, ev) => any)

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

        MDN Reference

      Returns any

onratechange: ((this, ev) => any)

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onreset: ((this, ev) => any)

Fires when the user resets a form.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onresize: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onscrollend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onsecuritypolicyviolation: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked: ((this, ev) => any)

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onseeking: ((this, ev) => any)

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onselect: ((this, ev) => any)

Fires when the current selection changes.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onselectionchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled: ((this, ev) => any)

Occurs when the download has stopped.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onsubmit: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend: ((this, ev) => any)

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ontimeupdate: ((this, ev) => any)

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

ontoggle: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

ontouchcancel?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchend?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchmove?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchstart?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onwaiting: ((this, ev) => any)

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

onwebkitanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

autofocus: boolean
dataset: DOMStringMap
nonce?: string
tabIndex: number
  • Returns void

  • Parameters

    • Optional options: FocusOptions

    Returns void

State

  • get visible(): Visibility
  • Get and Sets the visibility of the button

    Returns Visibility

  • set visible(visible): void
  • Parameters

    Returns void

  • get state(): States
  • Get or Set state of the component

    Returns States

  • set state(state): void
  • Parameters

    Returns void