Interface WalletEventsWindow

Global window type for dispatching and listening for WindowAppReadyEvent and WindowRegisterWalletEvent.

import { WalletEventsWindow } from '@wallet-standard/base';

declare const window: WalletEventsWindow;
// OR
(window as WalletEventsWindow)
interface WalletEventsWindow {
    caches: CacheStorage;
    clientInformation: Navigator;
    closed: boolean;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    customElements: CustomElementRegistry;
    devicePixelRatio: number;
    document: Document;
    event: undefined | Event;
    external: External;
    frameElement: null | Element;
    frames: Window;
    history: History;
    indexedDB: IDBFactory;
    innerHeight: number;
    innerWidth: number;
    isSecureContext: boolean;
    length: number;
    localStorage: Storage;
    location: Location;
    locationbar: BarProp;
    menubar: BarProp;
    name: string;
    navigator: Navigator;
    onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onafterprint: null | ((this: WindowEventHandlers, ev: Event) => any);
    onanimationcancel: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationiteration: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationstart: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any);
    onbeforeprint: null | ((this: WindowEventHandlers, ev: Event) => any);
    onbeforetoggle: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onbeforeunload: null | ((this: WindowEventHandlers, ev: BeforeUnloadEvent) => any);
    onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onclose: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    ondevicemotion: null | ((this: Window, ev: DeviceMotionEvent) => any);
    ondeviceorientation: null | ((this: Window, ev: DeviceOrientationEvent) => any);
    ondeviceorientationabsolute: null | ((this: Window, ev: DeviceOrientationEvent) => any);
    ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onended: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onerror: OnErrorEventHandler;
    onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any);
    ongamepadconnected: null | ((this: WindowEventHandlers, ev: GamepadEvent) => any);
    ongamepaddisconnected: null | ((this: WindowEventHandlers, ev: GamepadEvent) => any);
    ongotpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onhashchange: null | ((this: WindowEventHandlers, ev: HashChangeEvent) => any);
    oninput: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onlanguagechange: null | ((this: WindowEventHandlers, ev: Event) => any);
    onload: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onlostpointercapture: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onmessage: null | ((this: WindowEventHandlers, ev: MessageEvent<any>) => any);
    onmessageerror: null | ((this: WindowEventHandlers, ev: MessageEvent<any>) => any);
    onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onoffline: null | ((this: WindowEventHandlers, ev: Event) => any);
    ononline: null | ((this: WindowEventHandlers, ev: Event) => any);
    onorientationchange: null | ((this: Window, ev: Event) => any);
    onpagehide: null | ((this: WindowEventHandlers, ev: PageTransitionEvent) => any);
    onpageshow: null | ((this: WindowEventHandlers, ev: PageTransitionEvent) => any);
    onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    onpause: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpopstate: null | ((this: WindowEventHandlers, ev: PopStateEvent) => any);
    onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any);
    onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onrejectionhandled: null | ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any);
    onreset: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onscrollend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onsecuritypolicyviolation: null | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any);
    onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselect: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onstorage: null | ((this: WindowEventHandlers, ev: StorageEvent) => any);
    onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any);
    onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontransitioncancel: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionend: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionrun: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionstart: null | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    onunhandledrejection: null | ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any);
    onunload: null | ((this: WindowEventHandlers, ev: Event) => any);
    onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationiteration: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkittransitionend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any);
    opener: any;
    orientation: number;
    origin: string;
    outerHeight: number;
    outerWidth: number;
    pageXOffset: number;
    pageYOffset: number;
    parent: Window;
    performance: Performance;
    personalbar: BarProp;
    screen: Screen;
    screenLeft: number;
    screenTop: number;
    screenX: number;
    screenY: number;
    scrollX: number;
    scrollY: number;
    scrollbars: BarProp;
    self: Window & typeof globalThis;
    sessionStorage: Storage;
    speechSynthesis: SpeechSynthesis;
    status: string;
    statusbar: BarProp;
    toolbar: BarProp;
    top: null | Window;
    visualViewport: null | VisualViewport;
    window: Window & typeof globalThis;
    addEventListener(type: "wallet-standard:app-ready", listener: ((event: WindowAppReadyEvent) => void)): void;
    addEventListener(type: "wallet-standard:register-wallet", listener: ((event: WindowRegisterWalletEvent) => void)): void;
    alert(message?: any): void;
    atob(data: string): string;
    blur(): void;
    btoa(data: string): string;
    cancelAnimationFrame(handle: number): void;
    cancelIdleCallback(handle: number): void;
    captureEvents(): void;
    clearInterval(id: undefined | number): void;
    clearTimeout(id: undefined | number): void;
    close(): void;
    confirm(message?: string): boolean;
    createImageBitmap(image: ImageBitmapSource, options?: ImageBitmapOptions): Promise<ImageBitmap>;
    createImageBitmap(image: ImageBitmapSource, sx: number, sy: number, sw: number, sh: number, options?: ImageBitmapOptions): Promise<ImageBitmap>;
    dispatchEvent(event: WindowAppReadyEvent): void;
    dispatchEvent(event: WindowRegisterWalletEvent): void;
    fetch(input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    focus(): void;
    getComputedStyle(elt: Element, pseudoElt?: null | string): CSSStyleDeclaration;
    getSelection(): null | Selection;
    matchMedia(query: string): MediaQueryList;
    moveBy(x: number, y: number): void;
    moveTo(x: number, y: number): void;
    open(url?: string | URL, target?: string, features?: string): null | Window;
    postMessage(message: any, targetOrigin: string, transfer?: Transferable[]): void;
    postMessage(message: any, options?: WindowPostMessageOptions): void;
    print(): void;
    prompt(message?: string, _default?: string): null | string;
    queueMicrotask(callback: VoidFunction): void;
    releaseEvents(): void;
    removeEventListener<K>(type: K, listener: ((this: Window, ev: WindowEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    reportError(e: any): void;
    requestAnimationFrame(callback: FrameRequestCallback): number;
    requestIdleCallback(callback: IdleRequestCallback, options?: IdleRequestOptions): number;
    resizeBy(x: number, y: number): void;
    resizeTo(width: number, height: number): void;
    scroll(options?: ScrollToOptions): void;
    scroll(x: number, y: number): void;
    scrollBy(options?: ScrollToOptions): void;
    scrollBy(x: number, y: number): void;
    scrollTo(options?: ScrollToOptions): void;
    scrollTo(x: number, y: number): void;
    setInterval(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
    setTimeout(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
    stop(): void;
    structuredClone<T>(value: T, options?: StructuredSerializeOptions): T;
}

Hierarchy

  • Omit<Window, "addEventListener" | "dispatchEvent">
    • WalletEventsWindow

Properties

caches clientInformation closed crossOriginIsolated crypto customElements devicePixelRatio document event external frameElement frames history indexedDB innerHeight innerWidth isSecureContext length localStorage location locationbar menubar name navigator onabort onafterprint onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforeprint onbeforetoggle onbeforeunload onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondevicemotion ondeviceorientation ondeviceorientationabsolute ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata ongamepadconnected ongamepaddisconnected ongotpointercapture onhashchange oninput oninvalid onkeydown onkeypress onkeyup onlanguagechange onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmessage onmessageerror onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onoffline ononline onorientationchange onpagehide onpageshow onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onpopstate onprogress onratechange onrejectionhandled onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onstorage onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onunhandledrejection onunload onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel opener orientation origin outerHeight outerWidth pageXOffset pageYOffset parent performance personalbar screen screenLeft screenTop screenX screenY scrollX scrollY scrollbars self sessionStorage speechSynthesis status statusbar toolbar top visualViewport window

Methods

addEventListener alert atob blur btoa cancelAnimationFrame cancelIdleCallback captureEvents clearInterval clearTimeout close confirm createImageBitmap dispatchEvent fetch focus getComputedStyle getSelection matchMedia moveBy moveTo open postMessage print prompt queueMicrotask releaseEvents removeEventListener reportError requestAnimationFrame requestIdleCallback resizeBy resizeTo scroll scrollBy scrollTo setInterval setTimeout stop structuredClone

Properties

Readonlycaches

caches: CacheStorage

Available only in secure contexts.

MDN Reference

ReadonlyclientInformation

clientInformation: Navigator

Deprecated

This is a legacy alias of navigator.

MDN Reference

Readonlyclosed

closed: boolean

Returns true if the window has been closed, false otherwise.

MDN Reference

ReadonlycrossOriginIsolated

crossOriginIsolated: boolean

MDN Reference

Readonlycrypto

crypto: Crypto

MDN Reference

ReadonlycustomElements

customElements: CustomElementRegistry

Defines a new custom element, mapping the given name to the given constructor as an autonomous custom element.

MDN Reference

ReadonlydevicePixelRatio

devicePixelRatio: number

MDN Reference

Readonlydocument

document: Document

MDN Reference

Readonlyevent

event: undefined | Event

Deprecated

MDN Reference

Readonlyexternal

external: External

Deprecated

MDN Reference

ReadonlyframeElement

frameElement: null | Element

MDN Reference

Readonlyframes

frames: Window

MDN Reference

Readonlyhistory

history: History

MDN Reference

ReadonlyindexedDB

indexedDB: IDBFactory

MDN Reference

ReadonlyinnerHeight

innerHeight: number

MDN Reference

ReadonlyinnerWidth

innerWidth: number

MDN Reference

ReadonlyisSecureContext

isSecureContext: boolean

MDN Reference

Readonlylength

length: number

MDN Reference

ReadonlylocalStorage

localStorage: Storage

MDN Reference

location

location: Location

Readonlylocationbar

locationbar: BarProp

Returns true if the location bar is visible; otherwise, returns false.

MDN Reference

Readonlymenubar

menubar: BarProp

Returns true if the menu bar is visible; otherwise, returns false.

MDN Reference

name

name: string

MDN Reference

Readonlynavigator

navigator: Navigator

MDN Reference

onabort

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

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onafterprint

onafterprint: null | ((this: WindowEventHandlers, ev: Event) => any)

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

onbeforeprint

onbeforeprint: null | ((this: WindowEventHandlers, ev: Event) => any)

MDN Reference

onbeforetoggle

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

MDN Reference

onbeforeunload

onbeforeunload: null | ((this: WindowEventHandlers, ev: BeforeUnloadEvent) => 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

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

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

ondevicemotion

ondevicemotion: null | ((this: Window, ev: DeviceMotionEvent) => any)

Available only in secure contexts.

MDN Reference

ondeviceorientation

ondeviceorientation: null | ((this: Window, ev: DeviceOrientationEvent) => any)

Available only in secure contexts.

MDN Reference

ondeviceorientationabsolute

ondeviceorientationabsolute: null | ((this: Window, ev: DeviceOrientationEvent) => any)

Available only in secure contexts.

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

ongamepadconnected

ongamepadconnected: null | ((this: WindowEventHandlers, ev: GamepadEvent) => any)

MDN Reference

ongamepaddisconnected

ongamepaddisconnected: null | ((this: WindowEventHandlers, ev: GamepadEvent) => any)

MDN Reference

ongotpointercapture

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

MDN Reference

onhashchange

onhashchange: null | ((this: WindowEventHandlers, ev: HashChangeEvent) => 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

onlanguagechange

onlanguagechange: null | ((this: WindowEventHandlers, ev: Event) => any)

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

onmessage

onmessage: null | ((this: WindowEventHandlers, ev: MessageEvent<any>) => any)

MDN Reference

onmessageerror

onmessageerror: null | ((this: WindowEventHandlers, ev: MessageEvent<any>) => 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

onoffline

onoffline: null | ((this: WindowEventHandlers, ev: Event) => any)

MDN Reference

ononline

ononline: null | ((this: WindowEventHandlers, ev: Event) => any)

MDN Reference

onorientationchange

onorientationchange: null | ((this: Window, ev: Event) => any)

Deprecated

MDN Reference

onpagehide

onpagehide: null | ((this: WindowEventHandlers, ev: PageTransitionEvent) => any)

MDN Reference

onpageshow

onpageshow: null | ((this: WindowEventHandlers, ev: PageTransitionEvent) => any)

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

onpopstate

onpopstate: null | ((this: WindowEventHandlers, ev: PopStateEvent) => any)

MDN Reference

onprogress

onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => 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

onrejectionhandled

onrejectionhandled: null | ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any)

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

onstorage

onstorage: null | ((this: WindowEventHandlers, ev: StorageEvent) => any)

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

onunhandledrejection

onunhandledrejection: null | ((this: WindowEventHandlers, ev: PromiseRejectionEvent) => any)

MDN Reference

onunload

onunload: null | ((this: WindowEventHandlers, ev: Event) => any)

Deprecated

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

opener

opener: any

MDN Reference

Readonlyorientation

orientation: number

Deprecated

MDN Reference

Readonlyorigin

origin: string

MDN Reference

ReadonlyouterHeight

outerHeight: number

MDN Reference

ReadonlyouterWidth

outerWidth: number

MDN Reference

ReadonlypageXOffset

pageXOffset: number

Deprecated

This is a legacy alias of scrollX.

MDN Reference

ReadonlypageYOffset

pageYOffset: number

Deprecated

This is a legacy alias of scrollY.

MDN Reference

Readonlyparent

parent: Window

Refers to either the parent WindowProxy, or itself.

It can rarely be null e.g. for contentWindow of an iframe that is already removed from the parent.

MDN Reference

Readonlyperformance

performance: Performance

MDN Reference

Readonlypersonalbar

personalbar: BarProp

Returns true if the personal bar is visible; otherwise, returns false.

MDN Reference

Readonlyscreen

screen: Screen

MDN Reference

ReadonlyscreenLeft

screenLeft: number

MDN Reference

ReadonlyscreenTop

screenTop: number

MDN Reference

ReadonlyscreenX

screenX: number

MDN Reference

ReadonlyscreenY

screenY: number

MDN Reference

ReadonlyscrollX

scrollX: number

MDN Reference

ReadonlyscrollY

scrollY: number

MDN Reference

Readonlyscrollbars

scrollbars: BarProp

Returns true if the scrollbars are visible; otherwise, returns false.

MDN Reference

Readonlyself

self: Window & typeof globalThis

MDN Reference

ReadonlysessionStorage

sessionStorage: Storage

MDN Reference

ReadonlyspeechSynthesis

speechSynthesis: SpeechSynthesis

MDN Reference

status

status: string

Deprecated

MDN Reference

Readonlystatusbar

statusbar: BarProp

Returns true if the status bar is visible; otherwise, returns false.

MDN Reference

Readonlytoolbar

toolbar: BarProp

Returns true if the toolbar is visible; otherwise, returns false.

MDN Reference

Readonlytop

top: null | Window

MDN Reference

ReadonlyvisualViewport

visualViewport: null | VisualViewport

MDN Reference

Readonlywindow

window: Window & typeof globalThis

MDN Reference

Methods

addEventListener

  • addEventListener(type, listener): void

  • Add a listener for WindowAppReadyEvent.

    Parameters

    Returns void

  • addEventListener(type, listener): void

  • Add a listener for WindowRegisterWalletEvent.

    Parameters

    Returns void

alert

  • alert(message?): void

  • MDN Reference

    Parameters

    • Optionalmessage: any

    Returns void

atob

  • atob(data): string

  • MDN Reference

    Parameters

    • data: string

    Returns string

blur

  • blur(): void

  • Returns void

    Deprecated

    MDN Reference

btoa

  • btoa(data): string

  • MDN Reference

    Parameters

    • data: string

    Returns string

cancelAnimationFrame

  • cancelAnimationFrame(handle): void

  • MDN Reference

    Parameters

    • handle: number

    Returns void

cancelIdleCallback

  • cancelIdleCallback(handle): void

  • MDN Reference

    Parameters

    • handle: number

    Returns void

captureEvents

  • captureEvents(): void

  • Returns void

    Deprecated

    MDN Reference

clearInterval

  • clearInterval(id): void

  • MDN Reference

    Parameters

    • id: undefined | number

    Returns void

clearTimeout

  • clearTimeout(id): void

  • MDN Reference

    Parameters

    • id: undefined | number

    Returns void

close

  • close(): void

  • Closes the window.

    MDN Reference

    Returns void

confirm

  • confirm(message?): boolean

  • MDN Reference

    Parameters

    • Optionalmessage: string

    Returns boolean

createImageBitmap

  • createImageBitmap(image, options?): Promise<ImageBitmap>

  • MDN Reference

    Parameters

    • image: ImageBitmapSource
    • Optionaloptions: ImageBitmapOptions

    Returns Promise<ImageBitmap>

  • createImageBitmap(image, sx, sy, sw, sh, options?): Promise<ImageBitmap>

  • Parameters

    • image: ImageBitmapSource
    • sx: number
    • sy: number
    • sw: number
    • sh: number
    • Optionaloptions: ImageBitmapOptions

    Returns Promise<ImageBitmap>

dispatchEvent

  • dispatchEvent(event): void

  • Dispatch a WindowAppReadyEvent.

    Parameters

    Returns void

  • dispatchEvent(event): void

  • Dispatch a WindowRegisterWalletEvent.

    Parameters

    Returns void

fetch

  • fetch(input, init?): Promise<Response>

  • MDN Reference

    Parameters

    • input: URL | RequestInfo
    • Optionalinit: RequestInit

    Returns Promise<Response>

focus

  • focus(): void

  • Moves the focus to the window's browsing context, if any.

    MDN Reference

    Returns void

getComputedStyle

  • getComputedStyle(elt, pseudoElt?): CSSStyleDeclaration

  • MDN Reference

    Parameters

    • elt: Element
    • OptionalpseudoElt: null | string

    Returns CSSStyleDeclaration

getSelection

  • getSelection(): null | Selection

  • MDN Reference

    Returns null | Selection

matchMedia

  • matchMedia(query): MediaQueryList

  • MDN Reference

    Parameters

    • query: string

    Returns MediaQueryList

moveBy

  • moveBy(x, y): void

  • MDN Reference

    Parameters

    • x: number
    • y: number

    Returns void

moveTo

  • moveTo(x, y): void

  • MDN Reference

    Parameters

    • x: number
    • y: number

    Returns void

open

  • open(url?, target?, features?): null | Window

  • MDN Reference

    Parameters

    • Optionalurl: string | URL
    • Optionaltarget: string
    • Optionalfeatures: string

    Returns null | Window

postMessage

  • postMessage(message, targetOrigin, transfer?): void

  • Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.

    Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.

    A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.

    If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".

    Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.

    MDN Reference

    Parameters

    • message: any
    • targetOrigin: string
    • Optionaltransfer: Transferable[]

    Returns void

  • postMessage(message, options?): void

  • Parameters

    • message: any
    • Optionaloptions: WindowPostMessageOptions

    Returns void

print

  • print(): void

  • MDN Reference

    Returns void

prompt

  • prompt(message?, _default?): null | string

  • MDN Reference

    Parameters

    • Optionalmessage: string
    • Optional_default: string

    Returns null | string

queueMicrotask

  • queueMicrotask(callback): void

  • MDN Reference

    Parameters

    • callback: VoidFunction

    Returns void

releaseEvents

  • releaseEvents(): void

  • Returns void

    Deprecated

    MDN Reference

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • type: K
    • listener: ((this: Window, ev: WindowEventMap[K]) => any)
        • (this, ev): any

        • Parameters

          • this: Window
          • ev: WindowEventMap[K]

          Returns any

    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Parameters

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

    Returns void

reportError

  • reportError(e): void

  • MDN Reference

    Parameters

    • e: any

    Returns void

requestAnimationFrame

  • requestAnimationFrame(callback): number

  • MDN Reference

    Parameters

    • callback: FrameRequestCallback

    Returns number

requestIdleCallback

  • requestIdleCallback(callback, options?): number

  • MDN Reference

    Parameters

    • callback: IdleRequestCallback
    • Optionaloptions: IdleRequestOptions

    Returns number

resizeBy

  • resizeBy(x, y): void

  • MDN Reference

    Parameters

    • x: number
    • y: number

    Returns void

resizeTo

  • resizeTo(width, height): void

  • MDN Reference

    Parameters

    • width: number
    • height: number

    Returns void

scroll

  • scroll(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollTo

  • scrollTo(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

setInterval

  • setInterval(handler, timeout?, ...arguments): number

  • MDN Reference

    Parameters

    • handler: TimerHandler
    • Optionaltimeout: number
    • Rest...arguments: any[]

    Returns number

setTimeout

  • setTimeout(handler, timeout?, ...arguments): number

  • MDN Reference

    Parameters

    • handler: TimerHandler
    • Optionaltimeout: number
    • Rest...arguments: any[]

    Returns number

stop

  • stop(): void

  • Cancels the document load.

    MDN Reference

    Returns void

structuredClone

  • structuredClone<T>(value, options?): T

  • MDN Reference

    Type Parameters

    • T = any

    Parameters

    • value: T
    • Optionaloptions: StructuredSerializeOptions

    Returns T

Settings

Member Visibility

On This Page

Properties
cachesclientInformationclosedcrossOriginIsolatedcryptocustomElementsdevicePixelRatiodocumenteventexternalframeElementframeshistoryindexedDBinnerHeightinnerWidthisSecureContextlengthlocalStoragelocationlocationbarmenubarnamenavigatoronabortonafterprintonanimationcancelonanimationendonanimationiterationonanimationstartonauxclickonbeforeinputonbeforeprintonbeforetoggleonbeforeunloadonbluroncanceloncanplayoncanplaythroughonchangeonclickoncloseoncontextmenuoncopyoncuechangeoncutondblclickondevicemotionondeviceorientationondeviceorientationabsoluteondragondragendondragenterondragleaveondragoverondragstartondropondurationchangeonemptiedonendedonerroronfocusonformdataongamepadconnectedongamepaddisconnectedongotpointercaptureonhashchangeoninputoninvalidonkeydownonkeypressonkeyuponlanguagechangeonloadonloadeddataonloadedmetadataonloadstartonlostpointercaptureonmessageonmessageerroronmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponofflineononlineonorientationchangeonpagehideonpageshowonpasteonpauseonplayonplayingonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointeruponpopstateonprogressonratechangeonrejectionhandledonresetonresizeonscrollonscrollendonsecuritypolicyviolationonseekedonseekingonselectonselectionchangeonselectstartonslotchangeonstalledonstorageonsubmitonsuspendontimeupdateontoggleontouchcancelontouchendontouchmoveontouchstartontransitioncancelontransitionendontransitionrunontransitionstartonunhandledrejectiononunloadonvolumechangeonwaitingonwebkitanimationendonwebkitanimationiterationonwebkitanimationstartonwebkittransitionendonwheelopenerorientationoriginouterHeightouterWidthpageXOffsetpageYOffsetparentperformancepersonalbarscreenscreenLeftscreenTopscreenXscreenYscrollXscrollYscrollbarsselfsessionStoragespeechSynthesisstatusstatusbartoolbartopvisualViewportwindow
Methods