electron-window-state 技术文档

【免费下载链接】electron-window-state A library to store and restore window sizes and positions for your Electron app 项目地址: https://gitcode.com/gh_mirrors/el/electron-window-state

electron-window-state 是一个专为 Electron 应用程序设计的库，用于保存和恢复窗口大小与位置。该库简单易用，灵感来自于 electron-boilerplate 项目的实现方式。以下是如何安装和高效使用此库的完整指南。

安装指南

确保您的开发环境中已安装 Node.js。然后，在命令行中执行以下命令来添加 electron-window-state 到您的项目依赖：

npm install --save electron-window-state

这将下载库并将其添加到您的 package.json 文件的依赖列表中。

项目使用说明

在您的 Electron 应用启动流程中，利用 electron-window-state 来管理窗口状态。以下是一个典型的应用示例：

const { app, BrowserWindow } = require('electron');
const windowStateKeeper = require('electron-window-state');

app.on('ready', function () {
  // 初始化窗口状态，设置默认尺寸
  let mainWindowState = windowStateKeeper({
    defaultWidth: 1000,
    defaultHeight: 800
  });
  
  // 根据保存的状态创建窗口
  let win = new BrowserWindow({
    x: mainWindowState.x,
    y: mainWindowState.y,
    width: mainWindowState.width,
    height: mainWindowState.height
  });

  // 管理窗口以自动保存状态变化
  mainWindowState.manage(win);
});

项目API使用文档

windowStateKeeper(opts)

• 参数:
  • defaultWidth: (Number) 窗口宽度默认值，默认为 800。
  • defaultHeight: (Number) 窗口高度默认值，默认为 600。
  • path: (String) 状态文件保存路径，默认为 app.getPath('userData')。
  • file: (String) 状态文件名，默认为 window-state.json。适合多窗口应用。
  • maximize: (Boolean) 若窗口上次是最大化关闭，则自动最大化， 默认为 true。
  • fullScreen: (Boolean) 若窗口上次是全屏关闭，则自动恢复全屏， 默认为 true。

状态对象属性

• x, y: 分别表示窗口的位置坐标。
• width, height: 表示窗口的大小。
• isMaximized: (Boolean) 窗口是否被最大化。
• isFullScreen: (Boolean) 窗口是否处于全屏模式。
• manage(window): 注册监听器，自动处理窗口大小和位置变化，并能恢复窗口的最大化或全屏状态。
• unmanage(): 移除之前注册的所有监听器，当不再需要管理窗口时调用。
• saveState(window): 手动保存当前窗口状态，一般不常用，因为 manage() 已包含自动保存功能。

项目安装方式

上面的“安装指南”部分已经详细介绍了如何安装 electron-window-state。简而言之，通过运行 npm install --save electron-window-state 命令即可完成库的安装。

以上内容构成了一篇简单的技术文档，旨在帮助您了解和使用 electron-window-state 库。遵循这些步骤，您可以轻松地为用户提供持久化的窗口体验。

【免费下载链接】electron-window-state A library to store and restore window sizes and positions for your Electron app 项目地址: https://gitcode.com/gh_mirrors/el/electron-window-state