Skip to main content

Class: ClientWindow

Defined in: packages/core/src/window/ClientWindow.ts:9

Client-side implementation of the Window utility API.

Extends​

Constructors​

Constructor​

new ClientWindow(): ClientWindow

Returns​

ClientWindow

Inherited from​

Window.constructor

Accessors​

$dependencies​

Get Signature​

get static $dependencies(): never[]

Defined in: packages/core/src/window/ClientWindow.ts:12

Returns​

never[]

Methods​

bindEventListener()​

bindEventListener<T, E, S>(eventTarget, event, listener, options, scope?): void

Defined in: packages/core/src/window/ClientWindow.ts:213

Registers the provided event listener to be executed when the specified event occurs on the specified event target.

Registering the same event listener for the same event on the same event target with the same useCapture flag value repeatedly has no effect.

Type Parameters​

T​

T extends EventTarget

E​

E extends Event

S​

S

Parameters​

eventTarget​

T

The event target.

event​

string

The name of the event.

listener​

(event) => void

The event listener.

options​

boolean | AddEventListenerOptions

scope?​

S

Returns​

void

Overrides​

Window.bindEventListener

createCustomEvent()​

createCustomEvent<T>(name, options): CustomEvent<T>

Defined in: packages/core/src/window/ClientWindow.ts:203

Create new instance of CustomEvent of the specified name and using the provided options.

Type Parameters​

T​

T

Parameters​

name​

string

Custom event's name (sometimes referred to as the event's type).

options​

CustomEventInit<T>

The custom event's options.

Returns​

CustomEvent<T>

The created custom event.

See​

https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent

Overrides​

Window.createCustomEvent

getBody()​

getBody(): HTMLElement | undefined

Defined in: packages/core/src/window/ClientWindow.ts:141

Returns the document's body element. The method returns undefined if invoked at the server-side.

Returns​

HTMLElement | undefined

The document's body element, or undefined if invoked at the server side.

Overrides​

Window.getBody

getDocument()​

getDocument(): Document

Defined in: packages/core/src/window/ClientWindow.ts:69

Returns the native document object representing any web page loaded in the browser and serves as an entry point into the web page's content which is the DOM tree at the client-side. The method returns undefined if used at the server-side.

Returns​

Document

The document object at the client-side, or undefined at the server-side.

Overrides​

Window.getDocument

getDomain()​

getDomain(): string

Defined in: packages/core/src/window/ClientWindow.ts:113

Returns the domain of the current document's URL as ${protocol}://${host}.

Returns​

string

The current domain.

Overrides​

Window.getDomain

getElementById()​

getElementById(id): HTMLElement | null

Defined in: packages/core/src/window/ClientWindow.ts:148

Returns the HTML element with the specified id attribute value.

Parameters​

id​

string

The value of the id attribute to look for.

Returns​

HTMLElement | null

The element with the specified id, or null if no such element exists.

Overrides​

Window.getElementById

getHistoryState()​

getHistoryState(): any

Defined in: packages/core/src/window/ClientWindow.ts:155

Returns the history state.

Returns​

any

The current history state

Overrides​

Window.getHistoryState

getHost()​

getHost(): string

Defined in: packages/core/src/window/ClientWindow.ts:120

Returns​

string

The current host.

Overrides​

Window.getHost

getPath()​

getPath(): string

Defined in: packages/core/src/window/ClientWindow.ts:127

Returns the path part of the current URL, including the query string.

Returns​

string

The path and query string parts of the current URL.

Overrides​

Window.getPath

getScrollX()​

getScrollX(): number

Defined in: packages/core/src/window/ClientWindow.ts:76

Returns the number of pixels the viewport is scrolled horizontally.

Returns​

number

The number of pixels the viewport is scrolled horizontally.

Overrides​

Window.getScrollX

getScrollY()​

getScrollY(): number

Defined in: packages/core/src/window/ClientWindow.ts:91

Returns the number of pixels the document is scrolled vertically.

Returns​

number

The number of pixels the document is scrolled vertically.

Overrides​

Window.getScrollY

getUrl()​

getUrl(): string

Defined in: packages/core/src/window/ClientWindow.ts:134

Returns​

string

The current document's URL.

Overrides​

Window.getUrl

getWindow()​

getWindow(): Window

Defined in: packages/core/src/window/ClientWindow.ts:62

