Miss any of our Open RFC calls?Watch the recordings here! »

electron-positioner

4.1.0 • Public • Published

Electron-positioner Build Status js-standard-style

Helps positioning your electron windows.

Install

npm install --save electron-positioner

Usage

var Positioner = require('electron-positioner')
var positioner = new Positioner(browserWindow)
 
// Moves the window top right on the screen.
positioner.move('topRight')
 
// Returns `{x,y}`
positioner.calculate('trayCenter', trayBounds)

Note, trayBounds is only required with the positions that starts with tray.

Docs

new Positioner (browserWindow)

Constructor

BrowserWindow

The BrowserWindow instance.

calculate (position, trayBounds)

Returns coordinates {x,y}.

move (position, trayBounds)

Moves the window with BrowserWindow.setPosition()

position

A string telling where to place the window. Allowed values:

  • trayLeft
  • trayBottomLeft
  • trayRight
  • trayBottomRight
  • trayCenter
  • trayBottomCenter
  • topLeft
  • topRight
  • bottomLeft
  • bottomRight
  • topCenter
  • bottomCenter
  • leftCenter
  • rightCenter
  • center
trayBounds

Tray bounds, only needed for the following positions:

  • trayLeft
  • trayBottomLeft
  • trayRight
  • trayBottomRight
  • trayCenter
  • trayBottomCenter

Tests

npm test

License

MIT

Keywords

none

Install

npm i electron-positioner

DownloadsWeekly Downloads

1,613

Version

4.1.0

License

MIT

Unpacked Size

6.04 kB

Total Files

4

Last publish

Collaborators

  • avatar