Interface WindowProps

Source: WindowView.tsx

Extends

• WindowOptions

Extended by

• WebViewProps

Indexable

[key: string]: unknown

Properties

fullscreen?

optional fullscreen?: boolean

Whether to start the window in fullscreen mode.

Default

false

Overrides

WindowOptions.fullscreen

---

setTitle?

optional setTitle?: Dispatch<SetStateAction<string>>

Function that sets the title of the window.

---

setIconUrl?

optional setIconUrl?: Dispatch<SetStateAction<string>>

Function that sets the icon URL of the window.

---

close?

optional close?: (event?: Event | UIEvent<HTMLElement, UIEvent>) => void

Function that closes the window.

Parameters

event?

Event | UIEvent<HTMLElement, UIEvent>

Returns

void

---

focus?

optional focus?: (event?: Event | UIEvent<HTMLElement, UIEvent>, force?: boolean) => void

Function that brings the window in focus.

Parameters

event?

Event | UIEvent<HTMLElement, UIEvent>

force?

boolean

Returns

void

---

active?

optional active?: boolean

Whether the window is currently focused and should allow interactions.

---

minimized?

optional minimized?: boolean

Whether to start the window in minimized mode.

Overrides

WindowOptions.minimized

---

toggleMinimized?

optional toggleMinimized?: (event?: Event) => void

Function that toggles the minimized mode of the window.

Parameters

event?

Event

Returns

void

---

index?

optional index?: number

The depth value of the window.

---

standalone?

optional standalone?: boolean

Whether the window is in standalone mode.

---

id?

optional id?: string

The ID of the window.

Inherited from

WindowOptions.id

---

app?

optional app?: App<WindowProps>

The app associated with the window.

Inherited from

WindowOptions.app

---

size?

optional size?: Vector2

The size of the window.

Default

new Vector2(700, 400)

Inherited from

WindowOptions.size

---

position?

optional position?: Vector2

The position of the window.

Inherited from

WindowOptions.position

---

options?

optional options?: object

Inherited from

WindowOptions.options

---

isFocused?

optional isFocused?: boolean

Inherited from

WindowOptions.isFocused

---

lastInteraction?

optional lastInteraction?: number

Inherited from

WindowOptions.lastInteraction