Returns the native window object representing the global context at the client-side. The method returns undefined if used at the server-side.

Returns​

Window

The window object at the client-side, or undefined at the server-side.

Overrides​

Window.getWindow

hasSessionStorage()​

hasSessionStorage(): boolean

Defined in: packages/core/src/window/ClientWindow.ts:33

Returns true if the session storage is supported.

Returns​

boolean

true if the session storage is supported.

Overrides​

Window.hasSessionStorage

isClient()​

isClient(): boolean

Defined in: packages/core/src/window/ClientWindow.ts:19

Returns​

boolean

true if invoked at the client side.

Overrides​

Window.isClient

isCookieEnabled()​

isCookieEnabled(): boolean

Defined in: packages/core/src/window/ClientWindow.ts:26

Returns true if the cookies are set and processed with every HTTP request and response automatically by the environment.

Returns​

boolean

true if cookies are handled automatically by the environment.

Overrides​

Window.isCookieEnabled

pushState()​

pushState<T>(state, title, url?): void

Defined in: packages/core/src/window/ClientWindow.ts:185

Pushes a new state to the browser history. The method has no effect if the current browser does not support the history API (IE9).

Type Parameters​

T​

T

Parameters​

state​

T

A state object associated with the history item, preferably representing the page state.

title​

string

The page title related to the state. Note that this parameter is ignored by some browsers.

url?​

string

The new URL at which the state is available.

Returns​

void

Overrides​

Window.pushState

querySelector()​

querySelector<E>(selector): E | null

Defined in: packages/core/src/window/ClientWindow.ts:162

Returns the first element matching the specified CSS 3 selector.

Type Parameters​

E​

E extends Element = Element

Parameters​

selector​

string

The CSS selector.

Returns​

E | null

The first element matching the CSS selector or null if no such element exists.

Overrides​

Window.querySelector

querySelectorAll()​

querySelectorAll<E>(selector): NodeListOf<E>

Defined in: packages/core/src/window/ClientWindow.ts:169

Returns a node list of all elements matching the specified CSS 3 selector.

Type Parameters​

E​

E extends Element = Element

Parameters​

selector​

string

The CSS selector.

Returns​

NodeListOf<E>

A node list containing all elements matching the specified CSS selector.

Overrides​

Window.querySelectorAll

redirect()​

redirect(url): void

Defined in: packages/core/src/window/ClientWindow.ts:178

Performs a hard redirect (discarding the current JavaScript state) to the specified URL.

Parameters​

url​

string

The URL to which the browser will be redirected.

Returns​

void

Overrides​

Window.redirect

replaceState()​

replaceState<T>(state, title, url?): void

Defined in: packages/core/src/window/ClientWindow.ts:194

Replaces the current history entry. The method has no effect if the current browser does not support the history API (IE9).

Type Parameters​

T​

T

Parameters​

state​

T

A state object associated with the history item, preferably representing the page state.

title​

string

The page title related to the state. Note that this parameter is ignored by some browsers.

url?​

string

The new URL at which the state is available.

Returns​

void

Overrides​

Window.replaceState

scrollTo()​

scrollTo(x, y): void

Defined in: packages/core/src/window/ClientWindow.ts:106

Scrolls the viewport to the specified location (if possible).

Parameters​

x​

number

Horizontal scroll offset in pixels.

y​

number

Vertical scroll offset in pixels.

Returns​

void

Overrides​

Window.scrollTo

setTitle()​

setTitle(title): void

Defined in: packages/core/src/window/ClientWindow.ts:55

Sets the new page title of the document.

Parameters​

title​

string

The new page title.

Returns​

void

Overrides​

Window.setTitle

unbindEventListener()​

unbindEventListener<T, E, S>(eventTarget, event, listener, options, scope?): void

Defined in: packages/core/src/window/ClientWindow.ts:257

Deregister the provided event listener, so it will no longer we executed when the specified event occurs on the specified event target.

The method has no effect if the provided event listener is not registered to be executed at the specified event.

Type Parameters​

T​

T extends EventTarget

E​

E extends Event = Event

S​

S = any

Parameters​

eventTarget​

T

The event target.

event​

string

The name of the event.

listener​

(event) => void

The event listener.

options​

The useCapture flag value that was used when the listener was registered, or provide capture option through object options.

boolean | EventListenerOptions

scope?​

S

Returns​

void

Overrides​

Window.unbindEventListener