evwt/docs/EvWindow.md

Electron Vue Window Toolkit

# EvWindow
A smarter BrowserWindow that automatically remembers its size and position.

## Usage

?> 🧠 The default background.js is already set up with EvWindow out of the box.

## Create Window

```js
import { EvWindow } from 'evwt/background';

// Electron BrowserWindow options
// https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions
let options = {
  width: 800,
  height: 600,
  webPreferences: {
    nodeIntegration: true
  }
};

let restoreId = 'main'; // or a file path, database ID, etc in multiwindow apps
let evWindow = new EvWindow(restoreId, options);
let win = evWindow.browserWindow; // access the browserWindow for the full Electron API
```

A window created in this way will have its size and position remembered across restarts.

> Window state is saved based on the restoreId to evwt-ui-state.json in the [userData](https://www.electronjs.org/docs/api/app#appgetpathname) directory

## Window Management

EvWindow can arrange windows on the screen in various ways. See reference below for all options.

```js
import { EvWindow } from 'evwt/background';

EvWindow.arrange('tile'); // tile, cascade, rows or columns
```



## Reference
### Background

<a name="module_EvWindow"></a>

#### EvWindow

* [EvWindow](#module_EvWindow)
    * _instance_
        * [.addEnvironmentClasses()](#module_EvWindow+addEnvironmentClasses)
    * _static_
        * [.fromBrowserWindow(win)](#module_EvWindow.fromBrowserWindow) ⇒
        * [.arrange(arrangement)](#module_EvWindow.arrange)

<a name="module_EvWindow+addEnvironmentClasses"></a>

##### evWindow.addEnvironmentClasses()
Add CSS classes to body based on environment

**Kind**: instance method of [<code>EvWindow</code>](#module_EvWindow)  
<a name="module_EvWindow.fromBrowserWindow"></a>

##### EvWindow.fromBrowserWindow(win) ⇒
Return the EvWindow associated with the passed BrowserWindow

**Kind**: static method of [<code>EvWindow</code>](#module_EvWindow)  
**Returns**: EvWindow  

| Param | Type |
| --- | --- |
| win | <code>BrowserWindow</code> | 

<a name="module_EvWindow.arrange"></a>

##### EvWindow.arrange(arrangement)
Arranges windows on the screen.

**Kind**: static method of [<code>EvWindow</code>](#module_EvWindow)  

| Param | Type | Description |
| --- | --- | --- |
| arrangement | <code>String</code> | `tile`, `cascade`, `rows` or `columns` |