electron-viewport

electron-viewport helps emulate and scale viewports. Viewport can emulate a device viewport, such as emulating a phone device or 4k display, and can scale a window (maintaining aspect ratio) to fit on screen.

Installation

npm install --save electron-viewport

Instance Properties

`viewport.width`

Width of the viewport to be represented

`viewport.height`

Height of the viewport to be represented

`viewport.emulate`

Boolean indicating whether or not to emulate the given viewport size or simply scale to fit on current display.

`viewport.opts`

Options passed to BrowserWindow on creation

Instance Methods

`viewport.getWindow(width, height[, emulate][, options])`

width Integer - The width of the viewport to be represented
height Integer - The height of the viewport to be represented
emulate Boolean (optional) - Whether or not to use device emulation, simulating the actual viewport size given. If false, then the viewport it simply scaled while maintaining aspect ratio. Default is false
options Object (optional) - Options to be passed to the BrowserWindow on creation

Creates and returns a BrowserWindow, enabling emulation on it if necessary.

Examples

Getting scaled width and height

var { width, height } = require('electron-viewport')(width, height)

Simply returns scaled dimensions so you may create your own window.

Creating a scaled window

var viewport = require('electron-viewport')(width, height)
var mainWindow = viewport.getWindow()

Creates a scaled BrowserWindow which fits on screen, with the width and height specified.

Scaled window with device emulation

var viewport = require('electron-viewport')(deviceWidth, deviceHeight, true)
var mainWindow = viewport.getWindow()

Creates a scaled BrowserWindow which fits on screen, with device emulation enabled for the passed width and height.

Scaled window with options passed to BrowserWindow

var options = { frame: false } //specify your BrowserWindow options here, just an example
var viewport = require('electron-viewport')(width, height, options)
var mainWindow = viewport.getWindow()

Creates a scaled BrowserWindow which fits on screen, with the given BrowserWindow options being passed

Scaled window with options and device emulation

var options = { frame: false } //specify your BrowserWindow options here, just an example
var viewport = require('electron-viewport')(width, height, true, options)
var mainWindow = viewport.getWindow()

alienhoboken / electron-viewport Goto Github PK