Window configuration

WindowOptions properties

The defaults below come from the admin console’s built-in defaultOptions. Properties without a “Default” have no fixed value before merge; the final result depends on what you pass or leave undefined.

Property	Type	Required	Default	Description
width	number	See notes	800	In TypeScript, cloudWindowConfig marks width/height as required; at runtime only name/url are validated. If omitted, they merge with defaults to 800 × 600.
height	number	See notes	600	Same as above.
belowGroup	string | null	No	''	Parent window name for subordinate windows; sub-windows follow parent modal/close behavior. Passing null explicitly in createSubWin skips subordinate handling (see cloudWindow).
group	string	No	—	Peer resource group key for maxCount, sendEventToGroup, groupOpened/groupClosed, etc.
maxCount	number	No	—	Max windows in the same group; when exceeded, the oldest is replaced via active instead of creating a new one.
groupCount	number	No	0	Used by internal sub-window counting; usually omit.
index	number	No	1	Stacking index (used for top-most, getMaxTop, etc.).
relativeApp	boolean	No	—	Relative-to-app flag (extension hook for business logic).
callback	Function	No	—	Window-open callback if your app defines one.
anim	boolean	No	true	Transitions for minimize/restore/maximize/size changes.
shadow	boolean | string	No	true	true for default shadow; or a custom CSS shadow string.
hideTitle	boolean	No	false	Hide the title area.
skipTaskbar	boolean	No	false	If true, excluded from taskbar aggregation (barUpdate).
data	any	No	—	Data passed when opening/activating; desktop active may also deliver data.
x	number	No	—	Initial x; combined with center, group offsets, etc. (see calcPosition, negative values supported).
y	number	No	—	Initial y.
minWidth	number	No	0	Minimum width; 0 often means no limit.
minHeight	number	No	0	Minimum height.
maxWidth	number	No	—	Maximum width; also used when maximizing.
maxHeight	number	No	—	Maximum height.
headConfig	HeadConfig	No	{ height: 40 }	Title bar height and Mac/Win control strip placement.
sandbox	boolean | string[]	No	false	iframe sandbox.
allow	boolean | string[]	No	true	iframe allow.
title	string	No	'cloudWindow'	Window title.
titleBarStyle	string	No	—	Title bar style when supported (e.g. hiddenInset).
icon	LazyIcon	No	''	Icon URL string or object with src/loading/error.
showIcon	boolean	No	true	Whether to show the icon.
frame	boolean	No	true	Use built-in title chrome; set false when using registerHeader.
modal	boolean	No	false	Modal: blocks other areas; without belowGroup uses global veil, with parent uses parent chain.
parent	any	No	false	Parent reference/marker (any in source).
minimizable	boolean	No	true	Allow minimize.
maximizable	boolean	No	true	Allow maximize.
resizable	boolean	No	true	Allow resize by drag.
alwaysOnTop	boolean	No	false	Always on top.
color	string	No	—	Primary color for title and buttons.
blurColor	string	No	—	Color when unfocused.
background	string	No	'#fff'	Window background.
transparent	boolean	No	false	Transparent background.
help	string	No	undefined	Help URL; undefined hides help entry.
controlArea	boolean	No	true	Top draggable strip; if false, implement drag yourself (e.g. registerHeader).
center	boolean	No	true	Center on first layout (still stacks with anti-overlap logic).
closable	boolean	No	true	Allow close.
hideOnClose	boolean	No	—	Fake close (hide/keep alive); if cacheTime > 0, forced to true.
movable	boolean	No	true	Allow dragging the window.
fullscreenable	boolean	No	true	Allow fullscreen (shell-dependent).
cacheTime	number	No	0	Cache seconds; if >0, close does not destroy iframe until timeout, and forces hideOnClose.
radius	number	No	12	Corner radius in px.
show	boolean	No	true	Visible after create; if false, show later via cloudWindowMgr.show() or activation.

Types

LazyIcon

type LazyIcon =
  | string
  | {
      src: string
      loading?: string
      error?: string
    }

HeadConfig

Title layout when using the built-in frame chrome.

interface HeadConfig {
  height: number    // Header height, default 40
  macX?: number     // Mac traffic-light region x
  macY?: number     // Mac traffic-light region y
  winY?: number     // Windows control region y (no separate x)
}