https://github.com/wotermelon/electron-window-welt-sliding

An electron window welt sliding plugin.
https://github.com/wotermelon/electron-window-welt-sliding

browserwindow electron javascript sliding-windows

Last synced: about 1 month ago
JSON representation

An electron window welt sliding plugin.

• Host: GitHub
• URL: https://github.com/wotermelon/electron-window-welt-sliding
• Owner: wotermelon
• Created: 2018-04-27T01:29:26.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-04-28T02:38:00.000Z (over 6 years ago)
• Last Synced: 2024-11-17T17:38:26.648Z (about 2 months ago)
• Topics: browserwindow, electron, javascript, sliding-windows
• Language: JavaScript
• Homepage:
• Size: 5.95 MB
• Stars: 7
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# electron-window-welt-sliding

An electron window welt sliding plugin.

![screenshot](./screenshot.gif)

## Installation

### npm

```BASH

npm install electron-window-welt-sliding --save

```

### yarn

```bash

yarn add electron-window-welt-sliding

```

## Usage

```javascript

const weltSliding = require('electron-window-welt-sliding')

// win is your BrowserWindow instance.

// It return this so you can chain calls.

weltSliding(win).setSpeed(500).destroy()

```

### methods:

| methodName | params | return | default |Descrition |

| ---- | ---- | ---- | ---- | ---- |

| `setWindow` | `BrowserWindow` | `this` |  | set the window which to welt sliding. |

| `setSpeed` | `Number` | `this` | 500 | set the animate duration. |

| `setHideTimeout` | `Number` | `this` | 300 | set delay before sliding hidden. |

| `disableSlide` | | `this` | | disable welt sliding. |

| `enableSlide` | | `this` | | enable welt sliding. |

| `destroy` | | | | destroy welt sliding. |