1.1.0 • Published 6 years ago

@electron-helpers/window-manager v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

Electron Window Manager Build Status

Easily manage electron windows.

Install

npm install --save @electron-helpers/window-manager

Usage

Create a new window

const { createWindow } = require('@electron-helpers/window-manager');
const settingsWindow = createWindow('settings', 'https://localhost:3000/settings', { width: 420, height: 540 }, { x: 'center', y: 100 });

Get a window by name

const { getWindow } = require('@electron-helpers/window-manager');
const settingsWindow = getWindow('settings');

Set default window options

const { setDefaultOptions } = require('@electron-helpers/window-manager');
setDefaultOptions({ backgroundColor: '#fff' });

Get default window options

const { getDefaultOptions } = require('@electron-helpers/window-manager');
const defaultOptions = getDefaultOptions();

Set base URL

const { setBaseURL, createWindow } = require('@electron-helpers/window-manager');
setBaseURL('https://localhost:3000/');
...
const settingsWindow = createWindow('settings', 'settings', { width: 420, height: 540 }, { x: 'center', y: 100 });

Docs

createWindow(name, url, options, position, showGracefully)

Creates a new BrowserWindow.

  • name - String - the name of the window
  • url - String - the url to open in the window
  • position - Object - the position of the window. e.g. { x: 'left', y: 'center', xOffset: 10, yOffset: -10} will position the window to 10 pixel from the left (horizontally) and -10 pixels from the center of the screen (vertically)
  • showGracefully - Boolean - whether to show the windown only when ready.

getWindow(name)

Returns a window by it's name.

  • name - String

setDefaultOptions(options)

Sets the default options.

  • options - Object

getDefaultOptions(options)

Returns default options.

  • options - Object

License

MIT