windows10-electron-vibrancy v1.0.1

Windows 10 Electron Vibrancy

This module is intended to give an Electron BrowserWindow blur on its behind. Electron does not support 'blur behind' from a transparent window and this module uses native API calls to achieve the effect. Forked from electron-vibrancy. The intenstion of this forked project is to be more stable and only for windows 10

Image from electron-vibrancy

API

setVibrancy(window, material)

return - view id

window - the electron browser window

material - the vibrancy material used
	0 - AppearanceBased
	1 - Ligh
	2 - Dark
	3 - Titlebar
	4 - Selection
	5 - Menu
	6 - Popover
	7 - Sidebar
	8 - MediumLight
	9 - UltraDark

disableVibrancy(window)

return - void

window - the electron browser window

addView(window, options)

return - view id

window - the electron browser window

options - view options
	material - the vibrancy material used
		0 - AppearanceBased
		1 - Ligh
		2 - Dark
		3 - Titlebar
		4 - Selection
		5 - Menu
		6 - Popover
		7 - Sidebar
		8 - MediumLight
		9 - UltraDark
	x - x position of the visual effect relative to window
	y - y position of the visual effect relative to window
	width - height of the visual effect relative to window
	height - width of the visual effect relative to window
	resizeMask - resize mask for the visual effect
		0 - auto width resize
		1 - auto height resize
		2 - auto width-height resize
		3 - no resize

updateView(window, options)

return - unknown

window - the electron browser window

options - view options
	viewId - view id
	material - the vibrancy material used
		0 - AppearanceBased
		1 - Ligh
		2 - Dark
		3 - Titlebar
		4 - Selection
		5 - Menu
		6 - Popover
		7 - Sidebar
		8 - MediumLight
		9 - UltraDark
	x - x position of the visual effect relative to window
	y - y position of the visual effect relative to window
	width - height of the visual effect relative to window
	height - width of the visual effect relative to window

removeView(window, viewId)

return - unknown

window - the electron browser window

viewId - view id

License

This project is under the MIT license. See LICENSE.