OverlayOptions

Electron APIs / Overlay / OverlayOptions

Configuration options for creating or modifying an overlay window.

Control over:

• User input.
• Window stacking.
• Keyboard event handling.

Example

const options: OverlayOptions = {
  passthrough: "mouseOnly",
  zOrder: "alwaysOnTop",
  ignoreKeyboardInput: true,
};

Extended by

• OverlayWindowOptions

Properties

Property	Type	Description
ignoreKeyboardInput?	boolean	true—the overlay won't intercept keyboard input. Default false
passthrough?	PassthroughType	Controls how input events are handled by the overlay window. Default 'noPassThrough' See PassthroughType.
zOrder?	ZOrderType	Controls the Z-order (stacking order) of the overlay window relative to other window. Default 'default' See ZOrderType.