windows10-fluently-color v1.0.3

windows10-fluently-color

Reads the accent color, theme, and transparency settings from Windows 10 registry.

Created for usage in Electron apps.

Usage

const winColor = require('windows10-fluently-color')

console.log(winColor.titlebarColor)

// could be #4ca0fe. or anything else.
//           ^ this is at least not a completely arbitrary color since it's
//             the default blue window chrome color that ships with Windows 8

Works with...

Windows 10.

API

It's pretty simple. Grab the module and then go for it:

const winColor = require('windows10-fluently-color')

Stuff you can access on the winColor object:

winColor.titlebarColor

Returns the color of the your Windows machines' title bar as a hex string.

winColor.inactiveTitlebarColor

Returns the color of the title bar on an inactive window.

winColor.useLightTheme

Returns true if the user is using the ligth theme.

winColor.useTransparency

Returns true if the user is using the transparency settings.

winColor.isSupported

Returns a boolean indicating if the running OS is generally supported to read colors from. Does not check for other limitations like those stated above.

winColor.reload()

Freshly loads the colors from the Registry. This is also done on initiation so typically you won't ever need to call this.

winColor.raw

Returns a hash containing the registry values from the HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\DWM key entries, converted to either boolean or hex color strings. For example my personal Windows 10 hash looks like this:

{
  Composition: true,
  ColorizationGlassAttribute: false,
  EnableAeroPeek: true,
  ColorPrevalence: true,
  AccentColor: '#484a4c',
  ColorizationColor: '#4c4a48',
  ColorizationColorBalance: '#000059',
  ColorizationAfterglow: '#4c4a48',
  ColorizationAfterglowBalance: '#00000a',
  ColorizationBlurBalance: true,
  EnableWindowColorization: true,
  AppsUseLightTheme: true,
  EnableTransparency: true
}