Interface UIOverlayOptions

Detached overlay or utility window options.

interface UIOverlayOptions {
    mode?: "hud" | "window";
    title?: string;
    chrome?: "none" | "system" | "custom";
    draggable?: boolean;
    dragModifier?: string;
    resizable?: boolean;
    minWidth?: number;
    minHeight?: number;
    maxWidth?: number;
    maxHeight?: number;
    alwaysOnTop?: boolean;
    skipTaskbar?: boolean;
    clickThrough?: boolean;
    focusable?: boolean;
    noActivate?: boolean;
    opacity?: number;
    contentProtected?: boolean;
    transparent?: boolean;
    width?: number;
    height?: number;
    x?: number;
    y?: number;
    anchor?: string;
    offsetX?: number;
    offsetY?: number;
    targetWindowId?: string;
    style?: Record<string, unknown>;
}

Properties

mode? title? chrome? draggable? dragModifier? resizable? minWidth? minHeight? maxWidth? maxHeight? alwaysOnTop? skipTaskbar? clickThrough? focusable? noActivate? opacity? contentProtected? transparent? width? height? x? y? anchor? offsetX? offsetY? targetWindowId? style?

Properties

Optionalmode

mode?: "hud" | "window"

hud creates a transparent, display-only overlay by default; window creates a focusable utility window.

Optionaltitle

title?: string

Window title.

Optionalchrome

chrome?: "none" | "system" | "custom"

Window chrome style.

Optionaldraggable

draggable?: boolean

Whether the overlay can be dragged.

OptionaldragModifier

dragModifier?: string

Optional modifier key required before dragging starts.

Optionalresizable

resizable?: boolean

Whether the overlay can be resized.

OptionalminWidth

minWidth?: number

Minimum window width in logical pixels.

OptionalminHeight

minHeight?: number

Minimum window height in logical pixels.

OptionalmaxWidth

maxWidth?: number

Maximum window width in logical pixels.

OptionalmaxHeight

maxHeight?: number

Maximum window height in logical pixels.

OptionalalwaysOnTop

alwaysOnTop?: boolean

Whether the overlay stays above other windows.

OptionalskipTaskbar

skipTaskbar?: boolean

Whether the overlay should be hidden from the taskbar.

OptionalclickThrough

clickThrough?: boolean

Whether mouse input passes through the overlay.

Optionalfocusable

focusable?: boolean

Whether the overlay can receive keyboard focus.

OptionalnoActivate

noActivate?: boolean

Whether showing the overlay avoids taking focus.

Optionalopacity

opacity?: number

Opacity from 0 to 1.

OptionalcontentProtected

contentProtected?: boolean

Whether the overlay content should be hidden from screen capture when the platform supports it.

Optionaltransparent

transparent?: boolean

Whether the webview background is transparent.

Optionalwidth

width?: number

Window width in logical pixels.

Optionalheight

height?: number

Window height in logical pixels.

Optionalx

x?: number

Window x position in logical pixels.

Optionaly

y?: number

Window y position in logical pixels.

Optionalanchor

anchor?: string

Anchor used when following a target window.

OptionaloffsetX

offsetX?: number

X offset from the resolved anchor.

OptionaloffsetY

offsetY?: number

Y offset from the resolved anchor.

OptionaltargetWindowId

targetWindowId?: string

Optional WindowInfo.id to follow while the target exists.

Optionalstyle

style?: Record<string, unknown>

CSS-like renderer style metadata.

Settings

Member Visibility

On This Page

Properties