Skip to content

Interface WebViewProps

Source: WebView.tsx

Extends

Indexable

[key: string]: unknown

Properties

active?

optional active: boolean

Whether the window is currently focused and should allow interactions

Inherited from

WindowProps.active


app?

optional app: App<WindowProps>

The app associated with the window

Inherited from

WindowProps.app


close()?

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

Function that closes the window

Parameters

event?

Event

Returns

void

Inherited from

WindowProps.close


focus()?

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

Function that brings the window in focus

Parameters

event

Event

force?

boolean

Returns

void

Inherited from

WindowProps.focus


fullscreen?

optional fullscreen: boolean

Whether to start the window in fullscreen mode

Default

tsx
false

Inherited from

WindowProps.fullscreen


id?

optional id: string

The ID of the window

Inherited from

WindowProps.id


index?

optional index: number

The depth value of the window

Inherited from

WindowProps.index


isFocused?

optional isFocused: boolean

Inherited from

WindowProps.isFocused


lastInteraction?

optional lastInteraction: number

Inherited from

WindowProps.lastInteraction


minimized?

optional minimized: boolean

Whether to start the window in minimized mode

Inherited from

WindowProps.minimized


onInteract()?

optional onInteract: () => void

Function that handles interactions with the window

Returns

void

Inherited from

WindowProps.onInteract


options?

optional options: object

Inherited from

WindowProps.options


position?

optional position: Vector2

The position of the window

Inherited from

WindowProps.position


setIconUrl?

optional setIconUrl: Dispatch<SetStateAction<string>>

Function that sets the icon URL of the window

Inherited from

WindowProps.setIconUrl


setTitle?

optional setTitle: Dispatch<SetStateAction<string>>

Function that sets the title of the window

Inherited from

WindowProps.setTitle


size?

optional size: Vector2

The size of the window

Default

tsx
new Vector2(700, 400)

Inherited from

WindowProps.size


source?

optional source: string

The URL of the external application


standalone?

optional standalone: boolean

Whether the window is in standalone mode

Inherited from

WindowProps.standalone


title?

optional title: string


toggleMinimized()?

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

Function that toggles the minimized mode of the window

Parameters

event?

Event

Returns

void

Inherited from

WindowProps.toggleMinimized

Built by Prozilla