BaseWindowProps

Defined in: shared/types.ts:334

Base window props (shared between Window and PooledWindow)

Extended by

WindowProps

Properties

alwaysOnTop?

optional alwaysOnTop: boolean | AlwaysOnTopLevel

Defined in: shared/types.ts:484

Whether the window should always be on top.

backgroundColor?

optional backgroundColor: string

Defined in: shared/types.ts:454

Background color

center?

optional center: boolean

Defined in: shared/types.ts:422

Center the window on creation. Default: true if no x/y specified.

closable?

optional closable: boolean

Defined in: shared/types.ts:362

Whether the user can close the window. Default: true. When false, the close button is hidden/disabled.

defaultHeight?

optional defaultHeight: number

Defined in: shared/types.ts:370

Initial height. Only applied on window creation.

defaultWidth?

optional defaultWidth: number

Defined in: shared/types.ts:367

Initial width. Only applied on window creation.

defaultX?

optional defaultX: number

Defined in: shared/types.ts:373

Initial x position. Only applied on window creation.

defaultY?

optional defaultY: number

Defined in: shared/types.ts:376

Initial y position. Only applied on window creation.

focusable?

optional focusable: boolean

Defined in: shared/types.ts:481

Whether the window is focusable. Default: true.

frame?

optional frame: boolean

Defined in: shared/types.ts:439

Show window frame (title bar, borders). Creation-only.

Creation Only

Cannot be changed after window creation.

fullscreen?

optional fullscreen: boolean

Defined in: shared/types.ts:495

Enter/exit fullscreen mode

fullscreenable?

optional fullscreenable: boolean

Defined in: shared/types.ts:498

Whether the window can enter fullscreen. Default: true.

height?

optional height: number

Defined in: shared/types.ts:390

Controlled height. Changes will resize the window. Use with onBoundsChange for two-way sync.

ignoreMouseEvents?

optional ignoreMouseEvents: boolean

Defined in: shared/types.ts:506

Ignore mouse events (click-through window)

injectStyles?

optional injectStyles: InjectStylesMode

Defined in: shared/types.ts:554

How to inject styles into the new window.

“auto”: Copy
false: No injection (for CSS-in-JS)
function: Custom injection (replaces the auto mirroring entirely)

maxHeight?

optional maxHeight: number

Defined in: shared/types.ts:419

Maximum height constraint

maximizable?

optional maximizable: boolean

Defined in: shared/types.ts:478

Whether the window can be maximized. Default: true.

maxWidth?

optional maxWidth: number

Defined in: shared/types.ts:413

Maximum width constraint

minHeight?

optional minHeight: number

Defined in: shared/types.ts:416

Minimum height constraint

minimizable?

optional minimizable: boolean

Defined in: shared/types.ts:475

Whether the window can be minimized. Default: true.

minWidth?

optional minWidth: number

Defined in: shared/types.ts:410

Minimum width constraint

movable?

optional movable: boolean

Defined in: shared/types.ts:472

Whether the window is movable. Default: true.

name?

optional name: string

Defined in: shared/types.ts:536

Debug name for DevTools and error messages. Useful for identifying windows in multi-window apps.

onBlur()?

optional onBlur: () => void

Defined in: shared/types.ts:577

Fired when the window loses focus

Returns

void

onBoundsChange()?

optional onBoundsChange: (bounds) => void

Defined in: shared/types.ts:405

Callback fired when window bounds change (resize or move). Debounced internally.

Parameters

bounds

Bounds

Returns

void

onClose()?

optional onClose: () => void

Defined in: shared/types.ts:580

Fired when the window is destroyed (for any reason — user close, programmatic, unmount)

Returns

void

onDisplayChange()?

optional onDisplayChange: (display) => void

Defined in: shared/types.ts:589

Fired when window moves to a different display

Parameters

display

DisplayInfo

Returns

void

onEnterFullscreen()?

optional onEnterFullscreen: () => void

Defined in: shared/types.ts:583

Fired when window enters fullscreen

Returns

void

onExitFullscreen()?

optional onExitFullscreen: () => void

Defined in: shared/types.ts:586

Fired when window exits fullscreen (maps to Electron’s ‘leave-full-screen’ event)

Returns

void

