Skip to content

窗口配置说明

WindowOptions 属性

下列 默认值 来自管理端内建的 defaultOptions;未列「默认值」的项表示合并前无固定默认,完全由你传入或保持未定义(合并后才有结果)。

属性名类型必填默认值说明
widthnumber见说明800未传宽高时与默认合并为 800 × 600
heightnumber见说明600同上
belowGroupstring | null''从属父窗口的 name;子窗口随父窗口模态/关闭策略联动。createSubWin 中显式传 null 表示不按从属子窗处理(详见 cloudWindow
groupstring平级资源组 key,用于 maxCountsendEventToGroupgroupOpened/groupClosed
maxCountnumbergroup 下最大窗口数;超出时对组内最早窗口做 active 替换而非新建
indexnumber1窗口层级索引(置顶、getMaxTop 等会用到)
animbooleantrue最小化/还原/最大化/尺寸变化等过渡动画
shadowboolean | stringtruetrue 默认阴影;也可传自定义阴影 CSS 字符串
hideTitlebooleanfalse隐藏标题区域
skipTaskbarbooleanfalsetrue 时不参与任务栏聚合(barUpdate
dataany打开/激活时下发给子窗口的数据;桌面 active 时也会触发
xnumber初始 x;与 center、同组偏移等共同决定最终位置(支持负数等规则见 calcPosition
ynumber初始 y
minWidthnumber0最小宽度,0 常表示不限制
minHeightnumber0最小高度
maxWidthnumber最大宽度;最大化时也会参考
maxHeightnumber最大高度
headConfigHeadConfig{ height: 40 }标题栏区域高度与 Mac/Win 控制条位置
sandboxboolean | string[]falseiframe sandbox
allowboolean | string[]trueiframe allow
titlestring'cloudWindow'窗口标题
iconLazyIcon''图标;字符串 URL 或带 src/loading/error 的对象
showIconbooleantrue是否显示图标
framebooleantrue是否使用内置标题栏框架;自定义 registerHeader 时会关掉 frame
modalbooleanfalse模态:阻塞其它区域;无 belowGroup 时挂全局遮罩,有则从属父窗口遮罩链
minimizablebooleantrue是否可最小化
maximizablebooleantrue是否可最大化
resizablebooleantrue是否可拖拽改尺寸
alwaysOnTopbooleanfalse是否置顶
colorstring标题与按钮等主色
blurColorstring失焦态颜色
backgroundstring'#fff'窗口背景色
transparentbooleanfalse是否透明背景
helpstringundefined帮助链接;undefined 可不展示帮助入口
controlAreabooleantrue顶部可拖拽条;false 时需自行实现拖拽(如 registerHeader
centerbooleantrue初次布局是否按可用区域居中(仍会与防重叠逻辑叠加)
closablebooleantrue是否可关闭
hideOnCloseboolean | numberfalse假关闭(隐藏/保活);true 表示一直缓存,number 表示隐藏后按秒数自动回收 白名单配置
movablebooleantrue是否允许拖动窗口
radiusnumber12圆角像素
showbooleantrue创建后是否可见;false 时需再通过 cloudWindowMgr.show() / 配置激活等显示

类型定义

LazyIcon

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

HeadConfig

窗口头部布局(与内置 frame 标题栏配合)。

ts
interface HeadConfig {
  height: number    // 头部高度,默认 40
  macX?: number     // Mac 操作区域(红绿灯)的 x
  macY?: number     // Mac 操作区域(红绿灯)的 y
  winY?: number     // Windows 操作区域的 y(不支持单独配置 x)
}

补充说明

  • 创建窗口时还需额外传 nameurl,它们不属于这里列出的 WindowOptions 字段。
  • hideOnClose 支持三种语义:false 为真实关闭、true 为隐藏保活、number 为隐藏后按秒数自动回收。
  • 运行时 show: false 只对 hideOnClose 窗口真正生效;普通窗口的隐藏更新会被宿主忽略。
  • parentNode 只决定宿主挂载位置,不会进入窗口侧运行时配置;createSubWin() 会主动忽略它。
  • 文中涉及的 safeArea 指宿主全局配置 cloudWindowMgr.safeArea,不是单窗口字段。