OverlayWindowOptions
Electron APIs / overlay / OverlayWindowOptions
Configuration options for an overlay window.
Used at creation time to define the overlay window's behavior and appearance. Extends:
- Standard Electron
BrowserWindowConstructorOptions. - Overlay specific behaviors using
OverlayOptions.
Extends
BrowserWindowConstructorOptions.OverlayOptions
Properties
| Property | Type | Description |
|---|---|---|
dpiAware? | boolean | true—the overlay window will be DPI aware (Main monitor DPI). This allows the overlay to scale correctly on high DPI displays. Default false Since 1.7.0 |
enableHWAcceleration? | boolean | This option is not currently supported and has no effect. It is reserved for future use. |
enableIsolation? | boolean | Enables Chromium process isolation (sandboxing). Used to enforce stricter security policies or prevent resource sharing between renderer processes. |
ignoreKeyboardInput? | boolean | Controls whether the overlay intercepts keyboard input. true—the overlay won't intercept keyboard input. Default false |
name | string | Unique name (id) for the window. |
passthrough? | PassthroughType | Controls how input is handled by the overlay window. Default 'noPassThrough' See PassthroughType. |
zOrder? | ZOrderType | Controls the z-order (stacking order) of the overlay window. Default 'default' See ZOrderType. |