https://github.com/ragingwind/electron-togglify-window
Set toggle function to Browser Window
https://github.com/ragingwind/electron-togglify-window
Last synced: about 1 month ago
JSON representation
Set toggle function to Browser Window
- Host: GitHub
- URL: https://github.com/ragingwind/electron-togglify-window
- Owner: ragingwind
- License: mit
- Created: 2015-10-28T22:01:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-01T11:37:08.000Z (over 10 years ago)
- Last Synced: 2025-01-13T00:32:21.829Z (over 1 year ago)
- Language: JavaScript
- Size: 137 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# electron-togglify-window
> Add toggle feature to window. You can make a toggle-able window
## Install
```
$ npm install --save electron-togglify-window
```
## Usage
```js
const BrowserWindow = require('browser-window');
const togglify = require('electron-togglify-window');
win = togglify(new BrowserWindow({
side: 'left',
'always-on-top': false,
width: 600
}, {
animation: 'hide'
});
```
## API
### togglify(winInstance, options)
#### winInstance
Instance of the target window should be passed created just to toggle.
#### options
Type: `object`
- `animation`: the way of toggle animation when its will be `hide` or `scale`.
## Run demo
```
$ npm start
```
## License
MIT © [Jimmy Moon](http://ragingwind.md)