onFocus()?

optional onFocus: () => void

Defined in: shared/types.ts:574

Fired when the window gains focus

Returns

void

onMaximize()?

optional onMaximize: () => void

Defined in: shared/types.ts:562

Fired when window is maximized

Returns

void

onMinimize()?

optional onMinimize: () => void

Defined in: shared/types.ts:568

Fired when window is minimized

Returns

void

onReady()?

optional onReady: () => void

Defined in: shared/types.ts:559

Fired when window is ready and content is mounted

Returns

void

onRestore()?

optional onRestore: () => void

Defined in: shared/types.ts:571

Fired when window is restored from minimized

Returns

void

onUnmaximize()?

optional onUnmaximize: () => void

Defined in: shared/types.ts:565

Fired when window is unmaximized

Returns

void

onUserClose()?

optional onUserClose: () => void

Defined in: shared/types.ts:356

Called when the user initiates a close (e.g., clicks the X button).

Fires during Electron’s close event — the window is about to close but hasn’t yet. Use this to sync your open state back to false. The window will close on its own; your open={false} is for your state consistency, not to drive the close.

This is a notification, not an interceptor. To prevent close, set closable={false} proactively (e.g., closable={!hasUnsavedChanges}).

onClose (a separate callback) fires after the window is fully destroyed, for any reason (user, programmatic, unmount).

Returns

void

opacity?

optional opacity: number

Defined in: shared/types.ts:457

Window opacity (0.0 to 1.0)

open

open: boolean

Defined in: shared/types.ts:340

Whether the window should be open/visible. When true, the window is created/shown. When false, the window is destroyed.

persistBounds?

optional persistBounds: string

Defined in: shared/types.ts:544

Persist window bounds with this key. Bounds are saved on resize/move and restored on next open.

recreateOnShapeChange?

optional recreateOnShapeChange: boolean

Defined in: shared/types.ts:530

Recreate window when creation-only props change. Default: false (log warning instead).

resizable?

optional resizable: boolean

Defined in: shared/types.ts:469

Whether the window is resizable. Default: true.

showInactive?

optional showInactive: boolean

Defined in: shared/types.ts:503

Show window without stealing focus

skipTaskbar?

optional skipTaskbar: boolean

Defined in: shared/types.ts:490

Whether to skip showing in taskbar/dock.

targetDisplay?

optional targetDisplay: TargetDisplay

Defined in: shared/types.ts:522

Which display to open the window on

title?

optional title: string

Defined in: shared/types.ts:427

Window title

titleBarOverlay?

optional titleBarOverlay: TitleBarOverlayOptions

Defined in: shared/types.ts:517

Title bar overlay options (Windows)

titleBarStyle?

optional titleBarStyle: TitleBarStyle

Defined in: shared/types.ts:445

Title bar style. Creation-only.

Creation Only

Cannot be changed after window creation.

trafficLightPosition?

optional trafficLightPosition: object

Defined in: shared/types.ts:514

Traffic light (close/minimize/maximize) button position (macOS)

x

x: number

y

y: number

transparent?

optional transparent: boolean

Defined in: shared/types.ts:433

Make the window transparent. Creation-only.

Creation Only

Cannot be changed after window creation.

vibrancy?

optional vibrancy: VibrancyType

Defined in: shared/types.ts:451

Vibrancy effect (macOS only). Creation-only.

Creation Only

Cannot be changed after window creation.

visible?

optional visible: boolean

Defined in: shared/types.ts:466

Whether the window is visible. Default: true. Set to false to hide the window without destroying it (state is preserved). Unlike open, which controls the window’s existence, visible controls whether it’s shown.

visibleOnAllWorkspaces?

optional visibleOnAllWorkspaces: boolean

Defined in: shared/types.ts:509

Visible on all workspaces/virtual desktops

width?

optional width: number

Defined in: shared/types.ts:384

Controlled width. Changes will resize the window. Use with onBoundsChange for two-way sync.

x?

optional x: number

Defined in: shared/types.ts:396

Controlled x position. Changes will move the window. Use with onBoundsChange for two-way sync.

y?

optional y: number

Defined in: shared/types.ts:402

Controlled y position. Changes will move the window. Use with onBoundsChange for two-way sync.