windows10-fluently-vibrancy

    0.9.2 • Public • Published

    windows10-fluently-vibrancy

    This module is intended to give an Electron BrowserWindow blur on its behind on Windows. Electron does not support 'blur behind' from a transparent window on Windows and this module uses native API calls to achieve the effect.

    Running

    Since this is a native addon, you will need your platforms build tools. Visual Studio, etc. Also Python for node-gyp.

    git clone https://github.com/sebascontre/windows10-fluently-vibrancy
    cd windows10-fluently-vibrancy
    npm install
    cd spec/app # Go to sample app
    electron . # electron --version should be 1.6.8
    

    To rebuild again:

    npm run conf
    npm run rebuild
    

    Also available through NPM.

    npm install windows10-fluently-vibrancy
    

    To run tests see scripts/ci

    Current Supported Platforms

    • Windows 10 (stable) It just works ™

    Things to note

    • BrowserWindow must be transparent. (transparent:true)
    • Requires Windows 10 or higher.
    • If you get A dynamic link library (DLL) initialization routine failed. error, it means that the module isn't compiled against Electron or compiled against the wrong version.

    Although it works, I dont recommend using this module on a machine below Windows 10. See platforms section below for more information for macOS.

    API

    There are several methods depending on what you want to do and what platform you are on.

    enableVibrancy(window) win

    Returns Bool.

    • window BrowserWindow instance

    Enables or disables vibrancy for the WHOLE window.

    disableVibrancy(window) win

    Disables Vibrancy completely.

    • window BrowserWindow instance

    How to use

    // mainWindow with show: false
    mainWindow.on('ready-to-show',function() {
      var electronVibrancy = require('..');
    
      electronVibrancy.enableVibrancy(mainWindow);
    
      electronVibrancy.disableVibrancy(mainWindow);
    
      mainWindow.show();
    });
    
    

    Platform notices

    Windows

    On Windows 10 the addon uses SetWindowCompositionAttribute, which is an undocumented API, which means it can be changed by Microsoft any time and break the functionality.

    License

    This project is under MIT. See LICENSE

    Install

    npm i windows10-fluently-vibrancy

    DownloadsWeekly Downloads

    1

    Version

    0.9.2

    License

    MIT

    Unpacked Size

    248 kB

    Total Files

    21

    Last publish

    Collaborators

    • sebascontre