Package-level declarations

Types

Link copied to clipboard
sealed external interface BackgroundThrottlingPolicy

Background throttling policy

Link copied to clipboard
external class CloseRequestedEvent
Link copied to clipboard
typealias Color = Any

An RGBA color. Each value has minimum of 0 and maximum of 255.

Link copied to clipboard
sealed external interface CursorIcon
Link copied to clipboard
sealed external interface Effect

Platform-specific window effects

Link copied to clipboard
external interface Effects

The window effects configuration object

Link copied to clipboard
sealed external interface EffectState

Window effect state macOS only

Link copied to clipboard
external interface Monitor

Allows you to retrieve information about a given monitor.

Link copied to clipboard
external interface MonitorWorkArea
Link copied to clipboard
external interface PreventOverflowMargin

Minimum margin to work area

Link copied to clipboard
external interface ProgressBarState
Link copied to clipboard
sealed external interface ProgressBarStatus
Link copied to clipboard
sealed external interface ResizeDirection
Link copied to clipboard
external interface ScaleFactorChanged

The payload for the scaleChange event.

Link copied to clipboard
sealed external interface ScrollBarStyle

The scrollbar style to use in the webview.

Link copied to clipboard
sealed external interface Theme
Link copied to clipboard
sealed external interface TitleBarStyle
Link copied to clipboard
sealed external interface UserAttentionType

Attention type to request on a window.

Link copied to clipboard
open external class Window

Create new window or get a handle to an existing one.

Link copied to clipboard
typealias WindowLabel = String
Link copied to clipboard
external interface WindowOptions

Configuration for the window to create.

Link copied to clipboard
external interface WindowSizeConstraints

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns the list of all the monitors available on the system.

Link copied to clipboard
external fun currentMonitor(): Promise<Monitor?>

Returns the monitor on which the window currently resides. Returns null if current monitor can't be detected.

Link copied to clipboard

Get the cursor position relative to the top-left hand corner of the desktop.

Link copied to clipboard

Gets a list of instances of Window for all available windows.

Link copied to clipboard
external fun getCurrentWindow(): Window

Get an instance of Window for the current window.

Link copied to clipboard
external fun monitorFromPoint(x: Double, y: Double): Promise<Monitor?>

Returns the monitor that contains the given point. Returns null if can't find any.

Link copied to clipboard
external fun primaryMonitor(): Promise<Monitor?>

Returns the primary monitor of the system. Returns null if it can't identify any monitor as a primary one.