https://github.com/zardoy/electron-window-keeper
Great alternative to electron-window-state
https://github.com/zardoy/electron-window-keeper
Last synced: about 1 year ago
JSON representation
Great alternative to electron-window-state
- Host: GitHub
- URL: https://github.com/zardoy/electron-window-keeper
- Owner: zardoy
- License: mit
- Created: 2021-06-12T19:28:42.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T17:34:16.000Z (about 2 years ago)
- Last Synced: 2025-02-13T03:41:22.533Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://npmjs.com/electron-window-keeper
- Size: 54.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Electron Window Keeper
> One day, this module will be the easiest way to manage complicated window state persistence.
It should be a maintained alternative to electron-window-state.
Available to use in main process only.
[API](https://paka.dev/npm/electron-window-keeper)
## Usage
The usage as simple as it should be:
```ts
import ElectronWindowKeeper from "electron-window-keeper";
import { app, BrowserWindow } from "electron";
app.on("ready", () => {
const windowState = new ElectronWindowKeeper();
const window = new BrowserWindow({
width: 1280,
height: 720,
// always position defaults (x, y, width, height, fullscreen) above
...windowState.restoredState
});
windowState.manage(window);
});
```
If you don't understand `...` (spread syntax) you can read [javascript.info guide](https://javascript.info/rest-parameters-spread).
To disable tracking of maximized state pass `trackMaximized: false`.
To disable tracking of fullscreen state just pass `fullscreen: false` right after *restoredState*:
```ts
new BrowserWindow({
// default props
...windowState.restoredState,
fullscreen: false // always override restored fullscreen value
});
```
Also note, that as stated in [BrowserWindow docs](https://www.electronjs.org/docs/api/browser-window#using-ready-to-show-event), setting minimum or maximum window size doesn't prevent setting it from restored state.
## TODO
- [ ] tests. again, I'm too lazy to setup it now
- [ ] describe behavior when multiple app instances are launched (last resized window would override the state)
## Notes
[Electron memento](https://npmjs.com/electron-memento) was really close to finalize the idea, but this module is meant to be more modern and comprehensive.
Also note, that to bring the window to top without gaining the focus you can specify `alwaysOnTop: true` when creating new `BrowserWindow` and on just created window call `browserWindow.setAlwaysOnTop(false)`. But never use it on production! It would be annoying to the user.