https://github.com/ragingwind/electron-pane-window
Create a pane style window, no frame, no titlebar, stick the window on the sides of screen
https://github.com/ragingwind/electron-pane-window
Last synced: 10 months ago
JSON representation
Create a pane style window, no frame, no titlebar, stick the window on the sides of screen
- Host: GitHub
- URL: https://github.com/ragingwind/electron-pane-window
- Owner: ragingwind
- License: mit
- Created: 2015-10-27T16:02:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-27T16:10:17.000Z (over 10 years ago)
- Last Synced: 2025-04-20T07:19:32.145Z (about 1 year ago)
- Language: JavaScript
- Size: 125 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# electron-pane-window
> Create a pane style window, no frame, no titlebar, stick the window on the sides of screen
## Install
```
$ npm install --save electron-pane-window
```
## Usage
```js
const PaneBrowserwindow = require('electron-pane-window');
win = new PaneBrowserWindow({
side: 'left',
'always-on-top': false,
width: 600
});
```
## API
### PaneBrowserwindow(options)
#### options
Type: `object`
Almost same with [options of Browser Window of Electron](https://github.com/atom/electron/blob/master/docs/api/browser-window.md#new-browserwindowoptions). Here is additional options for this:
- `side`: which side of screen to stick to. `top`, `left`, `right` and `bottom`
### setPositionTo(side)
Set position of window to on side of screen
- `side`: which side of screen to stick to. `top`, `left`, `right` and `bottom`
## Run demo
```
$ npm start
```
## License
MIT © [ragingwind](http://ragingwind.md)