Skip to content

Interface WindowProps

Source: WindowView.tsx

Extends

Extended by

Indexable

[key: string]: unknown

Properties

active?

optional active: boolean

Whether the window is currently focused and should allow interactions


app?

optional app: App<WindowProps>

The app associated with the window

Inherited from

WindowOptions.app


close()?

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

Function that closes the window

Parameters

event?

Event

Returns

void


focus()?

optional focus: (event: Event, force?: boolean) => void

Function that brings the window in focus

Parameters

event

Event

force?

boolean

Returns

void


fullscreen?

optional fullscreen: boolean

Whether to start the window in fullscreen mode

Default

tsx
false

Overrides

WindowOptions.fullscreen


id?

optional id: string

The ID of the window

Inherited from

WindowOptions.id


index?

optional index: number

The depth value of the window


isFocused?

optional isFocused: boolean

Inherited from

WindowOptions.isFocused


lastInteraction?

optional lastInteraction: number

Inherited from

WindowOptions.lastInteraction


minimized?

optional minimized: boolean

Whether to start the window in minimized mode

Overrides

WindowOptions.minimized


onInteract()?

optional onInteract: () => void

Function that handles interactions with the window

Returns

void


options?

optional options: object

Inherited from

WindowOptions.options


position?

optional position: Vector2

The position of the window

Inherited from

WindowOptions.position


setIconUrl?

optional setIconUrl: Dispatch<SetStateAction<string>>

Function that sets the icon URL of the window


setTitle?

optional setTitle: Dispatch<SetStateAction<string>>

Function that sets the title of the window


size?

optional size: Vector2

The size of the window

Default

tsx
new Vector2(700, 400)

Inherited from

WindowOptions.size


standalone?

optional standalone: boolean

Whether the window is in standalone mode


toggleMinimized()?

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

Function that toggles the minimized mode of the window

Parameters

event?

Event

Returns

void

Built by Prozilla