OverlayOptions

Electron APIs / overlay / OverlayOptions

Overlay configuration options for creating or modifying an overlay window.

Control over:

• Input passthrough behavior.
• Overlay window stacking behavior.
• Keyboard input interception.

Example

const options: OverlayOptions = {
  passthrough: "noPassThrough",
  zOrder: "default",
  ignoreKeyboardInput: false,
};

Extended by

• OverlayWindowOptions

Properties

Property	Type	Description
ignoreKeyboardInput?	boolean	Controls whether the overlay intercepts keyboard input. true—the overlay won't intercept keyboard input. Default false
passthrough?	PassthroughType	Controls how input is handled by the overlay window. Default 'noPassThrough' See PassthroughType.
strictToGameWindow?	boolean	When true, the overlay window is strictly confined to the game window boundaries. This prevents the overlay from being moved outside the game window area. Default false Since 1.9.0
zOrder?	ZOrderType	Controls the z-order (stacking order) of the overlay window. Default 'default' See ZOrderType.